pywaybackup 1.2.5__tar.gz → 1.3.0__tar.gz

pywaybackup-1.3.0/.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,25 @@
+---
+name: Bug
+about: Describe a faulty behavior
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe**
+Describe the bug / unexpected event
+
+**Snapshot to reproduce**
+<a href="https://example.com">If possible add a link to the snapshot which caused the error.</a>
+
+**Command to reproduce**
+`Add the used command`
+
+**Terminal output**
+```
+Insert exception / output if possible - remove private folders / files
+```
+
+**Additional context**
+Add any other context about the problem here.

pywaybackup-1.3.0/.gitignore

@@ -0,0 +1,164 @@
+waybackup_snapshots/
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywaybackup
-Version: 1.2.5
+Version: 1.3.0
 Summary: Download snapshots from the Wayback Machine
 Home-page: https://github.com/bitdruid/python-wayback-machine-downloader
 Author: bitdruid
@@ -11,7 +11,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.31.0
 Requires-Dist: tqdm==4.66.2
-Requires-Dist: python-magic==0.4.27
+Requires-Dist: python-magic==0.4.27; sys_platform == "linux"
+Requires-Dist: python-magic-bin==0.4.14; sys_platform == "win32"
 
 # python wayback machine downloader
 
@@ -101,6 +102,10 @@ Path defaults to output-dir. Saves the result of CDX query as a file. Useful for
 - **`--cdxinject`** `<filepath>`:<br>
 Injects a CDX query file to download snapshots. Ensure the query matches the previous `--url` for correct folder structure.
 
+**Auto:**
+- **`--auto`**:<br>
+If set, csv, skip and cdxbackup/cdxinject are handled automatically. Keep the files and folders as they are. Otherwise they will not be recognized when restarting a download.
+
 ### Debug
 
 - `--debug`: If set, full traceback will be printed in case of an error. The full exception will be written into `waybackup_error.log`.

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/README.md

@@ -86,6 +86,10 @@ Path defaults to output-dir. Saves the result of CDX query as a file. Useful for
 - **`--cdxinject`** `<filepath>`:<br>
 Injects a CDX query file to download snapshots. Ensure the query matches the previous `--url` for correct folder structure.
 
+**Auto:**
+- **`--auto`**:<br>
+If set, csv, skip and cdxbackup/cdxinject are handled automatically. Keep the files and folders as they are. Otherwise they will not be recognized when restarting a download.
+
 ### Debug
 
 - `--debug`: If set, full traceback will be printed in case of an error. The full exception will be written into `waybackup_error.log`.

pywaybackup-1.3.0/dev/pip_build.sh

@@ -0,0 +1,16 @@
+#!bin/bash
+
+# path of the script
+SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+TARGET_PATH="$SCRIPT_PATH/.."
+
+# install dependencies
+pip install twine wheel setuptools
+
+# build 
+python $TARGET_PATH/setup.py sdist bdist_wheel --verbose
+python -m twine upload dist/*
+#pip install -e $TARGET_PATH
+
+# clean up
+rm -rf $TARGET_PATH/build $TARGET_PATH/dist # $TARGET_PATH/*.egg-info

pywaybackup-1.3.0/dev/venv_create.sh

@@ -0,0 +1,17 @@
+#!bin/bash
+
+# path of the script
+SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+TARGET_PATH="$SCRIPT_PATH/.."
+echo "Preparing virtual environment in $TARGET_PATH"
+# Create a virtual environment
+if [ ! -d "..$SCRIPT_PATH/.venv" ]; then
+    python3 -m venv "$TARGET_PATH/.venv"
+fi
+
+# update pip
+"$TARGET_PATH/.venv/bin/python" -m pip install --upgrade pip
+"$TARGET_PATH/.venv/bin/python" -m pip install twine wheel setuptools
+
+# install requirements
+"$TARGET_PATH/.venv/bin/python" -m pip install -r "$TARGET_PATH/requirements.txt"

pywaybackup-1.3.0/pywaybackup/__version__.py

@@ -0,0 +1 @@
+__version__ = "1.3.0"

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/pywaybackup/archive.py

@@ -97,26 +97,28 @@ def print_list():
 # create filelist
 # timestamp format yyyyMMddhhmmss
 def query_list(url: str, range: int, start: int, end: int, explicit: bool, mode: str, cdxbackup: str, cdxinject: str):
-    if cdxinject:
-        try:
+
+    def inject(cdxinject):
+        if os.path.isfile(cdxinject):
             vb.write("\nInjecting CDX data...")
             cdxResult = open(cdxinject, "r")
             cdxResult = cdxResult.read()
-            vb.write(f"\n-----> {len(cdxResult)} snapshots injected")
-        except FileNotFoundError as e:
-            vb.write("\nFILE NOT FOUND -> could not inject CDX data")
-            os._exit(1)
-    else:
+            linecount = cdxResult.count("\n") - 1
+            vb.write(f"\n-----> {linecount} snapshots injected")
+            return cdxResult
+        else:
+            vb.write("\nNo CDX file found to inject - querying snapshots...")
+            return False
+
+    def query(url, range, start, end, explicit):
         vb.write("\nQuerying snapshots...")
         query_range = ""
-        
         if not range:
             if start: query_range = query_range + f"&from={start}"
             if end: query_range = query_range + f"&to={end}"
         else: 
             query_range = "&from=" + str(datetime.now().year - range)
 
-        # parse user input url and create according cdx url
         domain, subdir, filename = url_split(url)
         if domain and not subdir and not filename:
             cdx_url = f"*.{domain}/*" if not explicit else f"{domain}"
@@ -142,6 +144,12 @@ def query_list(url: str, range: int, start: int, end: int, explicit: bool, mode:
                 file.write(cdxResult)
                 vb.write("\n-----> CDX backup generated")
 
+        return cdxResult
+
+    if cdxinject:
+        cdxResult = inject(cdxinject)
+    if not cdxResult:
+        cdxResult = query(url, range, start, end, explicit)
     cdxResult = json.loads(cdxResult)
     sc.create_list(cdxResult, mode)
     vb.write(f"\n-----> {sc.count(collection=True)} snapshots to utilize")
@@ -382,15 +390,15 @@ def csv_close(csv_path: str, url: str):
         if sc.count(collection=True) > 0:
             if os.path.exists(csv_path): # append to existing file
                 existing_rows = set()
-                with open(csv_path, mode='r') as file: # read existing rows
+                with open(csv_path, mode='r', newline='') as file: # read existing rows
                     existing_rows = set(csv_read(file))
-                with open(csv_path, mode='a') as file: # append new rows
+                with open(csv_path, mode='a', newline='') as file: # append new rows
                     row = csv.DictWriter(file, sc.SNAPSHOT_COLLECTION[0].keys())
                     for snapshot in sc.SNAPSHOT_COLLECTION:
                         if snapshot["response"] is not False and snapshot["url_archive"] not in existing_rows: # only append handled snapshots
                             row.writerow(snapshot)
             else: # create new file
-                with open(csv_path, mode='w') as file:
+                with open(csv_path, mode='w', newline='') as file:
                     row = csv.DictWriter(file, sc.SNAPSHOT_COLLECTION[0].keys())
                     row.writeheader()
                     for snapshot in sc.SNAPSHOT_COLLECTION:

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/pywaybackup/arguments.py

@@ -36,6 +36,9 @@ def parse():
     exclusive_cdx.add_argument('--cdxbackup', type=str, nargs='?', const=True, metavar='path', help='Save the cdx query-result to a file for recurent use - defaults to output folder')
     exclusive_cdx.add_argument('--cdxinject', type=str, nargs='?', const=True, metavar='path', help='Inject a cdx backup-file to download according to the given url')
 
+    auto = parser.add_argument_group('auto')
+    auto.add_argument('--auto', action='store_true', help='includes automatic csv, skip and cdxbackup/cdxinject to resume a stopped download')
+
     args = parser.parse_args(args=None if sys.argv[1:] else ['--help']) # if no arguments are given, print help
     command = ' '.join(sys.argv[1:])
 

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/pywaybackup/main.py

@@ -2,6 +2,7 @@ import os
 
 import signal
 
+import pywaybackup.helper as helper
 import pywaybackup.archive as archive
 
 from pywaybackup.arguments import parse
@@ -25,14 +26,20 @@ def main():
     if args.current:
         mode = "current"
 
-    if args.skip is True:
+    if args.auto:
         args.skip = args.output
-    if args.csv is True:
         args.csv = args.output
-    if args.cdxbackup is True:
         args.cdxbackup = args.output
-    if args.cdxinject is True:
-        args.cdxinject = args.output
+        args.cdxinject = os.path.join(args.output, f"waybackup_{helper.sanitize_filename(args.url)}.cdx")
+    else:
+        if args.skip is True:
+            args.skip = args.output
+        if args.csv is True:
+            args.csv = args.output
+        if args.cdxbackup is True:
+            args.cdxbackup = args.output
+        if args.cdxinject is True:
+            args.cdxinject = args.output
 
     if args.save:
         archive.save_page(args.url)

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/pywaybackup.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pywaybackup
-Version: 1.2.5
+Version: 1.3.0
 Summary: Download snapshots from the Wayback Machine
 Home-page: https://github.com/bitdruid/python-wayback-machine-downloader
 Author: bitdruid
@@ -11,7 +11,8 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests==2.31.0
 Requires-Dist: tqdm==4.66.2
-Requires-Dist: python-magic==0.4.27
+Requires-Dist: python-magic==0.4.27; sys_platform == "linux"
+Requires-Dist: python-magic-bin==0.4.14; sys_platform == "win32"
 
 # python wayback machine downloader
 
@@ -101,6 +102,10 @@ Path defaults to output-dir. Saves the result of CDX query as a file. Useful for
 - **`--cdxinject`** `<filepath>`:<br>
 Injects a CDX query file to download snapshots. Ensure the query matches the previous `--url` for correct folder structure.
 
+**Auto:**
+- **`--auto`**:<br>
+If set, csv, skip and cdxbackup/cdxinject are handled automatically. Keep the files and folders as they are. Otherwise they will not be recognized when restarting a download.
+
 ### Debug
 
 - `--debug`: If set, full traceback will be printed in case of an error. The full exception will be written into `waybackup_error.log`.

{pywaybackup-1.2.5 → pywaybackup-1.3.0}/pywaybackup.egg-info/SOURCES.txt

@@ -1,6 +1,11 @@
+.gitignore
 LICENSE
 README.md
+requirements.txt
 setup.py
+.github/ISSUE_TEMPLATE/bug.md
+dev/pip_build.sh
+dev/venv_create.sh
 pywaybackup/Exception.py
 pywaybackup/SnapshotCollection.py
 pywaybackup/Verbosity.py
@@ -15,4 +20,7 @@ pywaybackup.egg-info/SOURCES.txt
 pywaybackup.egg-info/dependency_links.txt
 pywaybackup.egg-info/entry_points.txt
 pywaybackup.egg-info/requires.txt
-pywaybackup.egg-info/top_level.txt
+pywaybackup.egg-info/top_level.txt
+test/cdx.example.com.200
+test/cdx.example.com.404
+test/cdx.example.com.small.200

pywaybackup-1.3.0/pywaybackup.egg-info/requires.txt

@@ -0,0 +1,8 @@
+requests==2.31.0
+tqdm==4.66.2
+
+[:sys_platform == "linux"]
+python-magic==0.4.27
+
+[:sys_platform == "win32"]
+python-magic-bin==0.4.14

pywaybackup-1.3.0/requirements.txt

@@ -0,0 +1,4 @@
+requests==2.31.0
+tqdm==4.66.2
+python-magic==0.4.27; sys_platform == 'linux'
+python-magic-bin==0.4.14; sys_platform == 'win32'