jonbranan / qbit-maid Goto Github PK

Qbittorrent cleaner that deletes torrents based on age, categories, domains and tags.

License: MIT License

Python 98.99% Dockerfile 0.55% Shell 0.46%

qbit-maid's Introduction

qbit-maid

Warning: This application removes torrents that are over the minimum age and that are not part of the ignored categories, domains or tags. Please use the delete_torrents feature set to false when first testing its functionality.

The objective is to remove torrents based on the following criteria:

tracker domain name
age
ratio
state

Install

Docker(Recommended)

package

docker pull git.jonb.io/jblu/qbit-maid:latest

Docker Run Command:

Please note it is best practice to escape spaces in variables. That is why there is backslashes in the cron schedule.

docker run --name qbit-maid -v /opt/qbit-maid:/config/ -e CRON=0\ 1\ *\ *\ * -e toml_path=/config/config.toml git.jonb.io/jblu/qbit-maid

Docker Compose

version: '3.3'
services:
    qbit-maid:
        image: git.jonb.io/jblu/qbit-maid
        container_name: qbit-maid
        volumes:
            - /opt/qbit-maid:/config
        environment:
            - CRON="0 1 * * *"
            - toml_path=/config/config.toml

Via Git

git clone https://git.jonb.io/jblu/qbit-maid.git

Qbit-maid will look for an environment variable toml_path for its configuration.If it doesn't find it, it will look for a config.toml file in it's own directory.

config.toml

[qbittorrent]
host = "192.168.x.x"
port = 8080
username = "user"
password = "pass"

[logging]
use_log = true
log_level = "INFO"
log_path = "./qc.log"

[app_tags]
protected_tag = "ipt"
non_protected_tag = "public"

[torrent]
age = 2419200
minimum_age = 432000
delete_torrents = false

[pushover]
use_pushover = false
po_key = "<key>>"
po_token = "<token>>"

[apprise]
use_apprise = false
host = "192.168.x.x"
port = 8088
aurls = 'mailto://user:[email protected]'

[dragnet]
enable_dragnet = false
dragnet_outfile = "./orphaned.csv"

[telemetry]
enable_telemetry = false
telemetry_outfile = "./telemetry.csv"

[ignored_categories]
tech = "tech"
books = "books"
general = "general"

[ignored_domains]
iptorrents-empirehost = "ssl.empirehost.me"
iptorrents-stackoverflow = "localhost.stackoverflow.tech"
iptorrents-bgp = "routing.bgp.technology"

[ignored_tags]
save = "save"

[healthcheck]
use_healthcheck = false
healthcheck_url = "https://example.com/ping/<uuid>>"

qbit-maid's People

Contributors

Watchers

qbit-maid's Issues

Add tag whitelisting

create a json config file for whitelisted tags

Add dragnet support to config.json along with a file path for output file

write a few test cases

refactor qprocess

improve premature logging

debug logger doesn't state which torrents are premature

change config.json.example to not use pushover by default

this prevents copy paste issues

allow unlimited trackers in tracker-whitelist.json

standardize variables

use the underscore variable naming convention

Test compatibility with python 3.11

fix torrent count

Research changing to a single toml configuration file

requirements.txt

python-pushover
qbittorrent-api

change the logging of torrent["name'] to the first 20 char followed by elipsis

items are not getting tagged on first run

state,ratio,tags,added,age,time,thash,tname
stalledUP,0.1585917538764331,,1662693375,2419200,1663174804.345229,34e31262616afce5c65ccdde46ba3b7b9977d503,BattleBots.2015.S07E
stalledUP,0.07426985163938096,,1663212386,2419200,1663693206.6041307,4677d08104c59f059447e08608cd44cde308fc61,Resident.Alien.S02E1
stalledUP,0,,1663056866,2419200,1663693206.6041307,46f542684dfd7a8f7b3f0bef8c3e9d27c43f1a09,Teen.Titans.Go.S07E4
stalledUP,0.04385293461288911,,1663496963,2419200,1663952405.4153898,58ab3ccb2c5a439e4efc3dfb7da130cc0967a7e6,An.American.Tail.Fie
stalledUP,0,,1663496426,2419200,1663952405.4153898,120d3ed7b8ea088a5186f888d27fb1a5ea2d5113,The.Land.Before.Time
stalledUP,8.763029711665166e-05,,1663460872,2419200,1663952405.4153898,8d50560e530f9d360053f3bcfb52c3bfd0e9e9cd,The.Ultimate.Playlis
stalledUP,4.185991002909566,,1663461109,2419200,1663952405.4153898,b5048b8e5e060e4e18adbdb0542393323e156391,Dragon.Ball.Super.Su
stalledUP,0,,1663496893,2419200,1663952405.431007,a8d3c2e396632aaafc2fcb37c7831273a684a183,An.American.Tail.198
stalledUP,0.28220987442517476,,1663817342,2419200,1664298005.447815,012be4cb5da9d1ccc530192cf4dbf64bcf4eb498,Resident.Alien.S02E1
stalledUP,0,,1664652794,2419200,1664902803.7582648,f3fef954cfa1ac65239dbecb0bf12d5773b7c94d,The.Martian.2015.Ext
uploading,5.603315036761439,,1664976688,2419200,1664989205.4843314,cc0ef18f69122b36e2f1e84b7770e2c8fac57ecf,Andor.S01E05.2160p.D
stalledUP,4.500323059003406e-05,,1664988341,2419200,1664989205.4843314,2b475eb91225b0f0b53ad3477754ad2cbb88e99d,[Erai-raws] Mob Psyc

update dragnet.csv headers when there is a schema change

move tags to config file

update dragnet to write tracker data

Review logic for an item with no tags

use with open to load config files

        with open('./config.json') as c:
            self.config = load(c)

When a torrent hasn't contacted the trackers, it's tracker is blank and gets tagged with a public tag

A torrent that had its data move got a tag public and ipt. Need a check to skip tagging if there is no tracker.