A CLI to interact with AusTrakka
Project description
AusTrakka CLI
CLI for AusTrakka V2
Environment Variables
Name | Description |
---|---|
AT_TOKEN |
AusTrakka auth token |
AT_URI |
URI for API endpoint |
AT_ENV |
Set to dev to log debugging |
AT_LOG |
Set to file to redirecting logging to a temp file |
AT_CMD_SET |
Set to austrakka-admin to display admin commands |
All commands require AT_URI
and AT_TOKEN
to be set, except for auth
commands.
Authorisation
User
Set the following env var
export AT_TOKEN=$(austrakka auth user)
Process
Set the following env var
export AT_TOKEN=$(austrakka auth process)
Project Structure
Each logical component of the system has its own package under austrakka/
. Eg. austrakka/job
.
Components that are children of another component are nested beneath. Eg. austrakka/job/instance
.
Each component package contains the following files:
File | Purpose |
---|---|
__init__.py |
Contains the Click commands offered by the component. Note that even if a component does not have any commands associated with it, this file must exist for the final build to include it. |
funcs.py |
Any functions associated with the component. |
opts.py |
Click command line options associated with the component. Defined here so they can be reused across the CLI. Eg. --species is used for multiple commands. The species CLI option is defined here and imported to all commands that use it. |
enums.py |
Any enumerations associated with the component. |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
austrakka-0.21.0.tar.gz
(31.1 kB
view hashes)
Built Distribution
austrakka-0.21.0-py3-none-any.whl
(52.5 kB
view hashes)
Close
Hashes for austrakka-0.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f50014e7f3188335be59a3e8e8273754745f71f9543c1a4040a923062d99eff8 |
|
MD5 | de397e772f0f72e51f6962f57ae703b9 |
|
BLAKE2b-256 | 87be3cc2d86c53ebb1c4b2b222ea10960662bbd54745d62c949abc6514431ec5 |