跳转到主要内容

为Sonarr的副标题下载网络服务

项目描述

多普勒副标题下载器

Build Status Docker Automated buil Pypi package PyPI Coverage Status Discord Feature Requests MIT licensed

为Sonarr或Radarr提供的副标题下载网络服务。它使用Subliminal在下载通知时自动搜索缺失的副标题。

限制

  • 仅支持Sonarr下载通知

  • 视频文件名不应被重命名(这有助于找到正确的副标题)

  • 所有系列应位于同一根目录下

  • 系列文件夹应命名为系列名称(1900)

支持和功能请求

请勿为功能请求打开问题,请在FeatHub上投票

如需支持,请使用我们的Discord

用法

最佳用法是通过Docker镜像。

使用Docker安装

使用我的Docker镜像

docker create \
    --name dopplerr \
    -p 8086:8086 \
    -e PUID=<UID> \
    -e PGID=<GID> \
    -e TZ=<timezone> \
    -v /etc/localtime:/etc/localtime:ro \
    -v <path/to/animes>:/animes \
    -v <path/to/movies>:/movies \
    -v <path/to/series>:/tv \
    -e DOPPLERR_SUBLIMINAL_LANGUAGES="fra,eng" \
    -e DOPPLERR_MAPPING="tv=tv,movies=movies,animes=animes" \
    stibbons31/dopplerr

将您的媒体目录挂载到/。通常,/animes/tv来自Sonarr,/movies来自Radarr。

将Sonarr和Radarr运行在它们自己的容器中是一个好习惯,这样它们也能“看到”路径如/tv/movies/animes中的媒体。在多普勒容器中挂载具有相同名称的这些卷。

DOPPLERR_MAPPING 用于列出媒体基本目录(默认为 /,如果未设置 DOPPLERR_GENERAL_BASEDIR)中的所有有趣文件夹,因此即使所有目录映射都很简单:请定义它,例如 tv=tv,movies=movies,animes=animes

DOPPLERR_MAPPING 允许开发者在他们的PC上直接运行 dopplerr,并允许不同的命名约定(例如,/path/to/Movies 是电影存储的地方,但在所有容器(Radarr,Dopplerr)中它们都被挂载为 /movies)。

参数

参数分为两部分,由冒号分隔,左侧代表主机,右侧代表容器。例如使用端口 -p external:internal - 这显示的是容器内部到外部的端口映射。所以,-p 8080:80 将容器内部的80端口暴露给主机IP上的8080端口(例如:http://192.168.x.x:8080)。

启动命令行参数示例

  • -p 8086:8086 - 网页界面的端口

  • -v /path/to/anime:/anime - 磁盘上动画库的位置

  • -v /path/to/movies:/movies - 磁盘上电影库的位置

  • -v /path/to/series:/tv - 磁盘上电视库的位置

  • -e PGID=1000 - 对于组ID。请见下文解释

  • -e PUID=100 - 对于用户ID。请见下文解释

  • -v /etc/localtime - 对于时区信息 - 请参阅本地时间获取重要信息

  • -e TZ- 对于时区信息,欧洲/伦敦 - 请参阅本地时间获取重要信息

  • -e DOPPLERR_SUBLIMINAL_LANGUAGES=fra,eng - 设置所需的字幕语言(必需)

  • -e DOPPLERR_GENERAL_VERBOSE=1 - 设置详细程度。1=详细,0=静默(可选)

开发者可能还会使用

  • -e DOPPLERR_GENERAL_BASEDIR=/media - 设置媒体基本目录(可选)(需要类似 -v /path/to/anime:/media/anime 等等)

本地时间

您必须设置 -v /etc/localtime:/etc/localtime:ro 或 TZ 变量以启用计划任务。

示例

-e TZ=Europe/Paris

用户/组标识符

有时在使用数据卷(-v 标志)时,主机操作系统和容器之间可能会出现权限问题。我们通过允许您指定用户 PUID 和组 PGID 来避免这个问题。确保主机上的数据卷目录属于您指定的同一用户,它就会“正常工作”(TM)。

在这个例子中 PUID=1001 和 PGID=1001。要找到您的标识符,请使用以下命令

$ id <dockeruser>
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

所需的字幕语言

使用以逗号分隔的3字母语言描述符列表,您希望 Subliminal 尝试下载它们。

示例

DOPPLERR_SUBLIMINAL_LANGUAGES=fra,eng

描述符是语言的 ISO-639-3 名称。请参阅官方 Babelfish 表以查找您偏好的语言。

Pipy 安装

创建一个专用的虚拟环境,并使用以下命令正确安装

$ pip3 install dopplerr

注意:永远不应该使用 sudo pip3 install ... 在系统中直接安装 Python 应用程序。您不希望破坏启动脚本或其他任何由您发行版的维护者精心打包的 Python 应用程序。

始终使用Virtualenv。要在全局范围内安装应用程序,请使用您发行版的包管理器(例如 apt / yum / ...)。

如果没有这个选项,请使用 pip3 install --user 安装全局Python包。

其他说明:虽然使用 pip/pip3 从Pypi上的预构建包(“发行版包”)安装是官方方法,但请注意本项目在开发过程中使用 pipenv,并使用 Pipfile 作为依赖定义的主要来源。当更改时,会自动生成 requirements.txt 文件,因此即使不是官方安装方法,通过 pip3 从GitHub源安装也应能正常工作。

pip3 install --user git+http://github.com/Stibbons/dopplerr#egg=dopplerr

请注意,此命令获取的是最新代码,可能会出现损坏。

Radarr/Sonarr 配置

进入设置以配置“连接”WebHook

  • 设置 > 连接 > 添加 WebHook 通知

  • 选择 下载时升级时

  • URL: http://<ip address>:8086/api/v1/notify/sonarr

    URL: http://<ip address>:8086/api/v1/notify/radarr

  • 方法:POST

两个README?

关于README有一些小技巧要了解

  • Docker Hub无法正确渲染restructuredText编写的README

  • Pypi无法正确渲染Markdown编写的README

因此,从上传到Pypi的 README.md 创建了一个restructuredText版本的README。很简单。所以,当更新 README.md 时,不要忘记使用 make readme 重新生成 README.rst

贡献

查看源代码

git clone

使用(或相应地调整)安装系统级依赖项

$ sudo ./bootstrap-system.sh

系统依赖项

  • git

  • make

  • pandoc

  • pip

  • pipenv

本项目使用 pipenv 来无缝跳入虚拟环境。

使用以下命令设置开发环境

$ make dev

使用以下命令进行单元测试

$ make test-unit

或使用以下命令运行实时版本

$ make run-local

激活环境(例如,从编辑器启动)

$ make shell

发布新版本

请注意,许多部分是自动化的,例如,发布到Pypi是由Travis在成功的标签构建时自动完成的)

使用以下命令测试构建Wheel包

$ make release wheels

创建一个发布:使用Semver语法创建一个标签。

$ # ensure everything is committed
$ git tag 1.2.3
$ make release
$ git push --tags

可选地,您可以本地标记代码并将其推送到GitHub。 make release 也会在Travis构建期间执行,所以如果在构建过程中有任何文件更改(例如,README.rst),它将被自动完成,因此Pypi包将是协调的。如果GitHub上的README已更新,则无需重新标记,它已在Pypi的Wheel/Source Packages中正确完成。所以,不要担心。

在标签上的Travis构建成功后,您的Pypi包将自动更新。

同样,在标签上,也会自动创建一个Docker标签。

注意

根据PBR,alpha版本应标记为 x.y.z.a1

项目详细信息


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于安装包的信息。

源分发

dopplerr-0.6.4.tar.gz (70.6 kB 查看哈希值)

上传时间:

构建分发

dopplerr-0.6.4-py2.py3-none-any.whl (61.3 kB 查看哈希值)

上传时间: Python 2 Python 3

支持