qBitrr2 3.7.1__py3-none-any.whl

qBitrr2-3.7.1.dist-info/METADATA

@@ -0,0 +1,224 @@
+Metadata-Version: 2.1
+Name: qBitrr2
+Version: 3.7.1
+Summary: "A simple Python script to talk to qBittorrent and Arr's"
+Home-page: https://github.com/Feramance/qBitrr
+Author: Feramance
+Author-email: fera@fera.wtf
+License: MIT
+Project-URL: Issue Tracker, https://github.com/Feramance/qBitrr/issues
+Project-URL: Source Code, https://github.com/Feramance/qBitrr
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.8.1
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cachetools ==4.2.4
+Requires-Dist: colorama ==0.4.4
+Requires-Dist: coloredlogs ==15.0.1
+Requires-Dist: environ-config ==23.2.0
+Requires-Dist: ffmpeg-python ==0.2.0
+Requires-Dist: jaraco.docker ==2.0
+Requires-Dist: packaging ==21.3
+Requires-Dist: pathos ==0.2.8
+Requires-Dist: peewee ==3.14.7
+Requires-Dist: ping3 ==3.0.2
+Requires-Dist: pyarr ==5.2.0
+Requires-Dist: qbittorrent-api ==2023.7.52
+Requires-Dist: requests ==2.31.0
+Requires-Dist: tomlkit ==0.7.2
+Provides-Extra: all
+Requires-Dist: black ==22.1.0 ; extra == 'all'
+Requires-Dist: bump2version ==1.0.1 ; extra == 'all'
+Requires-Dist: isort ==5.10.1 ; extra == 'all'
+Requires-Dist: pip-tools ==7.3.0 ; extra == 'all'
+Requires-Dist: pre-commit ==3.3.3 ; extra == 'all'
+Requires-Dist: pyinstaller ==4.8 ; extra == 'all'
+Requires-Dist: pyupgrade ==2.31.0 ; extra == 'all'
+Requires-Dist: twine ==3.7.1 ; extra == 'all'
+Requires-Dist: ujson ==5.4.0 ; extra == 'all'
+Requires-Dist: upgrade-pip ==0.1.4 ; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: black ==22.1.0 ; extra == 'dev'
+Requires-Dist: bump2version ==1.0.1 ; extra == 'dev'
+Requires-Dist: isort ==5.10.1 ; extra == 'dev'
+Requires-Dist: pip-tools ==7.3.0 ; extra == 'dev'
+Requires-Dist: pre-commit ==3.3.3 ; extra == 'dev'
+Requires-Dist: pyinstaller ==4.8 ; extra == 'dev'
+Requires-Dist: pyupgrade ==2.31.0 ; extra == 'dev'
+Requires-Dist: twine ==3.7.1 ; extra == 'dev'
+Requires-Dist: ujson ==5.4.0 ; extra == 'dev'
+Requires-Dist: upgrade-pip ==0.1.4 ; extra == 'dev'
+Provides-Extra: fast
+Requires-Dist: ujson ==5.4.0 ; extra == 'fast'
+
+
+# qBitrr
+
+[![PyPI - License](https://img.shields.io/pypi/l/qbitrr)](https://github.com/Feramance/Qbitrr/blob/master/LICENSE)
+[![PyPI](https://img.shields.io/pypi/v/qBitrr2)](https://pypi.org/project/qBitrr2/)
+[![PyPI](https://img.shields.io/pypi/dm/qbitrr2)](https://pypi.org/project/qBitrr2/)
+[![Downloads](https://img.shields.io/github/downloads/feramance/qBitrr/total)](https://github.com/Feramance/qBitrr/releases/latest)
+[![Pulls](https://img.shields.io/docker/pulls/feramance/qbitrr.svg)](https://hub.docker.com/r/feramance/qbitrr)
+
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/qbitrr)
+![Platforms](https://img.shields.io/badge/platform-linux--64%20%7C%20osx--64%20%7C%20win--32%20%7C%20win--64-lightgrey)
+
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Feramance/qBitrr/master.svg)](https://results.pre-commit.ci/latest/github/Feramance/qBitrr/master)
+[![CodeQL](https://github.com/Feramance/qBitrr/actions/workflows/codeql.yml/badge.svg?branch=master)](https://github.com/Feramance/qBitrr/actions/workflows/codeql.yml)
+[![Create a Release](https://github.com/Feramance/qBitrr/actions/workflows/release.yml/badge.svg?branch=master)](https://github.com/Feramance/qBitrr/actions/workflows/release.yml)
+[![Update dockerhub](https://github.com/Feramance/qBitrr/actions/workflows/dockerhub-description.yml/badge.svg?branch=master)](https://github.com/Feramance/qBitrr/actions/workflows/dockerhub-description.yml)
+
+[![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+
+A simple script to monitor [qBit](https://github.com/qbittorrent/qBittorrent) and communicate with [Radarr](https://github.com/Radarr/Radarr) and [Sonarr](https://github.com/Sonarr/Sonarr)
+
+## Features
+
+- Monitor qBit for Stalled/bad entries and delete them then blacklist them on Arrs (Option to also trigger a re-search action).
+- Monitor qBit for completed entries and tell the appropriate Arr instance to import it:
+  - `qbitrr DownloadedMoviesScan` for Radarr
+  - `qbitrr DownloadedEpisodesScan` for Sonarr
+- Skip files in qBit entries by extension, folder or regex.
+- Monitor completed folder and clean it up.
+- Usage of [ffprobe](https://github.com/FFmpeg/FFmpeg){:target="_blank" rel="noopener noreferrer"} to ensure downloaded entries are valid media.
+- Trigger periodic Rss Syncs on the appropriate Arr instances.
+- Trigger Queue update on appropriate Arr instances.
+- Search requests from [Overseerr](https://github.com/sct/overseerr){:target="_blank" rel="noopener noreferrer"} or [Ombi](https://github.com/Ombi-app/Ombi){:target="_blank" rel="noopener noreferrer"}.
+- Auto add/remove trackers
+- Set per tracker values
+- **Sonarr v4 support**
+- **Radarr v4 and v5 support**
+- Available if provided with a Sonarr/Radarr database file:
+  - Monitor Arr's databases to trigger missing episode searches.
+  - Searches Radarr missing movies based on Minimum Availability
+  - Customizable searching by series or singular episodes
+  - Optionally searches year by year is ascending or descending order (config option available)
+
+## Tested with
+
+Some things to know before using it.
+
+- qBittorrent 4.5.x
+- [Sonarr](https://github.com/Sonarr/Sonarr) and [Radarr](https://github.com/Radarr/Radarr) both setup to add tags to all downloads.
+- qBit set to create sub-folders for tag.
+
+## Usage
+### Native
+
+- `python -m pip install qBitrr2` (I would recommend in a dedicated [venv](https://docs.python.org/3.3/library/venv.html) but that's out of scope.
+
+Alternatively:
+- Download on the [latest release](https://github.com/Drapersniper/Qbitrr/releases/latest)
+
+#### Run the script
+
+1. Activate your venv
+2. Run `qBitrr2`  to generate a config file
+3. Edit the config file (located at `~/config/config.toml` (~ is your current directory)
+4. Run `qBitrr2` if installed through pip again to start the script
+
+Alternatively:
+1. Unzip the downloaded release and run it
+2. Run `qBitrr`  to generate a config file
+3. Edit the config file (located at `~/config/config.toml` (~ is your current directory)
+4. Run `qBitrr` if installed through pip again to start the script
+
+#### How to update the script
+
+1. Activate your venv
+2. Run `python -m pip install -U qBitrr2`
+
+Alternatively:
+1. Download on the [latest release](https://github.com/Drapersniper/Qbitrr/releases/latest)
+2. Unzip the downloaded release and run it
+3. Run `qBitrr`  to generate a config file
+4. Edit the config file (located at `~/config/config.toml` (~ is your current directory)
+5. Run `qBitrr` if installed through pip again to start the script
+
+***There is no auto-update feature, you will need to manually download the latest release and replace the old one.***
+
+### Docker
+
+The docker image can be found [here](https://hub.docker.com/r/feramance/qbitrr)
+
+#### Docker Image
+
+- The docker image can be found [here](https://hub.docker.com/r/feramance/qbitrr)
+
+#### Docker Run
+
+```bash
+docker run -d \
+  --name=qbitrr \
+  -e TZ=Europe/London \
+  -v /etc/localtime:/etc/localtime:ro \
+  -v /path/to/appdata/qbitrr:/config \
+  -v /path/to/sonarr/db:/databases/sonarr.db:ro \
+  -v /path/to/radarr/db:/databases/radarr.db:ro \
+  -v /path/to/completed/downloads/folder:/completed_downloads:rw \
+  --restart unless-stopped \
+  feramance/qbitrr
+```
+
+#### Docker Compose
+
+```yaml
+version: "3"
+services:
+  qbitrr:
+    image: feramance/qbitrr
+    user: 1000:1000 # Required to ensure teh container is run as the user who has perms to see the 2 mount points and the ability to write to the CompletedDownloadFolder mount
+    tty: true # Ensure the output of docker-compose logs qBitrr are properly colored.
+    restart: unless-stopped
+    # networks: This container MUST share a network with your Sonarr/Radarr instances
+    environment:
+      - TZ=Europe/London
+    volumes:
+      - /etc/localtime:/etc/localtime:ro
+      - /path/to/appdata/qbitrr:/config  # Config folder for qBitrr
+      - /path/to/sonarr/db:/sonarr.db:ro # This is only needed if you want episode search handling :ro means it is only ever mounted as a read-only folder, the script never needs more than read access
+      - /path/to/radarr/db:/radarr.db:ro # This is only needed if you want movie search handling, :ro means it is only ever mounted as a read-only folder, the script never needs more than read access
+      - /path/to/completed/downloads/folder:/completed_downloads:rw # The script will ALWAYS require write permission in this folder if mounted, this folder is used to monitor completed downloads and if not present will cause the script to ignore downloaded file monitoring.
+      # Now just to make sure it is clean, when using this script in a docker you will need to ensure you config.toml values reflect the mounted folders.#
+      # For example, for your Sonarr.DatabaseFile value using the values above you'd add
+      # DatabaseFile = /sonarr.db/path/in/container/sonarr.db
+      # Because this is where you mounted it to
+      # The same would apply to Settings.CompletedDownloadFolder
+      # e.g CompletedDownloadFolder = /completed_downloads/folder/in/container
+
+    logging: # this script will generate a LOT of logs - so it is up to you to decide how much of it you want to store
+      driver: "json-file"
+      options:
+        max-size: "50m"
+        max-file: 3
+    depends_on: # Not needed but this ensures qBitrr only starts if the dependencies are up and running
+      - qbittorrent
+      - radarr-1080p
+      - radarr-4k
+      - sonarr-1080p
+      - sonarr-anime
+      - overseerr
+```
+
+##### Important mentions for docker
+
+- The script will always expect a completed config.toml file
+- When you first start the container a "config.rename_me.toml" will be added to `/path/to/appdata/qbitrr`
+  - Make sure to rename it to 'config.toml' then edit it to your desired values

qBitrr2-3.7.1.dist-info/RECORD

@@ -0,0 +1,20 @@
+qBitrr/__init__.py,sha256=dFFgQ04Lx3DCalHhP-qN4axRouRxcnAeWdPVdwSbJM0,382
+qBitrr/arr_tables.py,sha256=goMZaY12dwesj43NezVp6avsIe9RmOxwXQ4ZKBhqzTY,4633
+qBitrr/arss.py,sha256=mK_dK4nhzd9Bn5sHAtBEJimNaBjLyXdypcP6vqNA4mo,169928
+qBitrr/bundled_data.py,sha256=KdXU9ZOx3fQ2KpAhMhptYOTF1eIxTnlKmlxQ627ALZw,190
+qBitrr/config.py,sha256=tIxyp-SrEhfunlk-t4eYW7GpE8ECULULWByjW_31nyU,5328
+qBitrr/env_config.py,sha256=eH7SdPKWzSXob9d-BkSwHBCmlJfmG9vopAdXBeTaidU,2047
+qBitrr/errors.py,sha256=r6kMcL7Lag4QO4VwRN4WLvU_8Xh04gV1KTKEtIcp7yk,1147
+qBitrr/ffprobe.py,sha256=2IM0iuPPTEb0xHmN1OetQoBd80-Nmv5Oq7P6o-mjBd0,4019
+qBitrr/gen_config.py,sha256=ai9CXq8NG_Ybgtac-ixL7S1OdyHpb7AnJXla0EiOglE,28637
+qBitrr/home_path.py,sha256=W0sX_KDk0ncpUAVI5-tB0X7-FUegwfQ2SlJ2mw6UHHA,650
+qBitrr/logger.py,sha256=La3t0aeZUR8qAHAWnLh697dpSE-OoJTxxRzwAjLu1TQ,4360
+qBitrr/main.py,sha256=kVeZ0NgB8lWHkn02kxWGMT4E5MUL4rV6f2tySpll_Fs,7172
+qBitrr/tables.py,sha256=37-yLWykfuiKsGPwYdxVS0JD5rdODXIphkfkdmpEn5c,1724
+qBitrr/utils.py,sha256=iTuohmQc94vfx0xBKME-pmLHr0a-xnEWp1Ub0QQayxQ,5300
+qBitrr2-3.7.1.dist-info/LICENSE,sha256=sEUQyUWuHEHbHfMWogOU-ZMy3aQ4TUcGRd2CctwkOWM,1066
+qBitrr2-3.7.1.dist-info/METADATA,sha256=jjAPO9Xagn8-EtJzt5yHNJlyN7twSY421tIT1I0zad8,10774
+qBitrr2-3.7.1.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+qBitrr2-3.7.1.dist-info/entry_points.txt,sha256=MIR-l5s31VBs9qlv3HiAaMdpOOyy0MNGfM7Ib1-fKeQ,43
+qBitrr2-3.7.1.dist-info/top_level.txt,sha256=jIINodarzsPcQeTf-vvK8-_g7cQ8CvxEg41ms14K97g,7
+qBitrr2-3.7.1.dist-info/RECORD,,

qBitrr2-3.7.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

qBitrr2-3.7.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+qbitrr = qBitrr.main:run

qBitrr2-3.7.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+qBitrr