Excludarr 开源项目使用教程-CSDN博客

Excludarr 开源项目使用教程

excludarr Excludarr manages your libraries in Radarr/Sonarr. It keeps track of your library and checks if your movies and series are also available on a configured streaming provider. It can exclude the movies and series that are available on a configured streaming provider. But it can also re-add movies and series if they are not streaming anymore. 项目地址: https://gitcode.com/gh_mirrors/ex/excludarr

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

Excludarr 是一个用于管理 Radarr 和 Sonarr 库的命令行工具，它可以帮助用户自动排除在配置的流媒体提供商上可用的电影和电视剧。以下是 Excludarr 项目的目录结构：

excludarr/
├── .examples/                  # 示例配置文件目录
├── .github/                    # GitHub 工作流和其他 GitHub 相关文件
├── .vscode/                    # Visual Studio Code 项目配置
├── excludarr/                  # 主应用程序代码目录
├── .gitignore                  # Git 忽略文件
├── mdlrc                        # Markdown 文件配置
├── pre-commit-config.yaml       # pre-commit 配置文件
├── CHANGELOG.md                # 更新日志
├── Dockerfile                  # Docker 容器配置文件
├── LICENSE                      # 项目许可证
├── MANIFEST.in                  # 打包配置文件
├── README.md                    # 项目说明文件
├── docker-compose.yml           # Docker Compose 配置文件
├── entrypoint.sh                # 容器启动脚本
├── requirements-dev.txt         # 开发依赖
├── requirements.txt             # 项目依赖
├── setup.cfg                    # Python 打包配置
└── setup.py                     # Python 打包脚本

.examples/：包含示例配置文件，用于参考和快速开始。
.github/：包含 GitHub 工作流文件，如自动化测试和部署脚本。
.vscode/：包含 Visual Studio Code 的项目配置文件。
excludarr/：包含主应用程序的代码，包括模块和脚本。
.gitignore：定义哪些文件和目录应该被 Git 忽略。
mdlrc：Markdown 文件配置。
pre-commit-config.yaml：pre-commit 的配置文件，用于自动化代码格式化和检查。
CHANGELOG.md：项目的更新日志，记录了每个版本的更改和更新。
Dockerfile：用于构建 Docker 容器的配置文件。
LICENSE：项目的 MIT 许可证。
MANIFEST.in：用于定义打包时包含的文件。
README.md：项目说明文件，介绍了项目的基本信息和如何使用。
docker-compose.yml：用于定义和运行多容器 Docker 应用程序的配置文件。
entrypoint.sh：容器启动脚本，用于初始化容器环境。
requirements-dev.txt：开发环境所需的依赖。
requirements.txt：项目运行所需的依赖。
setup.cfg 和 setup.py：用于 Python 包的打包和分发。

2. 项目的启动文件介绍

Excludarr 的启动主要是通过命令行进行的。安装 Excludarr 后，您可以使用以下命令来启动不同的功能：

# 查看所有可用命令
excludarr --help

# 查看特定子命令的帮助信息
excludarr <subcommand> --help

例如，如果您想管理 Radarr 的库，可以使用 excludarr radarr 命令，并跟随相应的子命令和参数。

3. 项目的配置文件介绍

Excludarr 的配置文件用于定义项目的运行参数和设置。配置文件可以放在以下位置：

/etc/excludarr/excludarr.yml
~/.config/excludarr/excludarr.yml
~/.excludarr/config/excludarr.yml
~/.excludarr.yml
./.excludarr.yml

配置文件的读取顺序是从上到下，后面的配置会覆盖前面的配置。

以下是配置文件的一个基本示例：

# Excludarr 配置文件示例

# Radarr 配置
radarr:
  # Radarr 实例的 URL
  url: http://localhost:7878
  # API 密钥
  api_key: your_api_key
  # 是否自动删除已排除的电影
  delete_excluded: false

# Sonarr 配置
sonarr:
  # Sonarr 实例的 URL
  url: http://localhost:8081
  # API 密钥
  api_key: your_api_key
  # 是否自动删除已排除的电视剧
  delete_excluded: false

# 流媒体提供商配置
providers:
  - name: Netflix
  - name: Apple iTunes

您需要根据实际情况修改 url 和 api_key 的值，以及添加您所在国家/地区的流媒体提供商。

配置文件的具体格式和选项可以在项目提供的 excludarr-example.yml 文件中查看。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考