Metadata-Version: 2.4
Name: rss-downloader
Version: 0.3.0
Summary: A Simple RSS Download Manager
Keywords: rss,downloader,aria2,qbittorrent,automation,anime
Author: GrassSand
Author-email: GrassSand <grasssand@users.noreply.github.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet
Classifier: Topic :: Utilities
Requires-Dist: aiosqlite>=0.21.0
Requires-Dist: anyio>=4.10.0
Requires-Dist: fastapi[standard]>=0.116.1
Requires-Dist: feedparser>=6.0.11
Requires-Dist: httpx>=0.28.1
Requires-Dist: loguru>=0.7.3
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pyyaml>=6.0.2
Requires-Python: >=3.10
Project-URL: Bug Tracker, https://github.com/grasssand/rss-downloader/issues
Project-URL: Homepage, https://github.com/grasssand/rss-downloader
Project-URL: Repository, https://github.com/grasssand/rss-downloader
Description-Content-Type: text/markdown

## RSS Downloader
---

一个 RSS 订阅下载工具，配合 Aria2 / qBittorrent / Transmission 自动追番。


### 1. 安装 🚀

需要 Python 环境。
```bash
# pipx
pipx install rss-downloader
# or uv
uv tool install rss-downloader
# or pip (不推荐)
pip install --user rss-downloader
```

更新
```bash
# pipx
pipx upgrade rss-downloader
# uv
uv tool upgrade rss-downloader
# pip
pip install --user --upgrade rss-downloader
```

### 2. 配置 ⚙️

首次运行时，程序会自动在标准配置目录下创建一个 `config.yaml` 文件（一般在 `~/.config/rss-downloader/`）。您也可以手动创建它。

```yaml
# config.yaml
log:
  level: INFO # 日志级别 (DEBUG, INFO, WARNING, ERROR)

web:
  enabled: true # 是否启用 Web 界面
  host: 127.0.0.1
  port: 8000
  interval_hours: 6 # RSS 自动更新间隔（小时）

# Aria2 配置 (如果不用可以留空或删除)
aria2:
  rpc: http://localhost:6800/jsonrpc
  secret: your_secret
  dir: null # aira2 下载位置

# qBittorrent 配置 (如果不用可以留空或删除)
qbittorrent:
  host: http://localhost:8080
  username: admin
  password: password

# Transmission 配置 (如果不用可以留空或删除)
transmission:
  host: http://localhost:9091/
  username: admin
  password: password

# Webhook 配置 (如果不用可以留空或删除)
webhooks:
  - name: Discord
    url: https://discord.com/api/webhooks/xxx
    enabled: true

# RSS 源配置列表
feeds:
  - name: Mikan
    url: https://mikanime.tv/RSS/MyBangumi?token=
    include:    # 匹配规则
      - chs
      - 简体
    exclude:     # 排除规则
      - 720p
      - \d{2,}\s*[-|~]\s*\d{2,}
    downloader: aria2 # or qbittorrent / transmission

  - name: Nyaa
    url: https://nyaa.si/?page=rss&q=
```


### 3. 运行 🎉

配置 `web.enabled` 为 `true`，或者指定运行参数 `-w`，启动 Web 界面和后台服务，浏览器访问 `http://127.0.0.1:8000`。

```bash
> rss-downloader
options:
  -h, --help  显示帮助信息
  -w, --web   启动 Web 界面
```

![下载记录](./assets/下载记录.png)
![配置管理](./assets/配置管理.png)
