StuffAnThings/qbit_manage
1
1
Fork 0
mirror of https://github.com/StuffAnThings/qbit_manage.git synced 2024-09-20 07:16:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated docs

Browse source
This commit is contained in:
Jon 2021-04-05 19:48:42 -04:00
parent 47cfe8c399
commit d82bc3b51b
No known key found for this signature in database
GPG key ID: 9665BA6CF5DC2671
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -1,10 +1,11 @@
# qBit Management
This is a program used to manage your qBitorrent instance such as:
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](https://github.com/mmgoodnow/cross-seed) torrents in paused state (used in conjunction with the [cross-seed](https://github.com/mmgoodnow/cross-seed) script)
* Recheck paused torrents sorted by lowest size. Resume if completed.
* Recheck paused torrents sorted by lowest size and resume if completed
* Remove orphaned files from your root directory that are not referenced by qBittorrent
## Installation
@ -25,7 +26,7 @@ To run the script in an interactive terminal run:
* copy the `config.yml.sample` file to `config.yml`
* add your qBittorrent host, user and pass. If you are not using a username and password you can remove the `user` and `pass` lines.
* add your `cross_seed` and `root_dir`. If you are using a docker container you must fill out `remote_dir` as well.
* Add your categories and save path to match with what is being used in your qBitorrent instance. I suggest using the full path when defining `save_path`
* 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
* To run the script in an interactive terminal with a list of possible commands run:
```
@ -43,7 +44,7 @@ python qbit_manage.py -h
| `-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 Qbitorrent. Any data not referenced in Qbitorrent will be moved into `/data/torrents/orphaned_data` folder for you to review/delete. | |
| `-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. | |
| `--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 |