mirror of
https://github.com/StuffAnThings/qbit_manage.git
synced 2024-11-10 09:32:29 +08:00
This tool will help manage tedious tasks in qBittorrent and automate them. Tag, categorize, remove Orphaned data, remove unregistered torrents and much much more.
.gitignore | ||
config.yml.sample | ||
qbit_manage.py | ||
README.md | ||
requirements.txt |
qBit Management
This is a program used to manage your qBittorrent instance such as:
- Tag torrents based on tracker URL (only tag torrents that have no tags)
- 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 (used in conjunction with the cross-seed script) <-- cross-seed now allows for torrent injections directly to qBit.
- 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 and allows optional cleanup to delete these torrents and contents based on maximum ratio and/or time seeded
Installation
Check out the wiki for installation help
Usage
To run the script in an interactive terminal run:
- copy the
config.yml.sample
file toconfig.yml
- add your qBittorrent host, user and pass. If you are not using a username and password you can remove the
user
andpass
lines. - add your
cross_seed
androot_dir
. If you are using a docker container you must fill outremote_dir
as well. - Add your categories and save path to match with what is being used in your qBittorrent instance. I suggest using the full path when defining
save_path
- Add the
tag
definition based on tracker URL - Modify the
nohardlinks
by specifying your completed movies/series category to match with qBittorrent. Please ensure theroot_dir
and/orremote_dir
is added in thedirectory
section - To run the script in an interactive terminal with a list of possible commands run:
python qbit_manage.py -h
Commands
Shell Command | Description | Default Value |
---|---|---|
-c CONFIG or --config-file CONFIG |
This is used if you want to use a different name for your config.yml. Example: tv.yml |
config.yml |
-l LOGFILE, or --log-file LOGFILE, |
This is used if you want to use a different name for your log file. Example: tv.log |
activity.log |
-m or --manage |
Use this if you would like to update your tags, categories, remove unregistered torrents, AND recheck/resume paused torrents. | |
-s or --cross-seed |
Use this after running cross-seed script to add torrents from the cross-seed output folder to qBittorrent | |
-re or --recheck |
Recheck paused torrents sorted by lowest size. Resume if Completed. | |
-g or --cat-update |
Use this if you would like to update your categories. | |
-t or --tag-update |
Use this if you would like to update your tags. (Only adds tags to untagged torrents) | |
-r or --rem-unregistered |
Use this if you would like to remove unregistered torrents. (It will the delete data & torrent if it is not being cross-seeded, otherwise it will just remove the torrent without deleting data) | |
-ro or --rem-orphaned |
Use this if you would like to remove orphaned files from your root_dir directory that are not referenced by any torrents. It will scan your root_dir directory and compare it with what is in qBittorrent. Any data not referenced in qBittorrent will be moved into /data/torrents/orphaned_data folder for you to review/delete. |
|
-tnhl or --tag-nohardlinks |
Use this to tag any torrents that do not have any hard links associated with any of the files. This is useful for those that use Sonarr/Radarr that hard links your media files with the torrents for seeding. When files get upgraded they no longer become linked with your media therefore will be tagged with a new tag noHL. You can then safely delete/remove these torrents to free up any extra space that is not being used by your media folder. | |
--dry-run |
If you would like to see what is gonna happen but not actually move/delete or tag/categorize anything. | |
--log LOGLEVEL |
Change the ouput log level. | INFO |
Config
To choose the location of the YAML config file
python qbit_manage.py --config-file <path_to_config>
Log
To choose the location of the Log File
python qbit_manage.py --log-file <path_to_log>