StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2024-11-10 09:32:29 +08:00
Code Issues Projects Releases Packages Wiki Activity
This tool will help manage tedious tasks in qBittorrent and automate them. Tag, categorize, remove Orphaned data, remove unregistered torrents and much much more.
850 commits 5 branches 59 tags 2.5 MiB
Python 99%
Shell 0.6%
Dockerfile 0.3%
Makefile 0.1%
Find a file
dependabot[bot] 4720e24db9
Bump actions/checkout from 3 to 4 
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-09-05 00:32:01 +00:00
.github Bump actions/checkout from 3 to 4 2023-09-05 00:32:01 +00:00
config Merge branch 'develop' into patch-5 2023-06-27 08:50:15 -04:00
modules potential fix for #363 2023-08-11 17:06:34 -04:00
scripts black formatting + precommit updates 2023-06-11 15:54:52 -04:00
.dockerignore more pre-commits and makefile 2022-11-01 11:24:13 -04:00
.flake8 pre-commit updates 2022-12-03 09:06:01 -05:00
.gitignore more pre-commits and makefile 2022-11-01 11:24:13 -04:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate 2023-08-29 02:29:17 +00:00
activate.sh more pre-commits and makefile 2022-11-01 11:24:13 -04:00
CHANGELOG 4.0.3 2023-08-14 20:01:13 -04:00
deactivate.sh more pre-commits and makefile 2022-11-01 11:24:13 -04:00
Dockerfile changelog and version bump 2023-05-22 21:50:29 -04:00
LICENSE tox and pre-commit formatting 2022-10-29 11:19:09 -04:00
Makefile black formatting + precommit updates 2023-06-11 15:54:52 -04:00
qbit_manage.py fix for unknown branch 2023-06-16 19:15:40 -04:00
qbm_logo.png Add new logo 2021-11-30 15:02:48 -05:00
README.md updates README to include share_limits 2023-06-11 17:25:39 -04:00
requirements-dev.txt Bump pre-commit from 3.3.3 to 3.4.0 2023-09-04 01:18:05 +00:00
requirements.txt Bump gitpython from 3.1.32 to 3.1.34 2023-09-04 01:17:53 +00:00
setup.py black formatting + precommit updates 2023-06-11 15:54:52 -04:00
tox.ini black formatting + precommit updates 2023-06-11 15:54:52 -04:00
VERSION 4.0.3 2023-08-14 20:01:13 -04:00

README.md

qBit Manage

GitHub release (latest by date) GitHub commits since latest release (by SemVer) Docker Image Version (latest semver) Github Workflow Status pre-commit.ci status Docker Pulls Sponsor or Donate

This is a program used to manage your qBittorrent instance such as:

  • Tag torrents based on tracker URLs
  • Update categories based on save directory
  • Remove unregistered torrents (delete data & torrent if it is not being cross-seeded, otherwise it will just remove the torrent)
  • Automatically add cross-seed torrents in paused state. *Note: cross-seed now allows for torrent injections directly to qBit, making this feature obsolete.*
  • 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 outisde the root folder
  • 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
  • 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 and Apprise API integration

Getting Started

Check out the wiki for installation help

  1. Install qbit_manage either by installing Python 3.8.1+ on the localhost and following the Local Installation Guide or by installing Docker and following the Docker Installation Guide or the unRAID Installation Guide.
  2. Once installed, you have to set up your Configuration by create a Configuration File filled with all your values to connect to your qBittorrent instance.
  3. Please refer to the list of Commands that can be used with this tool.

Usage

To run the script in an interactive terminal with a list of possible commands run:

python qbit_manage.py -h

Support

  • If you have any questions or require support please join the Notifiarr Discord and post your question under the qbit-manage channel.
  • If you're getting an Error or have an Enhancement post in the Issues.
  • If you have a configuration question post in the Discussions.
  • Pull Request are welcome but please submit them to the develop branch.