Adds new command share_limits to update share limits based on tags/categories specified per group

(Closes #88, Closes #306, Closes #259, Closes #308, Closes #137)

Author: bobokun

CHANGELOG

@@ -1,8 +1,16 @@
 # Requirements Updated
-- Updates ruamel.yaml to 0.17.27
+- Updates ruamel.yaml to 0.17.30
+- Updates qbitorrent-api to 2023.5.48
+
+# New Features
+- Adds new command `share_limits`, `--share-limits` , `QBT_SHARE_LIMITS=True` to update share limits based on tags/categories specified per group (Closes #88, Closes #306, Closes #259, Closes #308, Closes #137)
+- Adds new command `skip_qb_version_check`, `--skip-qb-version-check`, `QBT_SKIP_QB_VERSION_CHECK` to bypass qbitorrent compatibility check (unsupported - Thanks to @ftc2 #307)
+# Breaking Changes
+- `tag_nohardlinks` only updates/removes `noHL` tag. It does not modify or cleanup share_limits anymore.
+- `tag_update` only adds tracker tags to torrent. It does not modify or cleanup share_limits anymore.
+- Please remove any references to share_limits from your configuration in the tracker/nohardlinks section
 
 # Bug Fixes
 - Fixes #302
-- Adds a way to bypass qbt version check (unsupported - Thanks to @ftc2 #307)
 
-**Full Changelog**: https://github.com/StuffAnThings/qbit_manage/compare/v3.6.3...v3.6.4
+**Full Changelog**: https://github.com/StuffAnThings/qbit_manage/compare/v3.6.3...v3.7.0

VERSION

@@ -1 +1 @@
-3.6.4-develop1
+3.6.4-develop2

config/config.yml.sample

@@ -14,6 +14,8 @@ commands:
   tag_tracker_error: False
   rem_orphaned: False
   tag_nohardlinks: False
+  share_limits: False
+  skip_qb_version_check: False
   skip_cleanup: False
 
 qbt:
@@ -26,6 +28,7 @@ settings:
   force_auto_tmm: False  # Will force qBittorrent to enable Automatic Torrent Management for each torrent.
   tracker_error_tag: issue  # Will set the tag of any torrents that do not have a working tracker.
   nohardlinks_tag: noHL # Will set the tag of any torrents with no hardlinks.
+  share_limits_suffix_tag: share_limit # Will add this suffix to the grouping separated by '.' to the tag of any torrents with share limits.
   ignoreTags_OnUpdate: # When running tag-update function, it will update torrent tags for a given torrent even if the torrent has at least one or more of the tags defined here. Otherwise torrents will not be tagged if tags exist.
     - noHL
     - issue
@@ -68,14 +71,6 @@ tracker:
   # <Tracker URL Keyword>:    # <MANDATORY> This is the keyword in the tracker url
   # <MANDATORY> Set tag name. Can be a list of tags or a single tag
   #   tag: <Tag Name>
-  # <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 ensure that noHL torrents from this tracker are not deleted by cleanup variable if torrent has not yet met the minimum seeding time (min).
-  #   min_seeding_time: 2000
-  # <OPTIONAL> Will limit the upload speed KiB/s (KiloBytes/second) (-1 means no limit)
-  #   limit_upload_speed: 150
   # <OPTIONAL> Set this to the notifiarr react name. This is used to add indexer reactions to the notifications sent by Notifiarr
   #   notifiarr: <notifiarr indexer>
   animebytes.tv:
@@ -86,10 +81,6 @@ tracker:
       - Avistaz
       - tag2
       - tag3
-    max_ratio: 5.0
-    max_seeding_time: 129600
-    min_seeding_time: 30400
-    limit_upload_speed: 150
     notifiarr: avistaz
   beyond-hd:
     tag: [Beyond-HD, tag2, tag3]
@@ -101,14 +92,11 @@ tracker:
     tag: CartoonChaos
   digitalcore:
     tag: DigitalCore
-    max_ratio: 5.0
     notifiarr: digitalcore
   gazellegames:
     tag: GGn
-    limit_upload_speed: 150
   hdts:
     tag: HDTorrents
-    max_seeding_time: 129600
   landof.tv:
     tag: BroadcasTheNet
     notifiarr: broadcasthenet
@@ -145,48 +133,66 @@ nohardlinks:
       - Beyond-HD
       - AnimeBytes
       - MaM
-    # <OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that have a noHL tag and meets share limits
-    cleanup: false
-    # <OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading.
-    # Delete this key from a category's config to use the tracker's configured max_ratio. Will default to -1 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
-    max_ratio: 4.0
-    # <OPTIONAL> max seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding.
-    # Delete this key from a category's config to use the tracker's configured max_seeding_time. Will default to -1 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
-    max_seeding_time: 86400
-    # <OPTIONAL> Limit Upload Speed var: Will limit the upload speed KiB/s (KiloBytes/second) (`-1` : No Limit)
-    limit_upload_speed:
-    # <OPTIONAL> min seeding time var: Will prevent torrent deletion by cleanup variable if torrent has not yet minimum seeding time (min).
-    # Delete this key from a category's config to use the tracker's configured min_seeding_time. Will default to 0 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
-    min_seeding_time: 43200
-    # <OPTIONAL> resume_torrent_after_untagging_noHL var: If a torrent was previously tagged as NoHL and now has hardlinks, this variable will resume your torrent after changing share limits
-    resume_torrent_after_untagging_noHL: false
   # Can have additional categories set with separate ratio/seeding times defined.
   series-completed:
     # <OPTIONAL> exclude_tags var: Will exclude torrents with any of the following tags when searching through the category.
     exclude_tags:
       - Beyond-HD
       - BroadcasTheNet
-    # <OPTIONAL> cleanup var: WARNING!! Setting this as true Will remove and delete contents of any torrents that have a noHL tag and meets share limits
-    cleanup: false
-    # <OPTIONAL> max_ratio var: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading.
-    # Delete this key from a category's config to use the tracker's configured max_ratio. Will default to -1 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
-    max_ratio: 4.0
-    # <OPTIONAL> max seeding time var: Will set the torrent Maximum seeding time (min) until torrent is stopped from seeding.
-    # Delete this key from a category's config to use the tracker's configured max_seeding_time. Will default to -1 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
-    max_seeding_time: 86400
-    # <OPTIONAL> Limit Upload Speed var: Will limit the upload speed KiB/s (KiloBytes/second) (`-1` : No Limit)
-    limit_upload_speed:
-    # <OPTIONAL> min seeding time var: Will prevent torrent deletion by cleanup variable if torrent has not yet minimum seeding time (min).
-    # Delete this key from a category's config to use the tracker's configured min_seeding_time. Will default to 0 if not specified for the category or tracker.
-    # Uses the larger value of the noHL Category or Tracker specific setting.
+
+share_limits:
+# Control how torrent share limits are set depending on the priority of your grouping
+# This variable is mandatory and is a text defining the name of your grouping. This can be any string you want
+  noHL:
+    # <MANDATORY> priority: <int/float> # This is the priority of your grouping. The lower the number the higher the priority
+    priority: 1
+    # <OPTIONAL> tags: <list> # Filter the group based on one or more tags. Multiple tags are checked with an AND condition
+    tags:
+    - noHL
+    # <OPTIONAL> exclude_tags: <list> # Filter by excluding one or more tags. Multiple exclude_tags are checked with an AND condition
+    # This is useful to combine with the category filter to exclude one or more tags from an entire category
+    exclude_tags:
+    - Beyond-HD
+    # <OPTIONAL> categories: <list> # Filter by excluding one or more categories. Multiple exclude_tags are checked with an OR condition
+    # Since one torrent can only be associated with a single category, multiple categories are checked with an OR condition
+    categories:
+    - RadarrComplete
+    - SonarrComplete
+    # <OPTIONAL> max_ratio <float>: Will set the torrent Maximum share ratio until torrent is stopped from seeding/uploading.
+    # Delete this key from a category's config to use the tracker's configured max_ratio. Will default to -1 if not specified for the group.
+    max_ratio: 5.0
+    # <OPTIONAL> max_seeding_time <int>: Will set the torrent Maximum seeding time (minutes) until torrent is stopped from seeding.
+    # Delete this key from a category's config to use the tracker's configured max_seeding_time. Will default to -1 if not specified for the group.
+    max_seeding_time: 129600
+    # <OPTIONAL> min_seeding_time <int>: Will prevent torrent deletion by cleanup variable if torrent has not yet minimum seeding time (minutes).
+    # Delete this key from a category's config to use the tracker's configured min_seeding_time. Will default to 0 if not specified for the group.
     min_seeding_time: 43200
-    # <OPTIONAL> resume_torrent_after_untagging_noHL var: If a torrent was previously tagged as NoHL and now has hardlinks, this variable will resume your torrent after changing share limits
-    resume_torrent_after_untagging_noHL: false
+    # <OPTIONAL> Limit Upload Speed <int>: Will limit the upload speed KiB/s (KiloBytes/second) (`-1` : No Limit)
+    limit_upload_speed: 0
+    # <OPTIONAL> cleanup <bool>: WARNING!! Setting this as true Will remove and delete contents of any torrents that satisfies the share limits
+    cleanup: false
+    # <OPTIONAL> resume_torrent_after_change <bool>: This variable will resume your torrent after changing share limits. Default is true
+    resume_torrent_after_change: true
+    # <OPTIONAL> add_group_to_tag <bool>: This adds your grouping as a tag with a suffix defined in settings . Default is true
+    # Example: A grouping defined as noHL will have a tag set to noHL.share_limit (if using the default suffix)
+    add_group_to_tag: true
+  cross-seed:
+    priority: 2
+    tags: cross-seed
+    max_seeding_time: 10200
+    cleanup: false
+  PTP:
+    priority: 3
+    tags:
+    - PassThePopcorn
+    max_ratio: 2.0
+    max_seeding_time: 130000
+    cleanup: false
+  default:
+    priority: 999
+    max_ratio: -1
+    max_seeding_time: -1
+    cleanup: false
 
 recyclebin:
   # Recycle Bin method of deletion will move files into the recycle bin (Located in /root_dir/.RecycleBin) instead of directly deleting them in qbit

modules/apprise.py

@@ -1,4 +1,6 @@
 """Apprise notification class"""
+import time
+
 from modules import util
 from modules.util import Failed
 
@@ -14,5 +16,6 @@ def __init__(self, config, params):
         logger.secret(self.api_url)
         self.notify_url = ",".join(params["notify_url"])
         response = self.config.get(self.api_url)
+        time.sleep(1)  # Pause for 1 second before sending the next request
         if response.status_code != 200:
             raise Failed(f"Apprise Error: Unable to connect to Apprise using {self.api_url}")