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.

pip install safe-file-example

• To see all the available commands and options run the following

safe-file-example

Usage:

$ safe-file-example [OPTIONS] COMMAND [ARGS]...

Options:

• --help: Show this message and exit.

Commands:

• get-token: Get and store access token
• import-file: Import a file
• export-file: Export a file
• interactive: Run interactive mode

safe-file-example get-token

Get and store access token

Usage:

$ safe-file-example get-token [OPTIONS]

Options:

• --help: Show this message and exit.

safe-file-example import-file

Import a file

Usage:

$ 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:

$ 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:

$ safe-file-example interactive [OPTIONS]

Options:

• --help: Show this message and exit.