rogsme/subscleaner

Subscleaner

![PyPI version]([] ![codecov]([]

Subscleaner 是一个用于从字幕文件中移除广告的 Python 脚本。它旨在帮助您在观看喜爱的节目和电影时，不受字幕中烦人的广告干扰。

核心功能和特性

• 从字幕文件中移除预定义的广告模式列表
• 通过 pysrt 库支持多种字幕格式
• 使用 chardet 自动检测字幕文件的编码
• 提供 Docker 镜像，便于部署和使用

安装

自动安装

使用 pip 安装：

sh
sudo pip install subscleaner

手动安装

安装 Subscleaner 需要 Python 3.9 或更高版本。建议使用 Poetry 管理项目依赖。

1. 克隆仓库：

sh
git clone https://gitlab.com/rogs/subscleaner.git

2. 进入项目目录：

sh
cd subscleaner

3. 使用 Poetry 安装依赖：

sh
poetry install

Docker 安装

Subscleaner 也提供 Docker 镜像，可从 Docker Hub 拉取：

sh
docker pull rogsme/subscleaner

使用方法和配置说明

常规使用

如果是自动安装，可将字幕文件列表通过管道输入脚本：

sh
find /你的媒体目录 -name "*.srt" | subscleaner

如果是手动安装：

sh
find /你的媒体目录 -name "*.srt" | poetry run subscleaner

或者，如果已全局安装依赖，可直接运行脚本：

sh
find /你的媒体目录 -name "*.srt" | python3 subscleaner.py

Docker 使用

运行 Docker 容器的命令如下：

sh
docker run -e CRON="0 0 * * *" -v /你的媒体目录:/files rogsme/subscleaner

• 将 0 0 * * * 替换为您希望运行脚本的 cron 调度时间
• 将 /你的媒体目录 替换为包含字幕文件的媒体目录路径

Docker 容器将根据指定的 cron 调度运行 Subscleaner 脚本，并处理挂载的媒体目录中的字幕文件。

配合 YAMS 使用

YAMS 是一个高度定制化的媒体服务器，更多信息见：[***]

在 docker-compose.custom.yaml 中添加以下容器配置：

sh
  subscleaner:
    image: rogsme/subscleaner
    environment:
      - CRON=0 0 * * *
    volumes:
      - ${MEDIA_DIRECTORY}:/files

有关如何在 YAMS 中添加自定义容器的更多信息：[***]

贡献

欢迎贡献！如有任何建议或改进，欢迎 Fork 仓库并提交 Pull Request。

许可证

Subscleaner 采用 GNU General Public License v3.0 或更高版本授权。详见 LICENSE 文件。

致谢

本仓库是对 Github 仓库 https://github.com/FraMecca/subscleaner 的重写。

感谢 Github 上的 https://github.com/FraMecca/%EF%BC%81