Metadata-Version: 2.5
Name: nortre-cli
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/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
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: annotated-doc==0.0.5
Requires-Dist: certifi==2026.7.22
Requires-Dist: charset-normalizer==3.4.9
Requires-Dist: click==8.4.2
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.15.0
Requires-Dist: requests==2.34.2
Requires-Dist: rich==15.0.0
Requires-Dist: shellingham==1.5.4
Requires-Dist: typer==0.27.1
Requires-Dist: urllib3==2.7.0
Description-Content-Type: text/markdown

# `nortre-cli`


## Description

A python package for interacting with SAFE File transfer API


## Current Functionalities

- Generate a JWT Token
- 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 nortre-cli
```
- To see all the available commands and options run the following

```bash
safe-cli
```

**Usage**:

```console
$ safe-cli [OPTIONS] COMMAND [ARGS]...
```

**Options**:

* `--help`, `--man`, `--manual`: Show help and exit.

**Commands**:

* `get-token`: Get and store access token
* `import-file`: Import file/s
* `export-file`: Export a file
* `interactive`: Run interactive mode
* `exit`: Exits the cli


## `safe-cli get-token`

Get and store access token

**Usage**:

```console
$ safe-cli get-token [OPTIONS]
```

**Options**:

* `--help`, `--man`, `--manual`: Show help and exit.


## `safe-cli import-file`

Import a file

**Usage**:

```console
$ safe-cli import-file [OPTIONS]
```

**Options**:

* `--server TEXT`: Server name
* `--filename FILE`: Path to file to be imported
* `-i, --interactive`: Run import interactively
* `--help`, `--man`, `--manual`: Show help and exit.


## `safe-cli export-file`

Export a file

**Usage**:

```console
$ safe-cli export-file [OPTIONS]
```

**Options**:

* `--server TEXT`: Server name
* `--filename TEXT`: Filename to export
* `--output-dir DIRECTORY`: Output directory
* `-i, --interactive`: Run export interactively
* `--help`, `--man`, `--manual`: Show help and exit.


## `safe-cli interactive`

Run interactive mode

**Usage**:

```console
$ safe-cli interactive [OPTIONS]
```

**Options**:

* `--help`, `--man`, `--manual`: Show help and exit.