Files
Auto_Bangumi/README.md
EstrellaXD 155aa4f369 Merge branch 'main' into 3.1-dev
# Conflicts:
#	.github/workflows/docker.yml
#	.github/workflows/release.yml
#	.gitignore
#	Dockerfile
#	backend/.pre-commit-config.yaml
#	backend/pyproject.toml
#	backend/src/docker/etc/cont-init.d/010-old-compatible
#	backend/src/docker/etc/cont-init.d/020-fixuser
#	backend/src/docker/etc/services.d/auto_bangumi/finish
#	backend/src/docker/etc/services.d/auto_bangumi/notification-fd
#	backend/src/docker/etc/services.d/auto_bangumi/run
#	backend/src/icon
#	backend/src/main.py
#	backend/src/module/api/__init__.py
#	backend/src/module/api/auth.py
#	backend/src/module/api/bangumi.py
#	backend/src/module/api/config.py
#	backend/src/module/api/download.py
#	backend/src/module/api/log.py
#	backend/src/module/api/program.py
#	backend/src/module/api/web.py
#	backend/src/module/checker/checker.py
#	backend/src/module/conf/__init__.py
#	backend/src/module/core/program.py
#	backend/src/module/core/rss_feed.py
#	backend/src/module/database/__init__.py
#	backend/src/module/database/bangumi.py
#	backend/src/module/database/connector.py
#	backend/src/module/database/torrent.py
#	backend/src/module/database/user.py
#	backend/src/module/downloader/download_client.py
#	backend/src/module/manager/collector.py
#	backend/src/module/manager/torrent.py
#	backend/src/module/models/__init__.py
#	backend/src/module/models/bangumi.py
#	backend/src/module/models/torrent.py
#	backend/src/module/models/user.py
#	backend/src/module/network/__init__.py
#	backend/src/module/network/request_contents.py
#	backend/src/module/network/site/__init__.py
#	backend/src/module/network/site/mikan.py
#	backend/src/module/notification/notification.py
#	backend/src/module/parser/analyser/raw_parser.py
#	backend/src/module/parser/analyser/tmdb_parser.py
#	backend/src/module/rss/analyser.py
#	backend/src/module/rss/filter.py
#	backend/src/module/rss/searcher.py
#	backend/src/module/searcher/plugin/__init__.py
#	backend/src/module/searcher/plugin/mikan.py
#	backend/src/module/searcher/searcher.py
#	backend/src/module/security/__init__.py
#	backend/src/module/security/api.py
#	backend/src/module/update/__init__.py
#	backend/src/module/update/data_migration.py
#	backend/src/test/test_raw_parser.py
#	requirements.txt
2023-09-19 14:20:28 +08:00

96 lines
3.6 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<p align="center">
<img src="docs/image/icons/light-icon.svg#gh-light-mode-only" width=50%/ alt="">
<img src="docs/image/icons/dark-icon.svg#gh-dark-mode-only" width=50%/ alt="">
</p>
<p align="center">
<img title="docker build version" src="https://img.shields.io/docker/v/estrellaxd/auto_bangumi" alt="">
<img title="release date" src="https://img.shields.io/github/release-date/estrellaxd/auto_bangumi" alt="">
<img title="docker pull" src="https://img.shields.io/docker/pulls/estrellaxd/auto_bangumi" alt="">
<img title="python version" src="https://img.shields.io/badge/python-3.11-blue" alt="">
</p>
<p align="center">
<a href="https://www.autobangumi.org">官方网站</a> | <a href="https://www.autobangumi.org/deploy/quick-start.html">快速开始</a> | <a href="https://www.autobangumi.org/changelog/3.0.html">更新日志</a> | <a href="https://t.me/autobangumi">TG 群组</a>
</p>
# 项目说明
<p align="center">
<img title="AutoBangumi" src="docs/image/preview/window.png" alt="" width=75%>
</p>
本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧,就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别,无需二次刮削。
## AutoBangumi 功能说明
- 简易单次配置就能持续使用
- 无需介入的 `RSS` 解析器,解析番组信息并且自动生成下载规则。
- 番剧文件整理:
```
Bangumi
├── bangumi_A_title
│   ├── Season 1
│   │   ├── A S01E01.mp4
│   │   ├── A S01E02.mp4
│   │   ├── A S01E03.mp4
│   │   └── A S01E04.mp4
│   └── Season 2
│      ├── A S02E01.mp4
│      ├── A S02E02.mp4
│      ├── A S02E03.mp4
│      └── A S02E04.mp4
├── bangumi_B_title
│   └─── Season 1
```
- 全自动重命名,重命名后 99% 以上的番剧可以直接被媒体库软件直接刮削
```
[Lilith-Raws] Kakkou no Iinazuke - 07 [Baha][WEB-DL][1080p][AVC AAC][CHT][MP4].mp4
>>
Kakkou no Iinazuke S01E07.mp4
```
- 自定义重命名,可以根据上级文件夹对所有子文件重命名。
- 季中追番可以补全当季遗漏的所有剧集
- 高度可自定义的功能选项,可以针对不同媒体库软件微调
- 无需维护完全无感使用
- 内置 TDMB 解析器,可以直接生成完整的 TMDB 格式的文件以及番剧信息。
- 对于 Mikan RSS 的反代支持。
## 相关群组
- 更新推送:[Telegram Channel](https://t.me/autobangumi_update)
- Bug 反馈群:[Telegram](https://t.me/+yNisOnDGaX5jMTM9)
## [Roadmap](https://github.com/users/EstrellaXD/projects/2)
***开发中的功能:***
- 内置 RSS 推送更新器。
- 搜索功能
***计划开发的功能:***
- 对其他站点种子的解析归类。
- 本地化番剧订阅方式。
- Transmission 的支持。
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=EstrellaXD/Auto_Bangumi&type=Date)](https://star-history.com/#EstrellaXD/Auto_Bangumi)
## 贡献
欢迎提供 ISSUE 或者 PR, 贡献代码前建议阅读 [CONTRIBUTING.md](CONTRIBUTING.md)。
贡献者名单请见:
<a href="https://github.com/EstrellaXD/Auto_Bangumi/graphs/contributors"><img src="https://contrib.rocks/image?repo=EstrellaXD/Auto_Bangumi"></a>
## Licence
[MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE)