safe-file-example 0.1.0__py3-none-any.whl

safe/__init__.py

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

safe/main.py

@@ -0,0 +1,324 @@
+import sys
+import typer
+import webbrowser
+import jwt
+import os
+import time
+import tkinter as tk
+from tkinter import filedialog
+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
+try:
+    import readline
+except ImportError:
+    pass
+
+app = typer.Typer(invoke_without_command=True, add_completion=False)
+
+# Variables
+config_dir = os.path.expanduser("~/.safe-cli")
+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
+    print("token succesfully stored")
+
+def exit_cli():
+    sys.exit()
+
+def importFile():
+    endpoint = "/files/import"
+    url = f"{base_url}{endpoint}"
+
+    # Read token from stored file
+    if not os.path.exists(token_file):
+        print("No token found. Run option 1 to authenticate.")
+        return
+
+    with open(token_file, "r") as f:
+        token = f.read().strip()
+
+    while True:
+        server = input("Enter the server name: ").strip()
+        if not server:
+            print("Please enter a valid server.")
+            continue
+        # File picker
+        print("opening file picker")
+        root = tk.Tk()
+        app_icon = tk.PhotoImage(file=str(logo_path))
+        root.withdraw()
+        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)
+        root.iconphoto(False, app_icon)
+        root.destroy()
+
+        if not file_path_str:
+            print("No file selected, try again.")
+            continue
+
+        file_path = Path(file_path_str)
+        
+        print("\n--- Import Summary ---")
+        print(f"\nServer: {server}")
+        print(f"File:   {file_path.name}\n")
+
+        proceed = input("Proceed? (yes/no/change): ").strip().lower()
+
+        if proceed == "yes":
+            success = import_module.upload_file(
+                file_path=file_path,
+                url=url,
+                token=token,
+                filename_param=file_path.name,
+                server=server,
+            )
+            print(f"Import result: {success}")
+            break
+
+        elif proceed == "change":
+            continue
+        else:
+            print("Import cancelled.")
+            break
+
+def exportFile():
+    export_endpoint = "/files/export"
+    export_url = f"{base_url}{export_endpoint}"
+
+    # Read token
+    if not os.path.exists(token_file):
+        print("No token found. Run option 1 to authenticate.")
+        return
+
+    with open(token_file, "r") as f:
+        token = f.read().strip()
+
+    while True:
+        server = input("Enter the server name: ").strip()
+        if not server:
+            print("Please enter a valid server.")
+            continue
+
+        # ---- LIST AVAILABLE FILES ----
+        files = list_export_module.list_export_files(
+            base_url=base_url,
+            token=token,
+            server=server,
+        )
+
+        if not files:
+            print("No exportable files found.")
+            return
+
+        while True:
+            filename = select_option.select_from_list(
+                files,
+                "Select file by number or type filename: "
+            )
+            if filename:
+                break
+
+
+        # ---- Directory picker ----
+        print("Select output directory")
+        root = tk.Tk()
+        app_icon = tk.PhotoImage(file=str(logo_path))
+        root.withdraw()
+        root.attributes("-topmost", True)
+        root.iconphoto(True, app_icon)
+        root.update()
+        output_dir = filedialog.askdirectory(title="Select output directory", initialdir=os.path.expanduser("~"))
+        root.attributes("-topmost", False)
+        root.iconphoto(False, app_icon)
+        root.destroy()
+        # ---------------------------
+
+        if not output_dir:
+            print("No directory selected, try again.")
+            continue
+
+        output_path = Path(output_dir) / filename
+
+        print("\n--- Export Summary ---")
+        print(f"Server:   {server}")
+        print(f"Filename: {filename}")
+        print(f"Output:   {output_path}")
+        print("----------------------\n")
+
+        proceed = input("Proceed? (yes/no/change): ").strip().lower()
+
+        if proceed == "yes":
+            success = export_module.write_file_to_disk(
+                download_path=output_path,
+                download_url=export_url,
+                token=token,
+                server=server,
+                filename=filename,
+            )
+            print(f"Export result: {success}")
+            return
+
+        elif proceed == "change":
+            continue
+
+        else:
+            print("Export cancelled.")
+            return
+
+def check_token():
+    if os.path.exists(token_file):
+        with open(token_file, "r") as f:
+            token = f.read().strip()
+        try:
+            decoded = jwt.decode(token, options={"verify_signature": False})
+            exp = decoded.get("exp")
+            if exp is not None:
+                current_time = int(time.time())
+                if current_time > exp:
+                    print("The stored JWT token is expired.")
+                else:
+                    print("The stored JWT token is valid.")
+            else:
+                print("No expiration (exp) claim found in the JWT token.")
+        except Exception as e:
+            print(f"Failed to decode JWT token: {e}")
+    else:
+        print("No JWT token found in the token file.")
+
+@app.callback()
+def main(ctx:typer.Context):
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+        raise typer.Exit()
+
+@app.command()
+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"),
+):
+    """Import a file"""
+    if interactive or not (server and file_path):
+        # Run interactive import
+        importFile()
+    else:
+        # Non-interactive import
+        endpoint = "/files/import"
+        url = f"{base_url}{endpoint}"
+
+        if not os.path.exists(token_file):
+            typer.echo("No token found. Run 'get-token' to authenticate.")
+            raise typer.Exit(code=1)
+
+        with open(token_file, "r") as f:
+            token = f.read().strip()
+
+        typer.echo(f"Importing file {file_path} to server {server}...")
+
+        success = import_module.upload_file(
+            file_path=file_path,
+            url=url,
+            token=token,
+            filename_param=file_path.name,
+            server=server,
+        )
+        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"),
+):
+    """Export a file"""
+    if interactive or not (server and filename and output_dir):
+        # Run interactive export
+        exportFile()
+    else:
+        # Non-interactive export
+        export_endpoint = "/files/export"
+        export_url = f"{base_url}{export_endpoint}"
+
+        if not os.path.exists(token_file):
+            typer.echo("No token found. Run 'get-token' to authenticate.")
+            raise typer.Exit(code=1)
+
+        with open(token_file, "r") as f:
+            token = f.read().strip()
+
+        output_path = output_dir / filename
+
+        typer.echo(f"Exporting file {filename} from server {server} to {output_path}...")
+
+        success = export_module.write_file_to_disk(
+            download_path=output_path,
+            download_url=export_url,
+            token=token,
+            server=server,
+            filename=filename,
+        )
+        typer.echo(f"Export result: {success}")
+
+
+def interactive_menu():
+    check_token()
+    choices: list = [get_access_token, importFile, exportFile, exit_cli]
+    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: "
+        )
+        if not selection:
+            continue
+
+        selected_fn = choices[menu_names.index(selection)]
+
+        if selected_fn == exit_cli:
+            exit_cli()
+            return
+        else:
+            selected_fn()
+
+@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/modules/__init__.py

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

safe/modules/export_module.py

@@ -0,0 +1,65 @@
+from pathlib import Path
+import os
+import shutil
+import requests
+
+
+def write_file_to_disk(
+    download_path: Path,
+    download_url: str,
+    token: str,
+    server: str,
+    filename: str,
+    chunk_size: int = 8 * 1024 * 1024,
+    connect_timeout: float = 15,
+    read_timeout: float = 600,
+) -> bool:
+    print(f"Starting download to {download_path}")
+
+    temp_path = download_path.with_suffix(download_path.suffix + ".safetmp")
+    download_path.parent.mkdir(parents=True, exist_ok=True)
+
+    headers = {
+        "Authorization": f"Bearer {token}"
+    }
+
+    params = {
+        "filename": filename,
+        "server": server,
+    }
+
+    try:
+        with requests.get(
+            download_url,
+            headers=headers,
+            params=params,
+            stream=True,
+            timeout=(connect_timeout, read_timeout),
+        ) as response:
+            response.raise_for_status()
+
+            total = int(response.headers.get("Content-Length") or 0)
+            if total:
+                free = shutil.disk_usage(download_path.parent).free
+                if total > free:
+                    raise OSError(
+                        f"Not enough free disk space ({free} bytes) for {total} bytes"
+                    )
+
+            with open(temp_path, "wb") as f:
+                for chunk in response.iter_content(chunk_size=chunk_size):
+                    if chunk:
+                        f.write(chunk)
+
+        os.replace(temp_path, download_path)
+        print("download completed:", download_path)
+        return True
+
+    except Exception as e:
+        if temp_path.exists():
+            try:
+                temp_path.unlink()
+            except Exception:
+                pass
+        print("Download failed")
+        return False

safe/modules/import_module.py

@@ -0,0 +1,71 @@
+import os
+import mimetypes
+import requests
+from pathlib import Path
+
+
+def open_file_stream(path: Path):
+    return path.open("rb")
+
+
+def upload_file(
+    file_path: Path,
+    url: str,
+    token: str,
+    filename_param: str,
+    server: str,
+) -> bool:
+    if not file_path.is_file():
+        raise FileNotFoundError(f"File not found: {file_path}")
+    if not server:
+        raise RuntimeError("Server name not provided")
+
+    mime, _ = mimetypes.guess_type(file_path.name)
+    content_type = mime or "application/octet-stream"
+
+    headers = {
+        "Authorization": f"Bearer {token}",
+        "Content-Type": content_type,
+    }
+    params = {"filename": filename_param, "server": server}
+
+    print(f"Uploading {file_path.name} ({content_type})...")
+
+    try:
+        with open_file_stream(file_path) as f:
+            resp = requests.post(
+                url,
+                headers=headers,
+                params=params,
+                data=f,
+            )
+
+        # Error handling
+        if resp.status_code == 400:
+            print("Bad Request - invalid filename or no file.")
+            print(resp.text)
+            return False
+        if resp.status_code == 401:
+            print("Unauthorized - no import access.")
+            print(resp.text)
+            return False
+        if resp.status_code == 409:
+            print("Conflict - file already exists.")
+            print(resp.text)
+            return False
+        if resp.status_code == 500:
+            print("Internal server error.")
+            print(resp.text)
+            return False
+
+        resp.raise_for_status()
+        print("Upload succeeded:", resp.text)
+        return True
+
+    except requests.HTTPError as http_err:
+        print("Unexpected HTTP error:", http_err)
+        print("Response:", http_err.response.text)
+        return False
+    except Exception as e:
+        print("Unexpected error:", type(e).__name__, e)
+        return False

safe/modules/list_export_module.py

@@ -0,0 +1,61 @@
+import requests
+from typing import List
+
+def list_export_files(
+    base_url: str,
+    token: str,
+    server: str,
+    page: int = 1,
+    pagination: bool = True,
+    timeout: int = 30,
+) -> List[str]:
+
+    url = f"{base_url}/files/info/list/export"
+
+    headers = {
+        "Authorization": f"Bearer {token}"
+    }
+
+    params = {
+        "server": server,
+        "page": page,
+        "pagination": pagination,
+    }
+
+    try:
+        resp = requests.get(
+            url,
+            headers=headers,
+            params=params,
+            timeout=timeout,
+        )
+        resp.raise_for_status()
+
+        data = resp.json()
+
+        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())
+
+        # 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("------------------------------\n")
+
+        return files
+
+    except requests.HTTPError as e:
+        print(f"HTTP {e.response.status_code}: {e.response.text}")
+        return []
+    except Exception as e:
+        print(f"Unexpected error: {e}")
+        return []

safe/modules/select_helper.py

@@ -0,0 +1,22 @@
+
+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

safe_file_example-0.1.0.dist-info/METADATA

@@ -0,0 +1,135 @@
+Metadata-Version: 2.4
+Name: safe-file-example
+Version: 0.1.0
+Summary: A python package for interacting with SAFE File transfer API
+Project-URL: Homepage, https://itgit.app.uib.no/it/dpv/df/sfl/safe/development-group/experiments/safe-cli
+Author-email: Dip Paul <dip.paul@uib.no>, Eirik Halseth <eirik.halseth@uib.no>, Marco Antonio Corrales Cardenas <marco.corrales@uib.no>
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: annotated-doc==0.0.4
+Requires-Dist: certifi==2026.2.25
+Requires-Dist: charset-normalizer==3.4.7
+Requires-Dist: click==8.3.2
+Requires-Dist: idna==3.11
+Requires-Dist: markdown-it-py==4.0.0
+Requires-Dist: mdurl==0.1.2
+Requires-Dist: pygments==2.20.0
+Requires-Dist: pyjwt==2.12.1
+Requires-Dist: requests==2.33.1
+Requires-Dist: rich==15.0.0
+Requires-Dist: shellingham==1.5.4
+Requires-Dist: typer==0.24.1
+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 
+- Import a File
+- Export a File
+
+## Prerequisite 
+
+- Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment. 
+
+## Workflow
+
+- Activate your Python Virtual Environment, 
+- Then run the following command.
+
+```bash
+pip install safe-file-example
+```
+- To see all the available commands and options run the following
+
+```bash
+safe-file-example
+```
+
+**Usage**:
+
+```console
+$ safe-file-example [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `token`: Get and store access token
+* `import-file`: Import a file
+* `export-file`: Export a file
+* `interactive`: Run interactive mode
+
+## `safe-file-example token`
+
+Get and store access token
+
+**Usage**:
+
+```console
+$ safe-file-example token [OPTIONS]
+```
+
+**Options**:
+
+* `--help`: Show this message and exit.
+
+## `safe-file-example import-file`
+
+Import a file
+
+**Usage**:
+
+```console
+$ safe-file-example import-file [OPTIONS]
+```
+
+**Options**:
+
+* `--server TEXT`: Server name
+* `--file-path FILE`: Path to file to import
+* `-i, --interactive`: Run import interactively
+* `--help`: Show this message and exit.
+
+## `safe-file-example export-file`
+
+Export a file
+
+**Usage**:
+
+```console
+$ safe-file-example export-file [OPTIONS]
+```
+
+**Options**:
+
+* `--server TEXT`: Server name
+* `--filename TEXT`: Filename to export
+* `--output-dir DIRECTORY`: Output directory
+* `-i, --interactive`: Run export interactively
+* `--help`: Show this message and exit.
+
+## `safe-file-example interactive`
+
+Run interactive mode
+
+**Usage**:
+
+```console
+$ safe-file-example interactive [OPTIONS]
+```
+
+**Options**:
+
+* `--help`: Show this message and exit.

safe_file_example-0.1.0.dist-info/RECORD

@@ -0,0 +1,13 @@
+safe/__init__.py,sha256=qwX_VmtTcxitUuo61-lzyWhU70ydr0gDejMn5eqC3Dk,21
+safe/main.py,sha256=tK3n09FSwRFr_g6pQ3ScYPsKZ7YtHuSjwMNgok8QIl4,9765
+safe/assets/safe_logo.png,sha256=B4jKkV7eCUnpN8RG3-WgfBfq8XZSgfH8BBpQ_NeUsQ4,5194
+safe/modules/__init__.py,sha256=qwX_VmtTcxitUuo61-lzyWhU70ydr0gDejMn5eqC3Dk,21
+safe/modules/export_module.py,sha256=D5Eltciypvdxg89TIno-mgBmCtnMECa4iz685H9kKgc,1758
+safe/modules/import_module.py,sha256=42maaFQhC9gl9dyax0lSn2u1pVBbbotfciNq2XlMXY8,1940
+safe/modules/list_export_module.py,sha256=L3iI9KsTAo7NLDjuooMPMSZ09fNd2AnS3DJUsAtoMJQ,1416
+safe/modules/select_helper.py,sha256=kWlQVHTMzeI7kjqH5RPQcYGQKXMQt4Jw83e3TUyo9Is,537
+safe_file_example-0.1.0.dist-info/METADATA,sha256=i2wQmcm9pPmnvZR59mOFIEM1sKV9PMqgBHkPd_VXOaI,2820
+safe_file_example-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+safe_file_example-0.1.0.dist-info/entry_points.txt,sha256=coCH6K8wmaoh76SFtz3WZDJmX6MFXRUFlScszm7qYNk,52
+safe_file_example-0.1.0.dist-info/licenses/LICENSE,sha256=q-Uz9BRmoLloIbL-0Ql3YvcvW6TdzzLrJUxeOtmSAjI,1077
+safe_file_example-0.1.0.dist-info/RECORD,,

safe_file_example-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

safe_file_example-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+safe-file-example = safe.main:app

safe_file_example-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 University of Bergen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.