SABnzbd 项目技术文档

1. 安装指南

1.1 依赖项

在安装 SABnzbd 之前，您需要确保系统中已安装以下依赖项：

• Python：需要 Python 3.8 及以上版本（通常称为 python3）。
• Python 模块：安装 requirements.txt 中列出的 Python 模块，使用命令 python3 -m pip install -r requirements.txt -U。
• par2：多线程 par2 安装指南可以在 这里 找到。
• unrar：确保安装的是官方的非免费版本的 unrar。

1.2 从源码运行 SABnzbd

在安装完所有依赖项后，您可以通过以下命令从源码运行 SABnzbd：

python3 -OO SABnzbd.py

如果您希望在后台运行 SABnzbd，可以使用以下命令：

python3 -OO SABnzbd.py -d -f /path/to/sabnzbd.ini

如果需要多语言支持，请运行：

python3 tools/make_mo.py

更多命令行选项可以在 这里 找到。

2. 项目的使用说明

2.1 基本使用

SABnzbd 是一个自动化 Usenet 下载工具，用户只需添加一个 .nzb 文件，SABnzbd 将自动完成下载、验证、修复、解压和归档等操作，无需人工干预。

2.2 设置向导

SABnzbd 提供了一个简单的设置向导，帮助用户快速配置基本设置。用户可以通过 Web 界面访问设置向导，并根据提示完成配置。

2.3 自我分析工具

SABnzbd 还提供了自我分析工具，用于验证用户的设置是否正确。用户可以通过这些工具检查系统的配置，确保 SABnzbd 能够正常运行。

3. 项目API使用文档

3.1 API 概述

SABnzbd 提供了丰富的 API，允许用户通过编程方式与 SABnzbd 进行交互。API 可以用于添加下载任务、查询下载状态、管理下载队列等操作。

3.2 API 使用示例

以下是一个简单的 API 使用示例，用于添加一个下载任务：

import requests

url = "http://localhost:8080/api"
params = {
    "mode": "addurl",
    "name": "http://example.com/path/to/file.nzb",
    "apikey": "your_api_key"
}

response = requests.get(url, params=params)
print(response.text)

3.3 API 参考

更多 API 的使用方法和参数说明，请参考 API 参考文档。

4. 项目安装方式

4.1 从源码安装

从源码安装 SABnzbd 的步骤如下：

1. 克隆项目仓库：

   git clone https://github.com/sabnzbd/sabnzbd.git
   

2. 进入项目目录：

   cd sabnzbd
   

3. 安装依赖项：

   python3 -m pip install -r requirements.txt -U
   

4. 运行 SABnzbd：

   python3 -OO SABnzbd.py
   

4.2 从包管理器安装

SABnzbd 也可以通过包管理器安装，具体步骤请参考 安装指南。

---

通过以上文档，您应该能够顺利安装、使用和了解 SABnzbd 项目。如有任何问题，请参考项目的官方文档或加入 Discord 社区获取帮助。