safe-file-example 0.3.1__tar.gz → 1.0.0__tar.gz

{safe_file_example-0.3.1 → safe_file_example-1.0.0}/.gitlab-ci.yml

@@ -9,6 +9,7 @@ include:
   - template: Jobs/Dependency-Scanning.gitlab-ci.yml
   - template: Jobs/SAST.gitlab-ci.yml
 
+
 variables:
   PIP_CACHE_DIR: "$CI_PROJECT_DIR/.pip-cache"
   TRIVY_CACHE_DIR: ".cache/trivy"
@@ -44,7 +45,7 @@ build-safe-cli:
     - python --version
     - uv --version
   script:
-    - echo "Building safe-file-example package..."
+    - echo "Building nortre-cli package..."
     - uv build
   artifacts:
     paths:

safe_file_example-1.0.0/.trivyignore

@@ -0,0 +1,3 @@
+CVE-2026-97687
+CVE-2026-97689
+CVE-2026-97688

safe_file_example-1.0.0/CHANGELOG.md

@@ -0,0 +1,85 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/2.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+### Types of changes
+
+- `Added` for new features.
+- `Changed` for changes in existing functionality. (The behavior worked as intended, and now works differently.)
+- `Deprecated` for soon-to-be removed features.
+- `Removed` for now removed features.
+- `Fixed` for bug fixes. (The behavior was wrong, and is now correct.)
+- `Security` for vulnerabilities. (The change addresses a vulnerability. It could fit under Fixed or Changed, but its urgency and audience are different.)
+
+## [1.0.0] - 2026-10-19
+
+### Changed
+- Replaced `--file-path` command in import with `--filename` to unify the commands with export. `--help` has been updated to reflect this.
+- Colored text in CLI:
+  - Red: Errors and critical information/warnings
+  - Yellow: Non critical information/warnings
+  - Green: Success messages
+  - White: Standard message, input prompts and job updates
+- Timeout value error is now less verbose and will occur quicker upon no connection.
+- Updated the help documentation for methods and included example usage for import and export.
+- Added options for viewing help by using --man and --manual in addition to --help.
+- Changed name from safe-file-example to nortre-cli. Commands that can be used are now: safe-cli and safe-file-example.
+- Added spinner when exporting files.
+- Changed import progress from progress-bars to a spinner.
+- Updated the display of the numbered menus to improve visibility
+
+### Added
+- Exit codes: 0 = success, 1 = complete failure, 2 = partial failure
+- The server requests to check access to server and retrieve export file options now displays a spinner to indicate activity.
+
+### Security
+- Security enhancements.
+
+### Fixed
+- Fixed wrong error display when token is expired.
+
+
+## [0.3.1] - 2026-09-29
+
+### Fixed
+- Fixed an issue with the URL of SAFE File API.
+
+
+## [0.3.0] - 2026-09-25 [YANKED]
+
+### Added
+- Added support for batch importing multiple files via both interactive and non-interactive methods.
+- Added progress indicators for file import operations.
+- Added command `exit` to exit the interactive mode in CLI.
+
+### Fixed
+- Display of file size in menu when exporting files is now limited to one decimal.
+
+
+## [0.2.1] - 2026-08-06
+
+### Changed
+- Updated project dependencies.
+
+
+## [0.2.0] - 2026-05-11
+
+### Added
+- Added a VPN usage reminder on application startup.
+- Added a JWT token security reminder on application startup.
+- Added automatic version checks on application startup.
+- Added human-friendly display of file size in export file selection.
+
+
+## [0.1.1] - 2026-04-20
+- Initial release
+
+
+[1.0.0]: https://git.app.uib.no/itpublic/python/nortre-cli/-/compare/0.3.1...1.0.0?from_project_id=1062
+[0.3.1]: https://git.app.uib.no/itpublic/python/nortre-cli/-/compare/0.3.0...0.3.1?from_project_id=1062
+[0.3.0]: https://git.app.uib.no/itpublic/python/nortre-cli/-/compare/0.2.1...0.3.0?from_project_id=1062
+[0.2.1]: https://git.app.uib.no/itpublic/python/nortre-cli/-/compare/0.2.0...0.2.1?from_project_id=1062
+[0.2.0]: https://git.app.uib.no/itpublic/python/nortre-cli/-/compare/0.1.1...0.2.0?from_project_id=1062
+[0.1.1]: https://git.app.uib.no/itpublic/python/nortre-cli/-/tree/0.1.1?ref_type=tags

{safe_file_example-0.3.1 → safe_file_example-1.0.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.5
 Name: safe-file-example
-Version: 0.3.1
+Version: 1.0.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
+Project-URL: Homepage, https://git.app.uib.no/itpublic/python/nortre-cli
 Author-email: Dip Paul <dip.paul@uib.no>, Eirik Halseth <eirik.halseth@uib.no>, Elena Nicole Jacobsen <Elena.Nicole.Jacobsen@uib.no>, Kai Imoda Waløen <kai.waloen@uib.no>, Lukas Lussand Iversen <lukas.lussand.iversen@uib.no>, Marco Antonio Corrales Cardenas <marco.corrales@uib.no>
 License-File: LICENSE
 Classifier: Operating System :: OS Independent
@@ -16,7 +16,7 @@ Requires-Dist: idna==3.18
 Requires-Dist: markdown-it-py==4.2.0
 Requires-Dist: mdurl==0.1.2
 Requires-Dist: pygments==2.20.0
-Requires-Dist: pyjwt==2.13.0
+Requires-Dist: pyjwt==2.15.0
 Requires-Dist: requests==2.34.2
 Requires-Dist: rich==15.0.0
 Requires-Dist: shellingham==1.5.4
@@ -24,92 +24,103 @@ Requires-Dist: typer==0.27.1
 Requires-Dist: urllib3==2.7.0
 Description-Content-Type: text/markdown
 
-# `safe-file-example`
+# `nortre-cli`
+
+## Deprecation warning
+This pip package will be depricated at the end of 2026. Please transfer over to the new package located at https://pypi.org/project/nortre-cli/
+
 ## Description
 
 A python package for interacting with SAFE File transfer API
 
+
 ## Current Functionalities
 
 - Generate a JWT Token
-- Import a File
-- Export a File
+- Import file/s
+- Export a file
+- Exit
+
 
 ## 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
+pip install nortre-cli
 ```
 - To see all the available commands and options run the following
 
 ```bash
-safe-file-example
+safe-cli
 ```
 
-
 **Usage**:
 
 ```console
-$ safe-file-example [OPTIONS] COMMAND [ARGS]...
+$ safe-cli [OPTIONS] COMMAND [ARGS]...
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
 
 **Commands**:
 
 * `get-token`: Get and store access token
-* `import-file`: Import a file
+* `import-file`: Import file/s
 * `export-file`: Export a file
 * `interactive`: Run interactive mode
+* `exit`: Exits the cli
+
 
-## `safe-file-example get-token`
+## `safe-cli get-token`
 
 Get and store access token
 
 **Usage**:
 
 ```console
-$ safe-file-example get-token [OPTIONS]
+$ safe-cli get-token [OPTIONS]
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
+
 
-## `safe-file-example import-file`
+## `safe-cli import-file`
 
 Import a file
 
 **Usage**:
 
 ```console
-$ safe-file-example import-file [OPTIONS]
+$ safe-cli import-file [OPTIONS]
 ```
 
 **Options**:
 
 * `--server TEXT`: Server name
-* `--file-path FILE`: Path to file to import
+* `--filename FILE`: Path to file to be imported
 * `-i, --interactive`: Run import interactively
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
 
-## `safe-file-example export-file`
+
+## `safe-cli export-file`
 
 Export a file
 
 **Usage**:
 
 ```console
-$ safe-file-example export-file [OPTIONS]
+$ safe-cli export-file [OPTIONS]
 ```
 
 **Options**:
@@ -118,18 +129,19 @@ $ safe-file-example export-file [OPTIONS]
 * `--filename TEXT`: Filename to export
 * `--output-dir DIRECTORY`: Output directory
 * `-i, --interactive`: Run export interactively
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
+
 
-## `safe-file-example interactive`
+## `safe-cli interactive`
 
 Run interactive mode
 
 **Usage**:
 
 ```console
-$ safe-file-example interactive [OPTIONS]
+$ safe-cli interactive [OPTIONS]
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.

{safe_file_example-0.3.1 → safe_file_example-1.0.0}/README.md

@@ -1,89 +1,100 @@
-# `safe-file-example`
+# `nortre-cli`
+
+## Deprecation warning
+This pip package will be depricated at the end of 2026. Please transfer over to the new package located at https://pypi.org/project/nortre-cli/
+
 ## Description
 
 A python package for interacting with SAFE File transfer API
 
+
 ## Current Functionalities
 
 - Generate a JWT Token
-- Import a File
-- Export a File
+- Import file/s
+- Export a file
+- Exit
+
 
 ## 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
+pip install nortre-cli
 ```
 - To see all the available commands and options run the following
 
 ```bash
-safe-file-example
+safe-cli
 ```
 
-
 **Usage**:
 
 ```console
-$ safe-file-example [OPTIONS] COMMAND [ARGS]...
+$ safe-cli [OPTIONS] COMMAND [ARGS]...
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
 
 **Commands**:
 
 * `get-token`: Get and store access token
-* `import-file`: Import a file
+* `import-file`: Import file/s
 * `export-file`: Export a file
 * `interactive`: Run interactive mode
+* `exit`: Exits the cli
+
 
-## `safe-file-example get-token`
+## `safe-cli get-token`
 
 Get and store access token
 
 **Usage**:
 
 ```console
-$ safe-file-example get-token [OPTIONS]
+$ safe-cli get-token [OPTIONS]
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
+
 
-## `safe-file-example import-file`
+## `safe-cli import-file`
 
 Import a file
 
 **Usage**:
 
 ```console
-$ safe-file-example import-file [OPTIONS]
+$ safe-cli import-file [OPTIONS]
 ```
 
 **Options**:
 
 * `--server TEXT`: Server name
-* `--file-path FILE`: Path to file to import
+* `--filename FILE`: Path to file to be imported
 * `-i, --interactive`: Run import interactively
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
 
-## `safe-file-example export-file`
+
+## `safe-cli export-file`
 
 Export a file
 
 **Usage**:
 
 ```console
-$ safe-file-example export-file [OPTIONS]
+$ safe-cli export-file [OPTIONS]
 ```
 
 **Options**:
@@ -92,18 +103,19 @@ $ safe-file-example export-file [OPTIONS]
 * `--filename TEXT`: Filename to export
 * `--output-dir DIRECTORY`: Output directory
 * `-i, --interactive`: Run export interactively
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.
+
 
-## `safe-file-example interactive`
+## `safe-cli interactive`
 
 Run interactive mode
 
 **Usage**:
 
 ```console
-$ safe-file-example interactive [OPTIONS]
+$ safe-cli interactive [OPTIONS]
 ```
 
 **Options**:
 
-* `--help`: Show this message and exit.
+* `--help`, `--man`, `--manual`: Show help and exit.

{safe_file_example-0.3.1 → safe_file_example-1.0.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "safe-file-example"
-version = "0.3.1"
+version = "1.0.0"
 authors = [
   { name="Dip Paul", email="dip.paul@uib.no" },
   { name="Eirik Halseth", email="eirik.halseth@uib.no" },
@@ -26,7 +26,7 @@ dependencies = [
     "markdown-it-py==4.2.0",
     "mdurl==0.1.2",
     "Pygments==2.20.0",
-    "PyJWT==2.13.0",
+    "PyJWT==2.15.0",
     "requests==2.34.2",
     "rich==15.0.0",
     "shellingham==1.5.4",
@@ -40,11 +40,13 @@ classifiers = [
 ]
 
 [project.urls]
-Homepage = "https://git.app.uib.no/itpublic/python/safe-file-example"
+Homepage = "https://git.app.uib.no/itpublic/python/nortre-cli"
 
 [project.scripts]
+safe-cli="safe.main:app"
 safe-file-example="safe.main:app"
 
+
 [tool.hatch.build.targets.wheel]
 packages = ["safe"]
 include = [

safe_file_example-1.0.0/safe/config.py

@@ -0,0 +1,11 @@
+import importlib.resources
+import os
+
+# Global variables across whole project that can be imported where it is needed:
+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")
+
+# Global stylings
+rich_panel_expand: bool = False

safe_file_example-0.3.1/safe/modules/export_module.py → safe_file_example-1.0.0/safe/export_logic/export_executor.py

@@ -1,8 +1,13 @@
-from pathlib import Path
 import os
-import shutil
+from pathlib import Path
+
 import requests
 
+from rich.console import Console
+from rich import print as rich_print
+
+console = Console()
+
 
 def write_file_to_disk(
     download_path: Path,
@@ -11,8 +16,6 @@ def write_file_to_disk(
     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}")
 
@@ -27,13 +30,16 @@ def write_file_to_disk(
     }
 
     try:
-        with requests.get(
-            download_url,
-            headers=headers,
-            params=params,
-            stream=True,
-            timeout=(connect_timeout, read_timeout),
-        ) as response:
+        with (
+            console.status(f"Exporting {filename}..."),
+            requests.get(
+                download_url,
+                headers=headers,
+                params=params,
+                stream=True,
+                timeout=(15, 600),
+            ) as response,
+        ):
             response.raise_for_status()
 
             with open(temp_path, "wb") as f:
@@ -42,7 +48,7 @@ def write_file_to_disk(
                         f.write(chunk)
 
         os.replace(temp_path, download_path)
-        print("Download completed:", download_path)
+        rich_print(f"[bold green]Download completed: {download_path}[/bold green]")
         return True
 
     except Exception:
@@ -51,5 +57,5 @@ def write_file_to_disk(
                 temp_path.unlink()
             except Exception:
                 pass
-        print("Download failed")
+        rich_print("[bold red]Download failed[/bold red]")
         return False