Profilarr 项目教程

Profilarr 项目教程

Profilarr Import, Export & Sync Profiles & Custom Formats via Radarr / Sonarr API. 项目地址: https://gitcode.com/gh_mirrors/pr/Profilarr

1. 项目的目录结构及介绍

Profilarr 项目的目录结构如下：

Profilarr/
├── deletarr.py
├── docker-compose.yml
├── exportarr.py
├── helpers/
│   └── ...
├── importarr.py
├── requirements.txt
├── setup.py
├── syncarr.py
├── config.yml
├── README.md
└── LICENSE

目录结构介绍

• deletarr.py: 用于删除 Radarr/Sonarr 中的自定义格式和质量配置文件。
• docker-compose.yml: Docker 配置文件，用于容器化部署。
• exportarr.py: 用于导出 Radarr/Sonarr 中的自定义格式和质量配置文件。
• helpers/: 包含辅助功能的 Python 模块。
• importarr.py: 用于导入自定义格式和质量配置文件到 Radarr/Sonarr。
• requirements.txt: 项目依赖的 Python 包列表。
• setup.py: 项目初始化脚本，用于生成配置文件。
• syncarr.py: 用于同步主实例和从实例之间的自定义格式和质量配置文件。
• config.yml: 项目的配置文件，包含 Radarr/Sonarr 的 URL、API 密钥等信息。
• README.md: 项目说明文档。
• LICENSE: 项目许可证文件。

2. 项目的启动文件介绍

setup.py

setup.py 是项目的初始化脚本，用于生成配置文件 config.yml。在首次使用 Profilarr 时，需要运行此脚本来配置项目。

importarr.py

importarr.py 用于导入自定义格式和质量配置文件到 Radarr/Sonarr。运行此脚本时，系统会提示用户选择要导入的配置文件和目标实例。

exportarr.py

exportarr.py 用于导出 Radarr/Sonarr 中的自定义格式和质量配置文件。运行此脚本时，系统会提示用户选择要导出的配置文件和目标路径。

syncarr.py

syncarr.py 用于同步主实例和从实例之间的自定义格式和质量配置文件。运行此脚本时，系统会自动导出主实例的配置文件并导入到所有从实例中。

deletarr.py

deletarr.py 用于删除 Radarr/Sonarr 中的自定义格式和质量配置文件。运行此脚本时，系统会提示用户选择要删除的配置文件和目标实例。

3. 项目的配置文件介绍

config.yml

config.yml 是 Profilarr 项目的配置文件，包含以下主要配置项：

• radarr: Radarr 实例的配置信息，包括 URL 和 API 密钥。
• sonarr: Sonarr 实例的配置信息，包括 URL 和 API 密钥。
• sync: 同步配置，用于指定主实例和从实例的 URL 和 API 密钥。
• export_path: 导出文件的存储路径。
• import_path: 导入文件的存储路径。
• ansi_colors: 控制终端输出是否使用 ANSI 颜色代码。

配置文件示例

radarr:
  url: "http://localhost:7878"
  api_key: "your_api_key_here"

sonarr:
  url: "http://localhost:8989"
  api_key: "your_api_key_here"

sync:
  master:
    url: "http://localhost:7878"
    api_key: "your_api_key_here"
  slaves:
    - url: "http://localhost:7879"
      api_key: "your_api_key_here"

export_path: "/exports"
import_path: "/imports"

ansi_colors: true

通过以上配置，用户可以灵活地管理 Radarr 和 Sonarr 实例的导入、导出和同步操作。

Profilarr Import, Export & Sync Profiles & Custom Formats via Radarr / Sonarr API. 项目地址: https://gitcode.com/gh_mirrors/pr/Profilarr