Metadata-Version: 2.4
Name: safe-file-example
Version: 0.1.1
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>
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.