diff --git a/.dockerignore b/.dockerignore index 94a64c67..595cb0a5 100644 --- a/.dockerignore +++ b/.dockerignore @@ -19,8 +19,8 @@ coverage.xml ../.pytest_cache .hypothesis -src/module/tests -src/module/conf/const_dev.py +backend/src/module/tests +backend/src/module/conf/const_dev.py config/bangumi.json/config/bangumi.json /docs /.github @@ -33,8 +33,8 @@ config/bangumi.json/config/bangumi.json dist.zip data config -/src/config -/src/data +/backend/src/config +/backend/src/data .pytest_cache test .env diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 14514ac3..74367ca5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,12 +1,12 @@ name: 问题反馈 description: File a bug report -title: "[错误报告] 请在此处简单描述你的问题" +title: "[错误报告]请在此处简单描述你的问题" labels: ["bug"] body: - type: markdown attributes: value: | - 描述问题前，请先更新到最新版本。2.5 之前的版本升级请参考 [升级指南](https://github.com/EstrellaXD/Auto_Bangumi/wiki/2.6更新说明#如何从老版本更新的注意事项) + 描述问题前，请先更新到最新版本。2.5 之前的版本升级请参考 [升级指南](https://www.autobangumi.org/changelog/2.6.html#如何从老版本更新的注意事项) 请确认以下信息，如果你的问题可以直接在文档中找到，那么你的 issue 将会被直接关闭。 解析器问题请转到[专用模板](https://github.com/EstrellaXD/Auto_Bangumi/issues/new?assignees=&labels=bug&template=parser_bug.yml&title=%5B解析器错误%5D)， 重命名问题请到[专用模板](https://github.com/EstrellaXD/Auto_Bangumi/issues/new?assignees=&labels=bug&template=rename_bug.yml&title=%5B重命名错误%5D) @@ -18,9 +18,9 @@ body: options: - label: 我的版本是最新版本，我的版本号与 [version](https://github.com/EstrellaXD/Auto_Bangumi/releases/latest) 相同。 required: true - - label: 我已经查阅了[排错流程](https://github.com/EstrellaXD/Auto_Bangumi/wiki/排错流程)，确保提出的问题不在其中。 + - label: 我已经查阅了[排错流程](https://autobangumi.org/faq/排错流程.html)，确保提出的问题不在其中。 required: true - - label: 我已经查阅了[已知问题](https://github.com/EstrellaXD/Auto_Bangumi/wiki/常见问题)，并确认我的问题不在其中。 + - label: 我已经查阅了[已知问题](https://autobangumi.org/faq/常见问题.html)，并确认我的问题不在其中。 required: true - label: 我已经 [issue](https://github.com/EstrellaXD/Auto_Bangumi/issues) 中搜索过，确认我的问题没有被提出过。 required: true diff --git a/.github/ISSUE_TEMPLATE/discussion.yml b/.github/ISSUE_TEMPLATE/discussion.yml index 26f18ef6..6c50712c 100644 --- a/.github/ISSUE_TEMPLATE/discussion.yml +++ b/.github/ISSUE_TEMPLATE/discussion.yml @@ -1,6 +1,6 @@ name: 项目讨论 description: discussion -title: "[Discussion]: " +title: "[Discussion] " labels: ["discussion"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index bec710d0..c1572144 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: 功能改进 description: Feature Request -title: "[Feature Request]: " +title: "[Feature Request]" labels: ["feature request"] body: - type: markdown diff --git a/.github/ISSUE_TEMPLATE/rfc.yml b/.github/ISSUE_TEMPLATE/rfc.yml new file mode 100644 index 00000000..6b3b8aad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/rfc.yml @@ -0,0 +1,53 @@ +# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms + +name: 功能提案 +description: Request for Comments +title: "[RFC]" +labels: ["RFC"] +body: + - type: markdown + attributes: + value: | + 一份提案(RFC)定位为 **「在某功能/重构的具体开发前，用于开发者间 review 技术设计/方案的文档」**， + 目的是让协作的开发者间清晰的知道「要做什么」和「具体会怎么做」，以及所有的开发者都能公开透明的参与讨论； + 以便评估和讨论产生的影响 (遗漏的考虑、向后兼容性、与现有功能的冲突)， + 因此提案侧重在对解决问题的 **方案、设计、步骤** 的描述上。 + + 如果仅希望讨论是否添加或改进某功能本身，请使用 -> [Issue: 功能改进](https://github.com/EstrellaXD/Auto_Bangumi/issues/new?labels=feature+request&template=feature_request.yml&title=%5BFeature+Request%5D+) + + - type: textarea + id: background + attributes: + label: 背景 or 问题 + description: 简单描述遇到的什么问题或需要改动什么。可以引用其他 issue、讨论、文档等。 + validations: + required: true + + - type: textarea + id: goal + attributes: + label: "目标 & 方案简述" + description: 简单描述提案此提案实现后，**预期的目标效果**，以及简单大致描述会采取的方案/步骤，可能会/不会产生什么影响。 + validations: + required: true + + - type: textarea + id: design + attributes: + label: "方案设计 & 实现步骤" + description: | + 详细描述你设计的具体方案，可以考虑拆分列表或要点，一步步描述具体打算如何实现的步骤和相关细节。 + 这部份不需要一次性写完整，即使在创建完此提案 issue 后，依旧可以再次编辑修改。 + validations: + required: false + + + - type: textarea + id: alternative + attributes: + label: "替代方案 & 对比" + description: | + [可选] 为来实现目标效果，还考虑过什么其他方案，有什么对比？ + validations: + required: false + diff --git a/README.md b/README.md index df7e266a..970937d8 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@

+

+ 官方网站 | 快速开始 | 更新日志 | TG 群组 +

+ # 项目说明

@@ -17,10 +21,6 @@ 本项目是基于 [Mikan Project](https://mikanani.me)、[qBittorrent](https://qbittorrent.org) 的全自动追番整理下载工具。只需要在 [Mikan Project](https://mikanani.me) 上订阅番剧，就可以全自动追番。并且整理完成的名称和目录可以直接被 [Plex]()、[Jellyfin]() 等媒体库软件识别，无需二次刮削。 -[主项目地址](https://www.github.com/EstrellaXD/Auto_Bangumi) -/ [WebUI 仓库](https://github.com/Rewrite0/Auto_Bangumi_WebUI) -/ [Wiki 说明](https://www.github.com/EstrellaXD/Auto_Bangumi/wiki) - ## AutoBangumi 功能说明 - 简易单次配置就能持续使用 @@ -59,19 +59,12 @@ - 内置 TDMB 解析器，可以直接生成完整的 TMDB 格式的文件以及番剧信息。 - 对于 Mikan RSS 的反代支持。 -## 如何开始 - -- **[部署说明 (Official)](https://github.com/EstrellaXD/Auto_Bangumi/wiki)** -- **[2.6版本更新说明](https://github.com/EstrellaXD/Auto_Bangumi/wiki/2.6更新说明)** -- **[3.0版本更新说明](https://github.com/EstrellaXD/Auto_Bangumi/wiki/3.0更新说明)** -- **[部署说明 (手把手)](https://www.himiku.com/archives/auto-bangumi.html)** - ## 相关群组 - 更新推送：[Telegram Channel](https://t.me/autobangumi_update) - Bug 反馈群：[Telegram](https://t.me/+yNisOnDGaX5jMTM9) -## Roadmap +## [Roadmap](https://github.com/users/EstrellaXD/projects/2) ***开发中的功能：*** @@ -82,19 +75,21 @@ - 对其他站点种子的解析归类。 - 本地化番剧订阅方式。 -- Transmission & Aria2 的支持。 - -# 声明 - -## 致谢 - -感谢 [Sean](https://github.com/findix) 提供的大量帮助 -感谢 [Rewrite0](https://github.com/Rewrite0) 开发的 WebUI +- 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)。 + +贡献者名单请见： + + + + ## Licence [MIT licence](https://github.com/EstrellaXD/Auto_Bangumi/blob/main/LICENSE) diff --git a/pyrightconfig.json b/pyrightconfig.json new file mode 100644 index 00000000..4521b494 --- /dev/null +++ b/pyrightconfig.json @@ -0,0 +1,8 @@ +{ + "pythonPath": "/opt/homebrew/Caskroom/miniforge/base/envs/auto_bangumi/bin/python", + "root": "backend/src", + "venvPath": "/opt/homebrew/Caskroom/miniforge/base/envs", + "venv": "auto_bangumi", + "typeCheckingMode": "basic", + "reportMissingImports": true +}