From 1e5db77a6b1204558367ea359e85bd6a698f041b Mon Sep 17 00:00:00 2001 From: jblu Date: Wed, 20 Jul 2022 12:11:19 -0500 Subject: [PATCH] Better file explanations --- README.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 3551b55..7df9057 100644 --- a/README.md +++ b/README.md @@ -8,17 +8,22 @@ The objective is to filter torrents based on the following criteria: - ratio - state -Client to the qbit api and the processing of the torrents. -qbit-clean.py +```mermaid +graph TD; + qbit-maid.py-->qlogging.py; + qbit-maid.py-->qlist.py; + qbit-maid.py-->qprocess.py; + qlogging.py-->qbit-maid.py; + qlist.py-->qbit-maid.py; + qprocess.py-->qbit-maid.py; +``` -Functions to build out a list of torrents. -qlist.py - -Logging and push notification communication. -qlogging.py - -Logic to process torrents. -qprocess.py +| File | Purpose | +| --- | --- | +| qbit-maid.py - Client to the qbit api and calls functions from the other files | +| qlist.py - Builds out torrent lists | +| qlogging.py - Logging and push notification communication | +| qprocess.py - Submits qualifying torrents for deletion | You will need a config.json in the root directory.