rewrite with classes

Author: bitdruid

README.md

@@ -11,6 +11,17 @@ Internet-archive is a nice source for several OSINT-information. This tool is a
 
 This tool allows you to download content from the Wayback Machine (archive.org). You can use it to download either the latest version or all versions of web page snapshots within a specified range.
 
+# Content
+
+➡️ [Installation](#installation) <br>
+➡️ [notes / issues / hints](#notes--issues--hints) <br>
+➡️ [import](#import) <br>
+➡️ [cli](#cli) <br>
+➡️ [Usage](#usage) <br>
+➡️ [Examples](#examples) <br>
+➡️ [Output](#output) <br>
+➡️ [Contributing](#contributing) <br>
+
 ## Installation
 
 ### Pip
@@ -43,8 +54,14 @@ This tool allows you to download content from the Wayback Machine (archive.org).
 You can import pywaybackup into your own scripts and run it. Args are the same as cli.
 
 Additional args:
-- `silent` (default True): If True, suppresses all output to the console.
-- `debug` (default False): If True, disables writing errors to the error log file.
+- `silent` (default False): If True, suppresses all output to the console.
+- `debug` (default True): If False, disables writing errors to the error log file.
+
+Use:
+- `run()`
+- `status()`
+- `paths()`
+- `stop()`
 
 ```python
 from pywaybackup import PyWayBackup
@@ -76,6 +93,29 @@ output:
 }
 ```
 
+... or run it asynchronously and print the current status or stop it whenever needed.
+
+```python
+import time
+from pywaybackup import PyWayBackup
+
+backup = PyWayBackup( ... )
+backup.run(daemon=True)
+print(backup.status())
+time.sleep(10)
+print(backup.status())
+backup.stop()
+```
+output:
+```bash
+{
+  'task': 'downloading snapshots',
+  'current': 15,
+  'total': 84,
+  'progress': '18%'
+}
+```
+
 ## cli
 
 - `-h`, `--help`: Show the help message and exit.

pyproject.toml

@@ -7,7 +7,7 @@ packages = ["pywaybackup"]
 
 [project]
 name = "pywaybackup"
-version = "3.4.1"
+version = "4.0.0"
 description = "Query and download archive.org as simple as possible."
 authors = [
     { name = "bitdruid", email = "[email protected]" }

pywaybackup/Arguments.py

@@ -24,8 +24,8 @@ def __init__(self):
         optional = parser.add_argument_group("optional query parameters")
         optional.add_argument("-e", "--explicit", action="store_true", help="search only for the explicit given url")
         optional.add_argument("-r", "--range", type=int, metavar="", help="range in years to search")
-        optional.add_argument("--start", type=int, metavar="", help="start timestamp format: YYYYMMDDhhmmss")
-        optional.add_argument("--end", type=int, metavar="", help="end timestamp format: YYYYMMDDhhmmss")
+        optional.add_argument("--start", type=int, metavar="", help="start timestamp format: YYYYMMDDHHMMSS")
+        optional.add_argument("--end", type=int, metavar="", help="end timestamp format: YYYYMMDDHHMMSS")
         optional.add_argument("--limit", type=int, nargs="?", const=True, metavar="int", help="limit the number of snapshots to download")
         optional.add_argument("--filetype", type=str, metavar="", help="filetypes to download comma separated (js,css,...)")
         optional.add_argument("--statuscode", type=str, metavar="", help="statuscodes to download comma separated (200,404,...)")
@@ -55,3 +55,4 @@ def __init__(self):
     def get_args(self) -> dict:
         """Returns the parsed arguments as a dictionary."""
         return vars(self.args)
+

pywaybackup/Exception.py

@@ -14,9 +14,9 @@ class Exception:
     command = None
 
     @classmethod
-    def init(cls, debug=None, output=None, command=None):
+    def init(cls, debugfile=None, output=None, command=None):
         sys.excepthook = cls.exception_handler  # set custom exception handler (uncaught exceptions)
-        cls.debug = debug
+        cls.debugfile = debugfile
         cls.output = output
         cls.command = command
 
@@ -45,18 +45,18 @@ def exception(cls, message: str, e: Exception, tb=None):
             exception_message += "!-- Traceback is None\n"
         exception_message += f"!-- Description: {e}\n-------------------------"
         print(exception_message)
-        if cls.debug:
-            print(f"Exception log: {cls.debug}")
+        if cls.debugfile:
+            print(f"Exception log: {cls.debugfile}")
             if cls.new_debug:  # new run, overwrite file
                 cls.new_debug = False
-                f = open(cls.debug, "w", encoding="utf-8")
+                f = open(cls.debugfile, "w", encoding="utf-8")
                 f.write("-------------------------\n")
                 f.write(f"Version: {version('pywaybackup')}\n")
                 f.write("-------------------------\n")
                 f.write(f"Command: {cls.command}\n")
                 f.write("-------------------------\n\n")
             else:  # current run, append to file
-                f = open(cls.debug, "a", encoding="utf-8")
+                f = open(cls.debugfile, "a", encoding="utf-8")
             f.write(datetime.now().strftime("%Y-%m-%d %H:%M:%S") + "\n")
             f.write(exception_message + "\n")
             f.write("!-- Local Variables:\n")
@@ -96,4 +96,4 @@ def exception_handler(exception_type, exception, traceback):
         if issubclass(exception_type, KeyboardInterrupt):
             sys.__excepthook__(exception_type, exception, traceback)
             return
-        Exception.exception("UNCAUGHT EXCEPTION", exception, traceback)  # uncaught exceptions also with custom scheme
+        Exception.exception('UNCAUGHT EXCEPTION', exception, traceback)  # uncaught exceptions also with custom scheme