Skip to content

Latest commit

 

History

History
138 lines (93 loc) · 2.82 KB

README.md

File metadata and controls

138 lines (93 loc) · 2.82 KB
Raw

Data Server (Snappy) CLI

Command line interface to a local client for a snappy data server.

Requirements

Python 3.7.1+ pipx Running snappy data server

Install

pipx

python -m pip install --user pipx

Snappy CLI

To facilitate your use of snappy, define an environment variable, DATA_SERVER_URL, to point to your snappy data server.

pipx install git+https://github.com/cloud-bulldozer/data-server-cli.git
snappy install

Upgrade

pipx install --force git+https://cloud-bulldozer/data-server-cli.git

Example

Usage is automatically documented by Typer.

Post a file

Usage: snappy post-file [OPTIONS] FILEPATH

Arguments:
  FILEPATH  [required]

Options:
  --url TEXT      [env var: DATA_SERVER_URL; default: http://localhost:7070]
  --filedir TEXT  [env var: SNAPPY_FILE_DIR; default: ]
  -s, --silent    [default: False]
  --help          Show this message and exit.

Snappy's default root storage directory is called data_server. You can create a subdirectory within Snappy's storage directory by using the --filedir option, or the SNAPPY_FILE_DIR environment variable.

Help

Available commands can be listed with or without the help option.

$ snappy
Usage: snappy [OPTIONS] COMMAND [ARGS]...

Options:
  --install-completion  Install completion for the current shell.
  --show-completion     Show completion for the current shell, to copy it or
                        customize the installation.

  --help                Show this message and exit.

Commands:
  install       Automatically add required system resource for snappy cli
  login         Login to a snappy data server with a prompt.
  logout
  post-file
  script-login  Login to a snappy data server with a shell script using...

Help with a command.

  snappy <cmd> --help
$ snappy script-login --help
Usage: snappy script-login [OPTIONS] DATA_SERVER_USERNAME
                            DATA_SERVER_PASSWORD

  Login to a snappy data server with a shell script using environment
  variables.

Arguments:
  DATA_SERVER_USERNAME  [env var: DATA_SERVER_USERNAME;required]
  DATA_SERVER_PASSWORD  [env var: DATA_SERVER_PASSWORD;required]
  SNAPPY_FILE_DIR       [env var: SNAPPY_FILE_DIR; optional]

Options:
  --data-server-url TEXT  [env var: DATA_SERVER_URL; default:
                          http://localhost:7070]

  --help                  Show this message and exit.

Authentication and post

$ snappy login

Enter credentials.

Username:
Password:
$ snappy post-file ./hat.jpg

Will display a progress bar that shows approximate upload progress. Disable the progress bar with -s/--silent.

When you're done

snappy logout