safe-file-example 0.1.1__tar.gz → 0.2.0__tar.gz

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/.gitignore

@@ -8,7 +8,7 @@ build/*
 wheels/
 # Virtual environments
 .venv/
-venv/ 
+venv/
 env/
 bin/
 #Other

safe_file_example-0.2.0/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+# Optimized for performance with parallel execution
+default_stages: [pre-commit]
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-toml # This is not necessary to have here
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ['--maxkb=10000']
+      - id: check-merge-conflict
+      - id: detect-private-key
+      - id: check-symlinks
+      - id: pretty-format-json
+        args: ["--autofix"]
+      - id: fix-byte-order-marker
+      - id: check-case-conflict
+      - id: requirements-txt-fixer
+      - id: mixed-line-ending
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.14.14
+    hooks:
+      - id: ruff
+        args: [--fix, --diff]
+      - id: ruff-format

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: safe-file-example
-Version: 0.1.1
+Version: 0.2.0
 Summary: A python package for interacting with SAFE File transfer API
 Project-URL: Homepage, https://git.app.uib.no/itpublic/python/safe-file-example
 Author-email: Dip Paul <dip.paul@uib.no>, Eirik Halseth <eirik.halseth@uib.no>, Marco Antonio Corrales Cardenas <marco.corrales@uib.no>
@@ -25,24 +25,23 @@ Requires-Dist: urllib3==2.6.3
 Description-Content-Type: text/markdown
 
 # `safe-file-example`
-
 ## Description
 
 A python package for interacting with SAFE File transfer API
 
 ## Current Functionalities
 
-- Generate a JWT Token 
+- Generate a JWT Token
 - Import a File
 - Export a File
 
-## Prerequisite 
+## Prerequisite
 
-- Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment. 
+- Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment.
 
 ## Workflow
 
-- Activate your Python Virtual Environment, 
+- Activate your Python Virtual Environment,
 - Then run the following command.
 
 ```bash
@@ -54,6 +53,7 @@ pip install safe-file-example
 safe-file-example
 ```
 
+
 **Usage**:
 
 ```console
@@ -66,19 +66,19 @@ $ safe-file-example [OPTIONS] COMMAND [ARGS]...
 
 **Commands**:
 
-* `token`: Get and store access token
+* `get-token`: Get and store access token
 * `import-file`: Import a file
 * `export-file`: Export a file
 * `interactive`: Run interactive mode
 
-## `safe-file-example token`
+## `safe-file-example get-token`
 
 Get and store access token
 
 **Usage**:
 
 ```console
-$ safe-file-example token [OPTIONS]
+$ safe-file-example get-token [OPTIONS]
 ```
 
 **Options**:
@@ -132,4 +132,4 @@ $ safe-file-example interactive [OPTIONS]
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`: Show this message and exit.

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/README.md

@@ -1,22 +1,21 @@
 # `safe-file-example`
-
 ## Description
 
 A python package for interacting with SAFE File transfer API
 
 ## Current Functionalities
 
-- Generate a JWT Token 
+- Generate a JWT Token
 - Import a File
 - Export a File
 
-## Prerequisite 
+## Prerequisite
 
-- Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment. 
+- Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment.
 
 ## Workflow
 
-- Activate your Python Virtual Environment, 
+- Activate your Python Virtual Environment,
 - Then run the following command.
 
 ```bash
@@ -28,6 +27,7 @@ pip install safe-file-example
 safe-file-example
 ```
 
+
 **Usage**:
 
 ```console
@@ -40,19 +40,19 @@ $ safe-file-example [OPTIONS] COMMAND [ARGS]...
 
 **Commands**:
 
-* `token`: Get and store access token
+* `get-token`: Get and store access token
 * `import-file`: Import a file
 * `export-file`: Export a file
 * `interactive`: Run interactive mode
 
-## `safe-file-example token`
+## `safe-file-example get-token`
 
 Get and store access token
 
 **Usage**:
 
 ```console
-$ safe-file-example token [OPTIONS]
+$ safe-file-example get-token [OPTIONS]
 ```
 
 **Options**:
@@ -106,4 +106,4 @@ $ safe-file-example interactive [OPTIONS]
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`: Show this message and exit.

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "safe-file-example"
-version = "0.1.1"
+version = "0.2.0"
 authors = [
   { name="Dip Paul", email="dip.paul@uib.no" },
   { name="Eirik Halseth", email="eirik.halseth@uib.no" },
@@ -45,4 +45,4 @@ safe-file-example="safe.main:app"
 packages = ["safe"]
 include = [
   "safe/assets/*.png"
-]
+]

safe_file_example-0.2.0/safe/__init__.py

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

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/safe/main.py

@@ -10,8 +10,10 @@ from pathlib import Path
 import safe.modules.import_module as import_module
 import safe.modules.export_module as export_module
 import safe.modules.list_export_module as list_export_module
-import safe.modules.select_helper as select_option
 import importlib.resources
+from safe.modules.helper_functions import HelperFunction
+
+helperFunction = HelperFunction()
 try:
     import readline
 except ImportError:
@@ -25,23 +27,26 @@ token_file = os.path.join(config_dir, "token.json")
 base_url = "https://api.safe.uib.no/v1"
 logo_path = importlib.resources.files("safe.assets").joinpath("safe_logo.png")
 
+
 def get_access_token():
     endpoint = "/auth"
     auth_url = f"{base_url}{endpoint}"
     webbrowser.open(auth_url)
-    
+
     Access_token = input("Paste You're JWT token here: ")
-    
+
     os.makedirs(config_dir, exist_ok=True)
     with open(token_file, "w") as f:
         f.write(Access_token)
-    if os.name != 'nt':
-        os.chmod(token_file, 0o600) #Change the ownership on Linux/MacOS
+    if os.name != "nt":
+        os.chmod(token_file, 0o600)  # Change the ownership on Linux/MacOS
     print("token succesfully stored")
 
+
 def exit_cli():
     sys.exit()
 
+
 def importFile():
     endpoint = "/files/import"
     url = f"{base_url}{endpoint}"
@@ -64,11 +69,13 @@ def importFile():
         root = tk.Tk()
         app_icon = tk.PhotoImage(file=str(logo_path))
         root.withdraw()
-        root.attributes('-topmost', True)
+        root.attributes("-topmost", True)
         root.iconphoto(True, app_icon)
         root.update()
-        file_path_str = filedialog.askopenfilename(title="Select a file to import", initialdir=os.path.expanduser("~"))
-        root.attributes('-topmost', False)
+        file_path_str = filedialog.askopenfilename(
+            title="Select a file to import", initialdir=os.path.expanduser("~")
+        )
+        root.attributes("-topmost", False)
         root.iconphoto(False, app_icon)
         root.destroy()
 
@@ -77,7 +84,7 @@ def importFile():
             continue
 
         file_path = Path(file_path_str)
-        
+
         print("\n--- Import Summary ---")
         print(f"\nServer: {server}")
         print(f"File:   {file_path.name}\n")
@@ -101,6 +108,7 @@ def importFile():
             print("Import cancelled.")
             break
 
+
 def exportFile():
     export_endpoint = "/files/export"
     export_url = f"{base_url}{export_endpoint}"
@@ -131,14 +139,12 @@ def exportFile():
             return
 
         while True:
-            filename = select_option.select_from_list(
-                files,
-                "Select file by number or type filename: "
+            filename = helperFunction.select_from_list(
+                files, "Select file by number or type filename: "
             )
             if filename:
                 break
 
-
         # ---- Directory picker ----
         print("Select output directory")
         root = tk.Tk()
@@ -147,7 +153,9 @@ def exportFile():
         root.attributes("-topmost", True)
         root.iconphoto(True, app_icon)
         root.update()
-        output_dir = filedialog.askdirectory(title="Select output directory", initialdir=os.path.expanduser("~"))
+        output_dir = filedialog.askdirectory(
+            title="Select output directory", initialdir=os.path.expanduser("~")
+        )
         root.attributes("-topmost", False)
         root.iconphoto(False, app_icon)
         root.destroy()
@@ -185,6 +193,7 @@ def exportFile():
             print("Export cancelled.")
             return
 
+
 def check_token():
     if os.path.exists(token_file):
         with open(token_file, "r") as f:
@@ -205,22 +214,42 @@ def check_token():
     else:
         print("No JWT token found in the token file.")
 
+
 @app.callback()
-def main(ctx:typer.Context):
+def main(ctx: typer.Context):
+    print("Reminder: Please use SAFE-VPN when accessing the SAFE File Examples.")
+    print(
+        "Note: Do not share the information in the JWT-token with anyone as it is a personal access token"
+    )
+    version_check()
     if ctx.invoked_subcommand is None:
         typer.echo(ctx.get_help())
         raise typer.Exit()
 
-@app.command()
+
+def version_check():
+    """prints local version and the newest available version in pip"""
+    helperFunction.check_pip_version()
+
+
 def token():
     """Get and store access token"""
     get_access_token()
 
-@app.command()
+
 def import_file(
     server: str = typer.Option(None, help="Server name"),
-    file_path: Path = typer.Option(None, exists=True, file_okay=True, dir_okay=False, readable=True, help="Path to file to import"),
-    interactive: bool = typer.Option(False, "-i", "--interactive", help="Run import interactively"),
+    file_path: Path = typer.Option(
+        None,
+        exists=True,
+        file_okay=True,
+        dir_okay=False,
+        readable=True,
+        help="Path to file to import",
+    ),
+    interactive: bool = typer.Option(
+        False, "-i", "--interactive", help="Run import interactively"
+    ),
 ):
     """Import a file"""
     if interactive or not (server and file_path):
@@ -249,12 +278,21 @@ def import_file(
         )
         typer.echo(f"Import result: {success}")
 
-@app.command()
+
 def export_file(
     server: str = typer.Option(None, help="Server name"),
     filename: str = typer.Option(None, help="Filename to export"),
-    output_dir: Path = typer.Option(None, exists=True, file_okay=False, dir_okay=True, writable=True, help="Output directory"),
-    interactive: bool = typer.Option(False, "-i", "--interactive", help="Run export interactively"),
+    output_dir: Path = typer.Option(
+        None,
+        exists=True,
+        file_okay=False,
+        dir_okay=True,
+        writable=True,
+        help="Output directory",
+    ),
+    interactive: bool = typer.Option(
+        False, "-i", "--interactive", help="Run export interactively"
+    ),
 ):
     """Export a file"""
     if interactive or not (server and filename and output_dir):
@@ -274,7 +312,9 @@ def export_file(
 
         output_path = output_dir / filename
 
-        typer.echo(f"Exporting file {filename} from server {server} to {output_path}...")
+        typer.echo(
+            f"Exporting file {filename} from server {server} to {output_path}..."
+        )
 
         success = export_module.write_file_to_disk(
             download_path=output_path,
@@ -288,21 +328,30 @@ def export_file(
 
 def interactive_menu():
     check_token()
-    choices: list = [get_access_token, importFile, exportFile, exit_cli]
+    # Map functions to their user-friendly descriptions (matching --help output)
+    choices = [
+        (get_access_token, "get-token"),
+        (importFile, "import-file"),
+        (exportFile, "export-file"),
+        (exit_cli, "Exit the Prorgam"),
+    ]
     while True:
-        print("\n--- SAFE CLI ---")
-        for index, item in enumerate(choices, start=1):
-            print(f"{index}. {item.__name__}")
-
-        menu_names = [fn.__name__ for fn in choices]
-        selection = select_option.select_from_list(
-            menu_names,
-            "Enter menu number or command name: "
+        print("\n--- SAFE File Examples ---")
+        for index, (_, description) in enumerate(choices, start=1):
+            print(f"{index}. {description}")
+
+        menu_names = [desc for _, desc in choices]
+        selection = helperFunction.select_from_list(
+            menu_names, "Enter menu number or command name: "
         )
         if not selection:
             continue
 
-        selected_fn = choices[menu_names.index(selection)]
+        selected_fn = None
+        for fn, desc in choices:
+            if desc == selection:
+                selected_fn = fn
+                break
 
         if selected_fn == exit_cli:
             exit_cli()
@@ -310,15 +359,17 @@ def interactive_menu():
         else:
             selected_fn()
 
+
+app.command(name="get-token")(token)
+app.command(name="import-file")(import_file)
+app.command(name="export-file")(export_file)
+
+
 @app.command(name="interactive")
 def interactive_command():
     """Run interactive mode"""
     interactive_menu()
 
-app.command()(token)
-app.command()(import_file)
-app.command()(export_file)
 
 if __name__ == "__main__":
     app()
-    

safe_file_example-0.2.0/safe/modules/__init__.py

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

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/safe/modules/export_module.py

@@ -19,9 +19,7 @@ def write_file_to_disk(
     temp_path = download_path.with_suffix(download_path.suffix + ".safetmp")
     download_path.parent.mkdir(parents=True, exist_ok=True)
 
-    headers = {
-        "Authorization": f"Bearer {token}"
-    }
+    headers = {"Authorization": f"Bearer {token}"}
 
     params = {
         "filename": filename,
@@ -55,11 +53,11 @@ def write_file_to_disk(
         print("download completed:", download_path)
         return True
 
-    except Exception as e:
+    except Exception:
         if temp_path.exists():
             try:
                 temp_path.unlink()
             except Exception:
                 pass
         print("Download failed")
-        return False
+        return False

safe_file_example-0.2.0/safe/modules/helper_functions.py

@@ -0,0 +1,52 @@
+from importlib.metadata import version, PackageNotFoundError
+import json
+from urllib.request import urlopen
+
+
+class HelperFunction:
+    def select_from_list(self, options: list[str], prompt: str) -> str | None:
+        """
+        Allow selection by number or exact name.
+        Returns the selected string or None if invalid.
+        """
+        choice = input(prompt).strip()
+
+        # Number selection
+        if choice.isdigit():
+            idx = int(choice) - 1
+            if 0 <= idx < len(options):
+                return options[idx]
+            print("Invalid number.")
+            return None
+
+        # Name selection
+        if choice in options:
+            return choice
+
+        print("Invalid selection.")
+        return None
+
+    def bytes_to_human_readable(self, size):
+        power = 2**10
+        n = 0
+        power_labels = {0: "", 1: "kilo", 2: "mega", 3: "giga", 4: "tera"}
+        while size > power:
+            size /= power
+            n += 1
+        return f"{size} {power_labels[n] + 'bytes'}"
+
+    def check_pip_version(self):
+        package_name = "safe-file-example"
+        try:
+            installed_version = version(package_name)
+        except PackageNotFoundError:
+            installed_version = "not installed"
+
+        with urlopen(
+            f"https://pypi.org/pypi/{package_name}/json", timeout=5
+        ) as response:
+            pypi_version = json.load(response)["info"]["version"]
+
+        if pypi_version > installed_version:
+            print(f"{package_name} - {pypi_version} is available")
+            print(f"run pip install --upgrade {package_name} to upgrade")

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/safe/modules/import_module.py

@@ -1,4 +1,3 @@
-import os
 import mimetypes
 import requests
 from pathlib import Path
@@ -68,4 +67,4 @@ def upload_file(
         return False
     except Exception as e:
         print("Unexpected error:", type(e).__name__, e)
-        return False
+        return False

{safe_file_example-0.1.1 → safe_file_example-0.2.0}/safe/modules/list_export_module.py

@@ -1,5 +1,9 @@
 import requests
 from typing import List
+from .helper_functions import HelperFunction
+
+helper_function = HelperFunction()
+
 
 def list_export_files(
     base_url: str,
@@ -9,12 +13,9 @@ def list_export_files(
     pagination: bool = True,
     timeout: int = 30,
 ) -> List[str]:
-
     url = f"{base_url}/files/info/list/export"
 
-    headers = {
-        "Authorization": f"Bearer {token}"
-    }
+    headers = {"Authorization": f"Bearer {token}"}
 
     params = {
         "server": server,
@@ -37,18 +38,22 @@ def list_export_files(
 
         # Extract filenames
         content = data.get("content", {})
-        entries = content.get("Files and Directories", [])
-        for entry in entries:
-            if isinstance(entry, dict):
-                files.extend(entry.keys())
+        data = content.get("files_and_directories", [])
+        entries = {
+            item["name"]: helper_function.bytes_to_human_readable(item["size"])
+            for item in data
+            if item.get("type") == "file"
+        }
+
+        files = list(entries.keys())  # List containing name of files
+        size_of_file = list(entries.values())  # List containing size of files
 
-        # Pretty print
         print("\n--- Available export files ---")
         if not files:
             print("(No files found)")
         else:
             for i, name in enumerate((files), start=1):
-                print(f"{i}. {name}")
+                print(f"{i}. {name}" + f"  -- {size_of_file[i - 1]}")
         print("------------------------------\n")
 
         return files

safe_file_example-0.1.1/safe/__init__.py

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

safe_file_example-0.1.1/safe/modules/__init__.py

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

safe_file_example-0.1.1/safe/modules/select_helper.py

@@ -1,22 +0,0 @@
-
-def select_from_list(options: list[str], prompt: str) -> str | None:
-    """
-    Allow selection by number or exact name.
-    Returns the selected string or None if invalid.
-    """
-    choice = input(prompt).strip()
-
-    # Number selection
-    if choice.isdigit():
-        idx = int(choice) - 1
-        if 0 <= idx < len(options):
-            return options[idx]
-        print("Invalid number.")
-        return None
-
-    # Name selection
-    if choice in options:
-        return choice
-
-    print("Invalid selection.")
-    return None