A CLI to interact with AusTrakka
Project description
AusTrakka CLI
Command line interface for AusTrakka V2.
Installation
Install with
pip install austrakka
You will need to set the environment variable AT_URI
:
export AT_URI="https://apimgwdev.austrakka.net.au/prod/v1"
You may wish to add this to your .bashrc
or .zshrc
file.
To use the CLI, you must log in by setting the AT_TOKEN
environment variable using the
austrakka user auth
command (see User Authorisation, below). You may wish to configure
a login command for convenience:
alias at-login="export AT_TOKEN=\$(austrakka auth user)"
You may wish to add this to your .bashrc
or .zshrc
file.
Install into a conda environment (optional)
If you wish to create a conda environment named austrakka
with the necessary environment
variables set and the at-login
alias, run:
conda create -n austrakka python=3.9
conda activate austrakka
pip install austrakka
conda env config vars set AT_URI="https://apimgwdev.austrakka.net.au/prod/v1"
mkdir -p ${CONDA_PREFIX}/etc/conda/activate.d
echo "alias at-login=\"export AT_TOKEN=\\\$(austrakka auth user)\"" > ${CONDA_PREFIX}/etc/conda/activate.d/austrakka-alias.sh
You can then use
conda activate austrakka
at-login
in order to use the CLI.
Updating the CLI
To update to the latest version, run
pip install --upgrade austrakka
If you have installed the CLI into a conda environment, you should first activate it with conda activate austrakka
.
Running the CLI
Before you can use the CLI, you must log in as described below, to allow the CLI to use your AusTrakka credentials. Your authorisation will expire after a period and you will need to log in again.
User Authorisation
Most users will want to use the CLI this way.
Set the following environment variable:
export AT_TOKEN=$(austrakka auth user)
If you have configured a login command as described above, you can instead run
at-login
Either way, you should be directed to log in via a browser and enter a code to authorise the CLI.
Process Authorisation
This authorisation mode is intended for long-term automated processes. Most users will not need it.
To authorise with a process token, set the environment variable using:
export AT_TOKEN=$(austrakka auth process)
Using the CLI
The CLI has a subcommand structure. Run
austrakka -h
to see available subcommands.
Run e.g.
austrakka metadata -h
to see available commands to manipulate metadata.
Run e.g.
austrakka metadata add -h
to see the usage of the metadata add
command to upload metadata files.
Environment Variables Reference
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 (these will not actually run successfully unless you have an appropriate role on the server) |
All commands require AT_URI
and AT_TOKEN
to be set, except for auth
commands.
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 Distributions
Built Distribution
Hashes for austrakka-0.23.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2cff07076abfb382d096a2650e87299b50ec55825fbcabc88c835507a9afb6f3 |
|
MD5 | 21347fada29fd7500a51a8783eeeb40d |
|
BLAKE2b-256 | fcf16b46ab2239d81647260fc8a1200e38c5d5c8b60e05842a2babd4d0c9f266 |