Merge pull request #51 from StuffAnThings/develop

.dockerignore

@@ -17,6 +17,6 @@ config
 Dockerfile
 venv
 .idea
-.env
+.venv
 test.py
 !config/config.yml.sample

.github/workflows/develop.yml

@@ -24,6 +24,11 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
       - name: Set up Docker Buildx
         id: buildx
         uses: docker/setup-buildx-action@v1
@@ -34,5 +39,6 @@ jobs:
         with:
           context: ./
           file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ secrets.DOCKER_HUB_USERNAME }}/qbit_manage:develop

.github/workflows/latest.yml

@@ -3,8 +3,6 @@ name: Docker Latest Release
 on:
   push:
     branches: [ master ]
-  pull_request:
-    branches: [ master ]
 
 jobs:
 
@@ -22,6 +20,11 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
       - name: Set up Docker Buildx
         id: buildx
         uses: docker/setup-buildx-action@v1
@@ -32,5 +35,6 @@ jobs:
         with:
           context: ./
           file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ secrets.DOCKER_HUB_USERNAME }}/qbit_manage:latest

.github/workflows/version.yml

@@ -21,6 +21,11 @@ jobs:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
       - name: Set up Docker Buildx
         id: buildx
         uses: docker/setup-buildx-action@v1
@@ -35,5 +40,6 @@ jobs:
         with:
           context: ./
           file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
           push: true
           tags: ${{ secrets.DOCKER_HUB_USERNAME }}/qbit_manage:${{ steps.get_version.outputs.VERSION }}

.gitignore

@@ -8,4 +8,4 @@ __pycache__/
 .vscode/*
 !.github/**
 *.svg
-.env
+.venv

Dockerfile

@@ -1,4 +1,9 @@
 FROM python:3.9-slim
+RUN echo "**** install system packages ****" \
+ && apt-get update \
+ && apt-get upgrade -y --no-install-recommends \
+ && apt-get install -y tzdata --no-install-recommends \
+ && apt-get install -y gcc g++ libxml2-dev libxslt-dev libz-dev
 COPY requirements.txt /
 RUN echo "**** install python packages ****" \
  && pip3 install --no-cache-dir --upgrade --requirement /requirements.txt \

README.md

@@ -18,60 +18,19 @@ This is a program used to manage your qBittorrent instance such as:
 * 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
 * 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)
-## Installation
+## Getting Started
 
 Check out the [wiki](https://github.com/StuffAnThings/qbit_manage/wiki) for installation help
-
+1. Install qbit_mange either by installing Python3 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.<br>
+2. 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. 
+3. 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 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're running cross-seed in 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 qBittorrent instance. I suggest using the full path when defining `save_path`
-* Add the `tag` definition based on tracker URL (optional add seed goals/limit upload speed by tag)
-* Modify the  `nohardlinks` by specifying your completed movies/series category to match with qBittorrent. Please ensure the `root_dir` and/or  `remote_dir` is added in the `directory` section
-* `root_dir` needs to be defined in order to use the RecycleBin function. If optional `empty_after_x_days` is not defined then it will never empty the RecycleBin. Setting it to 0 will empty the RecycleBin immediately.
-* Modify the `orphaned` section to define file patterns not to consider as orphans. Use this to exclude your incomplete torrents directory, or to ignore auto-generated files such as Thumbs.db.
-* To run the script in an interactive terminal with a list of possible commands run:
+To run the script in an interactive terminal with a list of possible commands run:
 
 ```bash
 python qbit_manage.py -h
 ```
-
-## Commands
-
-| Shell Command |Docker Environment Variable |Description | Default Value |
-| :------------ | :------------  | :------------ | :------------ |
-| `-r` or`--run` | QBT_RUN |Run without the scheduler. Script will exit after completion. | False |
-| `-sch` or `--schedule` | QBT_SCHEDULE  | Schedule to run every x minutes. (Default set to 30)  | 30 |
-| `-c CONFIG` or `--config-file CONFIG` | QBT_CONFIG  | This is used if you want to use a different name for your config.yml. `Example: tv.yml`  | config.yml |
-| `-lf LOGFILE,` or `--log-file LOGFILE,` | QBT_LOGFILE | This is used if you want to use a different name for your log file. `Example: tv.log` | activity.log |
-| `-cs` or `--cross-seed` | QBT_CROSS_SEED | Use this after running [cross-seed script](https://github.com/mmgoodnow/cross-seed) to add torrents from the cross-seed output folder to qBittorrent  | False |
-| `-re` or `--recheck` | QBT_RECHECK | Recheck paused torrents sorted by lowest size. Resume if Completed.  | False |
-| `-cu` or `--cat-update` | QBT_CAT_UPDATE |  Use this if you would like to update your categories.  | False |
-| `-tu` or `--tag-update` | QBT_TAG_UPDATE |  Use this if you would like to update your tags and/or set seed goals/limit upload speed by tag. (Only adds tags to untagged torrents) | False |
-| `-ru` or `--rem-unregistered` | QBT_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) | False |
-| `-ro` or `--rem-orphaned` | QBT_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. | False |
-| `-tnhl` or `--tag-nohardlinks` | QBT_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. | False |
-| `-sr` or `--skip-recycle` | QBT_SKIP_RECYCLE | Use this to skip emptying the Reycle Bin folder (`/root_dir/.RecycleBin`). | False |
-| `-dr` or `--dry-run` | QBT_DRY_RUN |   If you would like to see what is gonna happen but not actually move/delete or tag/categorize anything. | False |
-| `-ll` or `--log-level LOGLEVEL` | QBT_LOG_LEVEL |   Change the ouput log level. | INFO |
-| `-d` or `--divider` | QBT_DIVIDER |   Character that divides the sections (Default: '=') | = |
-| `-w` or `--width` | QBT_WIDTH |   Screen Width (Default: 100) | 100 |
-### Config
-
-To choose the location of the YAML config file
-
-```bash
-python qbit_manage.py --config-file <path_to_config>
-```
-
-### Log
-
-To choose the location of the Log File
-
-```bash
-python qbit_manage.py --log-file <path_to_log>
-```
+## Support
+* 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).

VERSION

@@ -1 +1 @@
-2.2
+3.0.0

config/config.yml.sample

@@ -20,40 +20,30 @@ cat:
   movies: "/data/torrents/Movies"
   tv: "TV"
 
-# Tag Parameters (Use either Format 1 or Format 2)
+# Tag Parameters
 tags:
-  # Format 1
-  # <Tracker URL Keyword>: <Tag Name>
-  # Format 2
-  # <Tracker URL Keyword>:
+  # <Tracker URL Keyword>:    # <MANDATORY> This is the keyword in the tracker url
+  # <MANDATORY> Set tag name
   #   tag: <Tag Name>
-  # <MANDATORY> Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading. -2 means the global limit should be used, -1 means no limit.
+  # <OPTIONAL> Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading. -2 means the global limit should be used, -1 means no limit.
   #   max_ratio: 5.0
   # <OPTIONAL> Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding. -2 means the global limit should be used, -1 means no limit.
   #   max_seeding_time: 129600
   # <OPTIONAL> Will limit the upload speed KiB/s (KiloBytes/second) (-1 sets the limit to infinity)
   #   limit_upload_speed: 150
-
-  #Format 1 Examples
-  animebytes.tv: AnimeBytes
-  beyond-hd: Beyond-HD
-  blutopia: Blutopia
-  cartoonchaos: CartoonChaos
-  landof.tv: BroadcasTheNet
-  myanonamouse: MaM
-  passthepopcorn: PassThePopcorn
-  privatehd: PrivateHD
-  tleechreload: TorrentLeech
-  torrentdb: TorrentDB
-  torrentleech: TorrentLeech
-  tv-vault: TV-Vault
-
-  #Format 2 Examples
+  animebytes.tv:
+    tag: AnimeBytes
   avistaz:
     tag: Avistaz
     max_ratio: 5.0
     max_seeding_time: 129600
     limit_upload_speed: 150
+  beyond-hd:
+    tag: Beyond-HD
+  blutopia:
+    tag: Blutopia
+  cartoonchaos:
+    tag: CartoonChaos
   digitalcore
     tag: DigitalCore
     max_ratio: 5.0
@@ -63,6 +53,23 @@ tags:
   hdts:
     tag: HDTorrents
     max_seeding_time: 129600
+  landof.tv:
+    tag: BroadcasTheNet
+  myanonamouse:
+    tag: MaM
+  passthepopcorn:
+    tag: PassThePopcorn
+  privatehd:
+    tag: PrivateHD
+  tleechreload:
+    tag: TorrentLeech
+  torrentdb:
+    tag: TorrentDB
+  torrentleech:
+    tag: TorrentLeech
+  tv-vault:
+    tag: TV-Vault
+
 
 #Tag Movies/Series that are not hard linked
 nohardlinks: