mirror of
https://github.com/StuffAnThings/qbit_manage.git
synced 2025-09-06 21:24:28 +08:00
469bd8391e
* 4.1.15-develop1 * Update SUPPORTED_VERSIONS.json for master (#706) * 4.1.14-develop1 * Update SUPPORTED_VERSIONS.json for master (#692) * 4.1.13-develop * Bump croniter from 3.0.3 to 3.0.4 (#680) Bumps [croniter](https://github.com/kiorky/croniter) from 3.0.3 to 3.0.4. - [Changelog](https://github.com/kiorky/croniter/blob/master/CHANGELOG.rst) - [Commits](https://github.com/kiorky/croniter/compare/3.0.3...3.0.4) --- updated-dependencies: - dependency-name: croniter dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump qbittorrent-api from 2024.9.67 to 2024.10.68 (#684) Bumps [qbittorrent-api](https://github.com/rmartin16/qbittorrent-api) from 2024.9.67 to 2024.10.68. - [Release notes](https://github.com/rmartin16/qbittorrent-api/releases) - [Changelog](https://github.com/rmartin16/qbittorrent-api/blob/main/CHANGELOG.md) - [Commits](https://github.com/rmartin16/qbittorrent-api/compare/v2024.9.67...v2024.10.68) --- updated-dependencies: - dependency-name: qbittorrent-api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update SUPPORTED_VERSIONS.json * bump develop * (ci): add ci for version bump on develop (#688) * Fixes bug in torrent exporting for qbit versions under 4.5.0 * Bump actions/checkout from 3 to 4 (#690) * Bump actions/setup-python from 3 to 5 (#689) * Bump croniter from 3.0.4 to 5.0.1 (#685) * [pre-commit.ci] pre-commit autoupdate (#682) * 4.1.13 * Update SUPPORTED_VERSIONS.json --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: bobokun <jon.cy.lee98@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Co-authored-by: bobokun <12660469+bobokun@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * chore(docs): Sync wiki to docs [skip-cd] * Bump qbittorrent-api from 2024.10.68 to 2024.11.69 (#693) * Bump qbittorrent-api from 2024.10.68 to 2024.11.69 Bumps [qbittorrent-api](https://github.com/rmartin16/qbittorrent-api) from 2024.10.68 to 2024.11.69. - [Release notes](https://github.com/rmartin16/qbittorrent-api/releases) - [Changelog](https://github.com/rmartin16/qbittorrent-api/blob/main/CHANGELOG.md) - [Commits](https://github.com/rmartin16/qbittorrent-api/compare/v2024.10.68...v2024.11.69) --- updated-dependencies: - dependency-name: qbittorrent-api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * bump develop (#694) * chore: bump qbittorrent-api (#697) * chore: bump qbittorrent-api * Update VERSION * Update SUPPORTED_VERSIONS.json * chore(docs): Sync wiki to docs [skip-cd] * 4.1.14 * Update SUPPORTED_VERSIONS.json * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: bobokun <jon.cy.lee98@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bakerboy448 <55419169+bakerboy448@users.noreply.github.com> Co-authored-by: bobokun <12660469+bobokun@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Actionbot <actions@github.com> * (fix): BHD add additional unregistered messages for season packs (#707) * (fix): BHD add additional unregistered messages for season packs * Update VERSION * docs: update README.md (#708) * Update README.md Fixed small typo * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * (bhd): handle additional season pack unregistered (#709) * (bhd): handle additional season pack unregistered "COMPLETE SEASON UPLOADED" did not match Complete Season Uploaded: https://beyond-hd.me/torrents/[link] * fixup! * Bump qbittorrent-api from 2024.11.70 to 2024.12.71 (#712) Bumps [qbittorrent-api](https://github.com/rmartin16/qbittorrent-api) from 2024.11.70 to 2024.12.71. - [Release notes](https://github.com/rmartin16/qbittorrent-api/releases) - [Changelog](https://github.com/rmartin16/qbittorrent-api/blob/main/CHANGELOG.md) - [Commits](https://github.com/rmartin16/qbittorrent-api/compare/v2024.11.70...v2024.12.71) --- updated-dependencies: - dependency-name: qbittorrent-api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * bump 4.1.15-develop4 * Update SUPPORTED_VERSIONS.json * Bump croniter from 5.0.1 to 6.0.0 (#711) * Fix help description for --rem-orphaned argument (#716) * Bump ruamel-yaml from 0.18.6 to 0.18.7 (#720) Bumps ruamel-yaml from 0.18.6 to 0.18.7. --- updated-dependencies: - dependency-name: ruamel-yaml dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump ruamel-yaml from 0.18.7 to 0.18.8 (#721) Bumps ruamel-yaml from 0.18.7 to 0.18.8. --- updated-dependencies: - dependency-name: ruamel-yaml dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump gitpython from 3.1.43 to 3.1.44 (#722) Bumps [gitpython](https://github.com/gitpython-developers/GitPython) from 3.1.43 to 3.1.44. - [Release notes](https://github.com/gitpython-developers/GitPython/releases) - [Changelog](https://github.com/gitpython-developers/GitPython/blob/main/CHANGES) - [Commits](https://github.com/gitpython-developers/GitPython/compare/3.1.43...3.1.44) --- updated-dependencies: - dependency-name: gitpython dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * [pre-commit.ci] pre-commit autoupdate (#715) * [pre-commit.ci] pre-commit autoupdate updates: - [github.com/asottile/pyupgrade: v3.19.0 → v3.19.1](https://github.com/asottile/pyupgrade/compare/v3.19.0...v3.19.1) * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: bobokun <12660469+bobokun@users.noreply.github.com> * Fixes #719 * 4.1.15 --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: bobokun <jon.cy.lee98@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: bobokun <12660469+bobokun@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Actionbot <actions@github.com> Co-authored-by: tanka8 <tanka8@gmail.com> Co-authored-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>
66 lines
5.9 KiB
Markdown
Executable file
66 lines
5.9 KiB
Markdown
Executable file
# <img src="qbm_logo.png" width="75"> qBit Manage
|
|
|
|
[](https://github.com/StuffAnThings/qbit_manage/releases)
|
|
[](https://github.com/StuffAnThings/qbit_manage/tree/develop)
|
|
[](https://hub.docker.com/r/bobokun/qbit_manage)
|
|
|
|
[](https://results.pre-commit.ci/latest/github/StuffAnThings/qbit_manage/master)
|
|
[](https://ghcr.io/StuffAnThings/qbit_manage)
|
|
[](https://hub.docker.com/r/bobokun/qbit_manage)
|
|
[](https://github.com/sponsors/bobokun)
|
|
|
|
This is a program used to manage your qBittorrent instance such as:
|
|
|
|
* Tag torrents based on tracker URLs
|
|
* Apply category based on `save_path` to uncategorized torrents in category's `save_path`
|
|
* Change categories based on current category (`cat_change`)
|
|
* Remove unregistered torrents (delete data & torrent if it is not being cross-seeded, otherwise it will just remove the torrent)
|
|
* Automatically add [cross-seed](https://github.com/cross-seed/cross-seed) torrents in paused state. **\*Note: cross-seed now allows for torrent injections directly to qBit, making this feature rarely needed/used.\***
|
|
* Recheck paused torrents sorted by lowest size and resume if completed
|
|
* Remove orphaned files from your root directory that are not referenced by qBittorrent
|
|
* Tag any torrents that have no hard links outside the root folder (for multi-file torrents the largest file is used)
|
|
* Apply share limits based on groups filtered by tags/categories and allows optional cleanup to delete these torrents and contents based on maximum ratio and/or time seeded. Additionally allows for a minimum seed time to ensure tracker rules are respected and minimum number of seeders to keep torrents alive.
|
|
* RecycleBin function to move files into a RecycleBin folder instead of deleting the data directly when deleting a torrent
|
|
* Built-in scheduler to run the script every x minutes. (Can use `--run` command to run without the scheduler)
|
|
* Webhook notifications with [Notifiarr](https://notifiarr.com/) and [Apprise API](https://github.com/caronc/apprise-api) integration
|
|
|
|
## Supported Qbittorrent Versions
|
|
|
|
We rely on [qbittorrent-api](https://pypi.org/project/qbittorrent-api/) to interact with Qbittorrent.
|
|
|
|
Generally expect new releases of Qbittorrent to not immediately be supported. Support CANNOT be added until qbittorrent-api adds support for the version. Any material changed and impact must then be assessed prior to Qbit Manage supporting it.
|
|
|
|
### Master
|
|
|
|
|
|
|
|
|
|
|
|
### Develop
|
|
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
Check out the [wiki](https://github.com/StuffAnThings/qbit_manage/wiki) for installation help
|
|
|
|
1. Install qbit_manage either by installing Python 3.9.0+ on the localhost and following the [Local Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Local-Installations) Guide or by installing Docker and following the [Docker Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Docker-Installation) Guide or the [unRAID Installation](https://github.com/StuffAnThings/qbit_manage/wiki/Unraid-Installation) Guide.
|
|
1. Once installed, you have to [set up your Configuration](https://github.com/StuffAnThings/qbit_manage/wiki/Config-Setup) by create a [Configuration File](https://github.com/StuffAnThings/qbit_manage/blob/master/config/config.yml.sample) filled with all your values to connect to your qBittorrent instance.
|
|
1. Please refer to the list of [Commands](https://github.com/StuffAnThings/qbit_manage/wiki/Commands) that can be used with this tool.
|
|
|
|
## Usage
|
|
|
|
To run the script in an interactive terminal with a list of possible commands run:
|
|
|
|
```bash
|
|
python qbit_manage.py -h
|
|
```
|
|
|
|
## Support
|
|
|
|
* If you have any questions or require support please join the [Notifiarr Discord](https://discord.com/invite/AURf8Yz) and post your question under the `qbit-manage` channel.
|
|
* If you're getting an Error or have an Enhancement post in the [Issues](https://github.com/StuffAnThings/qbit_manage/issues/new).
|
|
* If you have a configuration question post in the [Discussions](https://github.com/StuffAnThings/qbit_manage/discussions/new).
|
|
* Pull Request are welcome but please submit them to the [develop branch](https://github.com/StuffAnThings/qbit_manage/tree/develop).
|