Documentation
¶
Overview ¶
Copyright © 2024 sunerpy <nkuzhangshn@gmail.com> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Directories
¶
| Path | Synopsis |
|---|---|
|
apitoken
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP 与 qB 兼容入口用,网页登录仍然只认 session。
|
Package apitoken 管理 API 令牌(路线图 M12):给 App、MCP 与 qB 兼容入口用,网页登录仍然只认 session。 |
|
cloakdriver
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation.
|
Package cloakdriver provides Go bindings for CloakBrowser-Manager REST API and CDP automation. |
|
cloakdriver/gazelle
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13).
|
Package gazelle implements the Gazelle-schema CloakBrowser driver (T13). |
|
cloakdriver/mtorrent
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver.
|
Package mtorrent implements the mTorrent (M-Team) CloakBrowser driver. |
|
cloakdriver/nexusphp
Package nexusphp implements the NexusPHP-schema CloakBrowser driver.
|
Package nexusphp implements the NexusPHP-schema CloakBrowser driver. |
|
cloakdriver/transport
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。
|
Package transport 把 CloakBrowser 的各架构驱动接成登录探测的后备通道(sitelogin.Transport)。 |
|
cloakdriver/unit3d
Package unit3d implements the Unit3D-schema CloakBrowser driver.
|
Package unit3d implements the Unit3D-schema CloakBrowser driver. |
|
cookiecloud
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。
|
Package cookiecloud 从自建的 CookieCloud 服务取回加密的 Cookie,在本地解密,按站点地址挑出 pt-tools 已配置站点的 Cookie。 |
|
dlassistant
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。
|
Package dlassistant 是下载器助手:给缺站点标签的种子补标签、批量替换 tracker 地址、找出 tracker 报告 未注册或不存在的失效种子。 |
|
extension
Package extension implements the pending-actions queue for browser extension polling.
|
Package extension implements the pending-actions queue for browser extension polling. |
|
filter
Package filter provides pattern matching and filtering functionality for RSS items.
|
Package filter provides pattern matching and filtering functionality for RSS items. |
|
iyuu
Package iyuu 是 IYUU 辅种接口的客户端。
|
Package iyuu 是 IYUU 辅种接口的客户端。 |
|
maintenance
MIT License Copyright (c) 2025 pt-tools
|
MIT License Copyright (c) 2025 pt-tools |
|
mcp
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。
|
Package mcp 是 pt-tools 的 MCP(Model Context Protocol)服务(路线图 M14):工具定义、权限检查与写操作的审计。 |
|
media/meta
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。
|
Package meta 解析 PT 种子的标题与副标题:中英文名、年份、类型、季与集(含范围、「全 N 集」「第 1-10 集」)、 分辨率、来源、编码、HDR、音轨、制作组、版本,以及中字、国语、粤语等标记。 |
|
media/organize
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。
|
Package organize 是整理入库服务:种子下载完成后识别出电影或剧集,按媒体库的模板与整理方式放进库里, 写 NFO 与图片,通知媒体服务器扫描,发入库通知。 |
|
media/recognize
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。
|
Package recognize 是媒体识别服务:套用识别词、解析标题,再到 TMDB 找对应的条目 (有 IMDb 编号时直接查找,否则按中英文名和年份搜索打分),支持按 TMDB 编号手动纠正。 |
|
media/scrape
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、季海报与集截图。
|
Package scrape 为整理进媒体库的电影与剧集写 Kodi 格式的 NFO(Emby、Jellyfin、Plex 的 NFO 插件都认), 并下载海报、背景、季海报与集截图。 |
|
media/server
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。
|
Package server 是媒体服务器的客户端:Emby、Jellyfin 与 Plex。 |
|
media/subscribe
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。
|
Package subscribe 是订阅:按电影或剧集的一季找资源(RSS 拉到的种子与定时主动搜索),按质量档案挑、推送到下载器, 剧集按 TMDB 的分集找缺的集;洗版时接着找更好的版本,入库后替换旧文件;豆瓣想看定时建订阅。 |
|
media/tmdb
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。
|
Package tmdb 是 TMDB v3 接口的客户端:搜索电影与剧集、按 IMDb 编号查找、取详情。 |
|
media/transfer
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。
|
Package transfer 是整理入库的文件操作:从种子的文件里挑出要整理的视频与字幕、按模板算出库里的路径, 再用硬链接、复制、软链接或移动放进媒体库。 |
|
media/words
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。
|
Package words 套用识别词:解析标题之前屏蔽或替换文字,解析之后按规则偏移集数。 |
|
notify/adapter/bark
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。
|
Package bark 是 Bark(iOS 推送)出站通道:POST {server}/push,JSON 里带 device_key;返回 code 为 200 才算成功。 |
|
notify/adapter/dingtalk
Package dingtalk 是钉钉群自定义机器人出站通道。
|
Package dingtalk 是钉钉群自定义机器人出站通道。 |
|
notify/adapter/feishu
Package feishu 是飞书(Lark)群自定义机器人出站通道。
|
Package feishu 是飞书(Lark)群自定义机器人出站通道。 |
|
notify/adapter/ntfy
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。
|
Package ntfy 是 ntfy 出站通道:按 JSON 发布,POST 到服务器根地址 {topic, title, message, priority, click}; 可选 access token(Bearer)或用户名密码(Basic)。 |
|
notify/adapter/outbound
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。
|
Package outbound 是只出站的通知适配器(Bark、Server 酱、ntfy、钉钉、飞书、企业微信群机器人)共用的发送工具。 |
|
notify/adapter/serverchan
Package serverchan 是 Server 酱出站通道。
|
Package serverchan 是 Server 酱出站通道。 |
|
notify/adapter/telegram
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling.
|
Package telegram implements the notify.Channel adapter for Telegram bots using mymmrac/telego with long-polling. |
|
remote
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。
|
Package remote 是远程访问(路线图 M15)的协议与主机端:手机 App 扫码配对以后,经直连 WebSocket 或 relay 调用这台 pt-tools 的 App API v1。 |
|
reseed
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。
|
Package reseed 实现 IYUU 辅种:把下载器里已经下完的种子的 info hash 交给 IYUU 查询,找出其他站点上数据相同的种子, 从站点下载种子文件、核对 info hash 与文件列表后,暂停加入同一台下载器(保存路径用原种子的),校验到 100% 才开始做种。 |
|
transfer
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。
|
Package transfer 实现转移做种:把下载器里已经下完的种子搬到另一个下载器继续做种,数据不动。 |
|
site
|
|
|
v2
Package v2 provides caching utilities for performance optimization
|
Package v2 provides caching utilities for performance optimization |
|
thirdpart
|
|
|
httpclient
Package httpclient 提供基于 github.com/sunerpy/requests 的 HTTP 客户端连接池管理
|
Package httpclient 提供基于 github.com/sunerpy/requests 的 HTTP 客户端连接池管理 |
|
Package web provides HTTP server and API handlers
|
Package web provides HTTP server and API handlers |
|
middleware
Package middleware 放请求主体(路线图 M12):谁发起的请求、有哪些权限范围。
|
Package middleware 放请求主体(路线图 M12):谁发起的请求、有哪些权限范围。 |
|
qbitcompat
Package qbitcompat 是 qB 兼容入口(路线图 M13):在单独的端口上实现 qBittorrent WebUI API v2 的一个子集, 让 MoviePilot、IYUU、autobrr、Sonarr/Radarr 这类只认 qB 的工具把 pt-tools 当成下载器。
|
Package qbitcompat 是 qB 兼容入口(路线图 M13):在单独的端口上实现 qBittorrent WebUI API v2 的一个子集, 让 MoviePilot、IYUU、autobrr、Sonarr/Radarr 这类只认 qB 的工具把 pt-tools 当成下载器。 |