NGPIris 5.2.3.dev1__tar.gz → 5.3.0__tar.gz

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/NGPIris/cli/__init__.py

@@ -90,8 +90,14 @@ def cli(context : Context, credentials : str, debug : bool):
 @click.argument("bucket")
 @click.argument("source")
 @click.argument("destination")
+@click.option(
+    "-dr", 
+    "--dry_run", 
+    help = "Simulate the command execution without making actual changes. Useful for testing and verification", 
+    is_flag = True
+)
 @click.pass_context
-def upload(context : Context, bucket : str, source : str, destination : str):
+def upload(context : Context, bucket : str, source : str, destination : str, dry_run : bool):
     """
     Upload files to an HCP bucket/namespace. 
     
@@ -106,11 +112,17 @@ def upload(context : Context, bucket : str, source : str, destination : str):
     destination = add_trailing_slash(destination)
     if Path(source).is_dir():
         source = add_trailing_slash(source)
-        hcph.upload_folder(source, destination)
+        if dry_run:
+            click.echo("This command would have uploaded the folder \"" + source + "\" to \"" + destination + "\"")
+        else:
+            hcph.upload_folder(source, destination)
     else:
         file_name = Path(source).name
         destination += file_name
-        hcph.upload_file(source, destination)
+        if dry_run:
+            click.echo("This command would have uploaded the file \"" + source + "\" to \"" + destination + "\"")
+        else:
+            hcph.upload_file(source, destination)
 
 @cli.command()
 @click.argument("bucket")
@@ -128,8 +140,14 @@ def upload(context : Context, bucket : str, source : str, destination : str):
     help = "Ignore the download limit", 
     is_flag = True
 )
+@click.option(
+    "-dr", 
+    "--dry_run", 
+    help = "Simulate the command execution without making actual changes. Useful for testing and verification", 
+    is_flag = True
+)
 @click.pass_context
-def download(context : Context, bucket : str, source : str, destination : str, force : bool, ignore_warning : bool):
+def download(context : Context, bucket : str, source : str, destination : str, force : bool, ignore_warning : bool, dry_run : bool):
     """
     Download a file or folder from an HCP bucket/namespace.
 
@@ -143,45 +161,58 @@ def download(context : Context, bucket : str, source : str, destination : str, f
     hcph.mount_bucket(bucket)
     if not Path(destination).exists():
         Path(destination).mkdir()
-    
-    if object_is_folder(source, hcph):
-        if source == "/":
-            source = ""
-
-        cumulative_download_size = Byte(0)
-        if not ignore_warning:
-            click.echo("Computing download size...")
-            for object in hcph.list_objects(source):
-                object : dict
-                cumulative_download_size += Byte(object["Size"])
-                if cumulative_download_size >= TiB(1):
-                    click.echo("WARNING: You are about to download more than 1 TB of data. Is this your intention? [y/N]: ", nl = False)
-                    inp = click.getchar(True)
-                    if inp == "y" or inp == "Y":
-                        break
-                    else: # inp == "n" or inp == "N" or something else
-                        exit("\nAborting download")
-    
-        hcph.download_folder(source, Path(destination).as_posix())
+
+    if not dry_run:
+        if object_is_folder(source, hcph):
+            if source == "/":
+                source = ""
+
+            cumulative_download_size = Byte(0)
+            if not ignore_warning:
+                click.echo("Computing download size...")
+                for object in hcph.list_objects(source):
+                    object : dict
+                    cumulative_download_size += Byte(object["Size"])
+                    if cumulative_download_size >= TiB(1):
+                        click.echo("WARNING: You are about to download more than 1 TB of data. Is this your intention? [y/N]: ", nl = False)
+                        inp = click.getchar(True)
+                        if inp == "y" or inp == "Y":
+                            break
+                        else: # inp == "n" or inp == "N" or something else
+                            exit("\nAborting download")
+        
+            hcph.download_folder(source, Path(destination).as_posix())
+        else: 
+            if Byte(hcph.get_object(source)["ContentLength"]) >= TiB(1):
+                click.echo("WARNING: You are about to download more than 1 TB of data. Is this your intention? [y/N]: ", nl = False)
+                inp = click.getchar(True)
+                if inp == "y" or inp == "Y":
+                    pass
+                else: # inp == "n" or inp == "N" or something else
+                    exit("\nAborting download")
+
+            downloaded_source = Path(destination) / Path(source).name
+            if downloaded_source.exists() and not force:
+                exit("Object already exists. If you wish to overwrite the existing file, use the -f, --force option")
+            hcph.download_file(source, downloaded_source.as_posix())
     else: 
-        if Byte(hcph.get_object(source)["ContentLength"]) >= TiB(1):
-            click.echo("WARNING: You are about to download more than 1 TB of data. Is this your intention? [y/N]: ", nl = False)
-            inp = click.getchar(True)
-            if inp == "y" or inp == "Y":
-                pass
-            else: # inp == "n" or inp == "N" or something else
-                exit("\nAborting download")
-
-        downloaded_source = Path(destination) / Path(source).name
-        if downloaded_source.exists() and not force:
-            exit("Object already exists. If you wish to overwrite the existing file, use the -f, --force option")
-        hcph.download_file(source, downloaded_source.as_posix())
+        if object_is_folder(source, hcph):
+            click.echo("This command would have downloaded the folder \"" + source + "\". If you wish to know the contents of this folder, use the 'list-objects' command")
+        else:
+            click.echo("This command would have downloaded the object \"" + source + "\":")
+            click.echo(list(hcph.list_objects(source))[0])
 
 @cli.command()
 @click.argument("bucket")
 @click.argument("object")
+@click.option(
+    "-dr", 
+    "--dry_run", 
+    help = "Simulate the command execution without making actual changes. Useful for testing and verification", 
+    is_flag = True
+)
 @click.pass_context
-def delete_object(context : Context, bucket : str, object : str):
+def delete_object(context : Context, bucket : str, object : str, dry_run : bool):
     """
     Delete an object from an HCP bucket/namespace. 
 
@@ -191,13 +222,24 @@ def delete_object(context : Context, bucket : str, object : str):
     """
     hcph : HCPHandler = get_HCPHandler(context)
     hcph.mount_bucket(bucket)
-    hcph.delete_object(object)
+    if not dry_run:
+        hcph.delete_object(object)
+    else: 
+        click.echo("This command would delete:")
+        click.echo(list(hcph.list_objects(object))[0])
+
 
 @cli.command()
 @click.argument("bucket")
 @click.argument("folder")
+@click.option(
+    "-dr", 
+    "--dry_run", 
+    help = "Simulate the command execution without making actual changes. Useful for testing and verification", 
+    is_flag = True
+)
 @click.pass_context
-def delete_folder(context : Context, bucket : str, folder : str):
+def delete_folder(context : Context, bucket : str, folder : str, dry_run : bool):
     """
     Delete a folder from an HCP bucket/namespace. 
 
@@ -207,7 +249,12 @@ def delete_folder(context : Context, bucket : str, folder : str):
     """
     hcph : HCPHandler = get_HCPHandler(context)
     hcph.mount_bucket(bucket)
-    hcph.delete_folder(folder)
+    if not dry_run:
+        hcph.delete_folder(folder)
+    else:
+        click.echo("By deleting \"" + folder + "\", the following objects would have been deleted (not including objects in sub-folders):")
+        for obj in hcph.list_objects(folder):
+            click.echo(obj)
 
 @cli.command()
 @click.pass_context

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/NGPIris.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: NGPIris
-Version: 5.2.3.dev1
+Version: 5.3.0
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

ngpiris-5.3.0/NGPIris.egg-info/SOURCES.txt

@@ -0,0 +1,52 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+NGPIris/__init__.py
+NGPIris.egg-info/PKG-INFO
+NGPIris.egg-info/SOURCES.txt
+NGPIris.egg-info/dependency_links.txt
+NGPIris.egg-info/entry_points.txt
+NGPIris.egg-info/requires.txt
+NGPIris.egg-info/top_level.txt
+NGPIris/cli/__init__.py
+NGPIris/hci/__init__.py
+NGPIris/hci/exceptions.py
+NGPIris/hci/hci.py
+NGPIris/hci/helpers.py
+NGPIris/hcp/__init__.py
+NGPIris/hcp/exceptions.py
+NGPIris/hcp/hcp.py
+NGPIris/hcp/helpers.py
+NGPIris/hcp/statistics.py
+NGPIris/parse_credentials/__init__.py
+NGPIris/parse_credentials/parse_credentials.py
+NGPIris/utils/__init__.py
+NGPIris/utils/utils.py
+docs/IRIS_5_changelog.md
+docs/Makefile
+docs/NGPIris.cli.rst
+docs/NGPIris.hci.rst
+docs/NGPIris.hcp.rst
+docs/NGPIris.parse_credentials.rst
+docs/NGPIris.rst
+docs/NGPIris.utils.rst
+docs/Tutorial.md
+docs/conf.py
+docs/index.rst
+docs/make.bat
+docs/modules.rst
+tests/test_hci.py
+tests/test_hcp.py
+tests/test_parse_credentials.py
+tests/data/80MB_test_file
+tests/data/complete_creds_0.json
+tests/data/complete_creds_1.json
+tests/data/complete_creds_2.json
+tests/data/incomplete_creds_0.json
+tests/data/incomplete_creds_1.json
+tests/data/incomplete_creds_2.json
+tests/data/incomplete_creds_3.json
+tests/data/incomplete_creds_4.json
+tests/data/a folder of data/80MB_test_file_0
+tests/data/a folder of data/80MB_test_file_1

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: NGPIris
-Version: 5.2.3.dev1
+Version: 5.3.0
 Author-email: Erik Brink <erik.brink@gu.se>, Isak Sylvin <isak.sylvin@gu.se>
 Description-Content-Type: text/markdown
 License-File: LICENSE

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/docs/conf.py

@@ -7,7 +7,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'NGPIris'
-copyright = '2024, Author'
+copyright = '2025, Author'
 author = 'Author'
 
 # -- General configuration ---------------------------------------------------

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/docs/index.rst

@@ -1,5 +1,5 @@
 .. NGPIris documentation master file, created by
-   sphinx-quickstart on Fri Sep 27 16:07:28 2024.
+   sphinx-quickstart on Fri Feb 14 09:54:45 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 

{ngpiris-5.2.3.dev1 → ngpiris-5.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "NGPIris"
-version = "5.2.3.dev1"
+version = "5.3.0"
 readme = "README.md"
 dependencies = [
     "requests >= 2.31.0",

ngpiris-5.2.3.dev1/NGPIris.egg-info/SOURCES.txt

@@ -1,128 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-pyproject.toml
-NGPIris/__init__.py
-NGPIris.egg-info/PKG-INFO
-NGPIris.egg-info/SOURCES.txt
-NGPIris.egg-info/dependency_links.txt
-NGPIris.egg-info/entry_points.txt
-NGPIris.egg-info/requires.txt
-NGPIris.egg-info/top_level.txt
-NGPIris/cli/__init__.py
-NGPIris/hci/__init__.py
-NGPIris/hci/exceptions.py
-NGPIris/hci/hci.py
-NGPIris/hci/helpers.py
-NGPIris/hcp/__init__.py
-NGPIris/hcp/exceptions.py
-NGPIris/hcp/hcp.py
-NGPIris/hcp/helpers.py
-NGPIris/hcp/statistics.py
-NGPIris/parse_credentials/__init__.py
-NGPIris/parse_credentials/parse_credentials.py
-NGPIris/utils/__init__.py
-NGPIris/utils/utils.py
-docs/IRIS_5_changelog.md
-docs/Makefile
-docs/NGPIris.cli.rst
-docs/NGPIris.hci.rst
-docs/NGPIris.hcp.rst
-docs/NGPIris.parse_credentials.rst
-docs/NGPIris.rst
-docs/NGPIris.utils.rst
-docs/Tutorial.md
-docs/conf.py
-docs/index.rst
-docs/make.bat
-docs/modules.rst
-docs/_build/.DS_Store
-docs/_build/doctrees/IRIS_5_changelog.doctree
-docs/_build/doctrees/NGPIris.cli.doctree
-docs/_build/doctrees/NGPIris.doctree
-docs/_build/doctrees/NGPIris.hci.doctree
-docs/_build/doctrees/NGPIris.hcp.doctree
-docs/_build/doctrees/NGPIris.parse_credentials.doctree
-docs/_build/doctrees/NGPIris.utils.doctree
-docs/_build/doctrees/README.doctree
-docs/_build/doctrees/Tutorial.doctree
-docs/_build/doctrees/environment.pickle
-docs/_build/doctrees/index.doctree
-docs/_build/doctrees/modules.doctree
-docs/_build/html/.buildinfo
-docs/_build/html/IRIS_5_changelog.html
-docs/_build/html/NGPIris.cli.html
-docs/_build/html/NGPIris.hci.html
-docs/_build/html/NGPIris.hcp.html
-docs/_build/html/NGPIris.html
-docs/_build/html/NGPIris.parse_credentials.html
-docs/_build/html/NGPIris.utils.html
-docs/_build/html/README.html
-docs/_build/html/Tutorial.html
-docs/_build/html/genindex.html
-docs/_build/html/index.html
-docs/_build/html/modules.html
-docs/_build/html/objects.inv
-docs/_build/html/py-modindex.html
-docs/_build/html/search.html
-docs/_build/html/searchindex.js
-docs/_build/html/_downloads/ee00c4f6f22dc2671c766f728f00006f/credentials_template.json
-docs/_build/html/_modules/index.html
-docs/_build/html/_modules/NGPIris/cli.html
-docs/_build/html/_modules/NGPIris/hci/exceptions.html
-docs/_build/html/_modules/NGPIris/hci/hci.html
-docs/_build/html/_modules/NGPIris/hci/helpers.html
-docs/_build/html/_modules/NGPIris/hcp/exceptions.html
-docs/_build/html/_modules/NGPIris/hcp/hcp.html
-docs/_build/html/_modules/NGPIris/hcp/helpers.html
-docs/_build/html/_modules/NGPIris/hcp/statistics.html
-docs/_build/html/_modules/NGPIris/parse_credentials/parse_credentials.html
-docs/_build/html/_modules/NGPIris/utils/utils.html
-docs/_build/html/_sources/IRIS_5_changelog.md.txt
-docs/_build/html/_sources/NGPIris.cli.rst.txt
-docs/_build/html/_sources/NGPIris.hci.rst.txt
-docs/_build/html/_sources/NGPIris.hcp.rst.txt
-docs/_build/html/_sources/NGPIris.parse_credentials.rst.txt
-docs/_build/html/_sources/NGPIris.rst.txt
-docs/_build/html/_sources/NGPIris.utils.rst.txt
-docs/_build/html/_sources/README.md.txt
-docs/_build/html/_sources/Tutorial.md.txt
-docs/_build/html/_sources/index.rst.txt
-docs/_build/html/_sources/modules.rst.txt
-docs/_build/html/_static/alabaster.css
-docs/_build/html/_static/basic.css
-docs/_build/html/_static/custom.css
-docs/_build/html/_static/debug.css
-docs/_build/html/_static/doctools.js
-docs/_build/html/_static/documentation_options.js
-docs/_build/html/_static/file.png
-docs/_build/html/_static/language_data.js
-docs/_build/html/_static/minus.png
-docs/_build/html/_static/plus.png
-docs/_build/html/_static/pygments.css
-docs/_build/html/_static/searchtools.js
-docs/_build/html/_static/skeleton.css
-docs/_build/html/_static/sphinx_highlight.js
-docs/_build/html/_static/scripts/furo-extensions.js
-docs/_build/html/_static/scripts/furo.js
-docs/_build/html/_static/scripts/furo.js.LICENSE.txt
-docs/_build/html/_static/scripts/furo.js.map
-docs/_build/html/_static/styles/furo-extensions.css
-docs/_build/html/_static/styles/furo-extensions.css.map
-docs/_build/html/_static/styles/furo.css
-docs/_build/html/_static/styles/furo.css.map
-tests/test_hci.py
-tests/test_hcp.py
-tests/test_parse_credentials.py
-tests/data/.DS_Store
-tests/data/80MB_test_file
-tests/data/complete_creds_0.json
-tests/data/complete_creds_1.json
-tests/data/complete_creds_2.json
-tests/data/incomplete_creds_0.json
-tests/data/incomplete_creds_1.json
-tests/data/incomplete_creds_2.json
-tests/data/incomplete_creds_3.json
-tests/data/incomplete_creds_4.json
-tests/data/a folder of data/80MB_test_file_0
-tests/data/a folder of data/80MB_test_file_1

ngpiris-5.2.3.dev1/docs/_build/html/.buildinfo

@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d9c1d66de873cf4315be327a96406c4d
-tags: 645f666f9bcd5a90fca523b33c5a78b7