Add descriptions and rename

bin/add_scihub_torrents.py

@@ -1,14 +1,23 @@
 #!/usr/bin/env python3
 
-"""add-scihub-torrents
+"""add_scihub_torrents.py
+
+Description:
+Choose from a list of paginated Sci Hub torrent URL files and add each
+URL to a qBittorrent instance.
+
+This script expects a ~/scihub-torrent-urls directory to exist and be
+populated by running the following commands from the justfile in this
+repository:
+    $ just scihub-setup
     
 Usage:
-    add-scihub-torrents (HOSTNAME) (USERNAME) (PASSWORD)
+    add_scihub_torrents.py (HOSTNAME) (USERNAME) (PASSWORD)
-    add-scihub-torrents -h
+    add_scihub_torrents.py -h
 
 Examples:
-    add-scihub-torrents "http://localhost:8080" "admin" "adminadmin"
+    add_scihub_torrents.py "http://localhost:8080" "admin" "adminadmin"
-    add-scihub-torrents "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw"
+    add_scihub_torrents.py "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw"
 
 Options:
     -h, --help      show this help message and exit

bin/qbt_sum_size.py

@@ -1,14 +1,18 @@
 #!/usr/bin/env python3
 
-"""qbt-sum-size
+"""qbt_sum_size.py
+
+Description:
+Get the total size of all added torrents and the total size of all completed 
+torrents from a qBittorrent instance.
 
 Usage:
-    qbt-sum-size (HOSTNAME) (USERNAME) (PASSWORD)
+    qbt_sum_size.py (HOSTNAME) (USERNAME) (PASSWORD)
-    qbt-sum-size -h
+    qbt_sum_size.py -h
 
 Examples:
-    qbt-sum-size "http://localhost:8080" "admin" "adminadmin"
+    qbt_sum_size.py "http://localhost:8080" "admin" "adminadmin"
-    qbt-sum-size "https://cat.seedhost.eu/lol/qbittorrent" "lol" "supersecretpassword"
+    qbt_sum_size.py "https://cat.seedhost.eu/lol/qbittorrent" "lol" "supersecretpassword"
 
 Options:
     -h, --help      show this help message and exit

bin/qbth.py

@@ -1,14 +1,14 @@
 #!/usr/bin/env python3
 
-"""qbth - qbittorrent helper
+"""qbth.py - qbittorrent helper
 
 Usage:
-    qbth (HOSTNAME) (USERNAME) (PASSWORD)
+    qbth.py (HOSTNAME) (USERNAME) (PASSWORD)
-    qbth -h
+    qbth.py -h
 
 Examples:
-    qbth "http://localhost:8080" "admin" "adminadmin"
+    qbth.py "http://localhost:8080" "admin" "adminadmin"
-    qbth "https://cat.seedhost.eu/lol/qbittorrent" "lol" "meow"
+    qbth.py "https://cat.seedhost.eu/lol/qbittorrent" "lol" "meow"
 
 Options:
     -h, --help      show this help message and exit

bin/seed_armbian_torrents.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-"""seed_armbian_torrents
+"""seed_armbian_torrents.py
 
 Description:
 Armbian torrents seed script
@@ -12,12 +12,12 @@ This is a Python implementation of https://docs.armbian.com/Community_Torrent/
 for qBittorrent.
 
 Usage:
-    seed_armbian_torrents (HOSTNAME) (USERNAME) (PASSWORD)
+    seed_armbian_torrents.py (HOSTNAME) (USERNAME) (PASSWORD)
-    seed_armbian_torrents -h
+    seed_armbian_torrents.py -h
 
 Examples:
-    seed_armbian_torrents "http://localhost:8080" "admin" "adminadmin"
+    seed_armbian_torrents.py "http://localhost:8080" "admin" "adminadmin"
-    seed_armbian_torrents "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw"
+    seed_armbian_torrents.py "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw"
 
 Options:
     -h, --help         show this help message and exit.

bin/seed_scihub_max_seeders.py

@@ -1,14 +1,20 @@
 #!/usr/bin/env python3
 
-"""seed_scihub_torrents
+"""seed_scihub_max_seeders.py
+
+Description:
+Find Sci Hub torrents containing MAX_SEEDERS seeders and add them to a qBittorrent
+instance.
+
+MAX_SEEDERS is a positive integer argument.
 
 Usage:
-    seed_scihub_torrents (HOSTNAME) (USERNAME) (PASSWORD) (MAX_SEEDERS)
+    seed_scihub_max_seeders.py (HOSTNAME) (USERNAME) (PASSWORD) (MAX_SEEDERS)
-    seed_scihub_torrents -h
+    seed_scihub_max_seeders.py -h
 
 Examples:
-    seed_scihub_torrents "http://localhost:8080" "admin" "adminadmin" 4
+    seed_scihub_max_seeders.py "http://localhost:8080" "admin" "adminadmin" 4
-    seed_scihub_torrents "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw" 8
+    seed_scihub_max_seeders.py "https://cat.seedhost.eu/lol/qbittorrent" "lol" "pw" 3
 
 Options:
     -h, --help      show this help message and exit