gen3-tracker
Note
The tools listed here are under development and may be subject to change
Installing g3t¶
The gen3-tracker (g3t) tool requires a working Python 3 installation no older than Python 3.10. Run the following in your working directory to install the latest version of g3t from the Python Package Index:
# Optionally create a virtual environment
python3 -m venv venv; source venv/bin/activate
pip install gen3_util
You can verify the installation was successful by then running the g3t command with the expected output being the latest version:
Upgrading g3t¶
This version should match the latest version on the PyPi page. If it is out of date, simply run the following to upgrade your local version:
Configuration¶
g3t uses the gen3-client configuration flow.
After configuration, you can either specify the --profile option or set the GEN3_UTIL_PROFILE=profile-name environmental variable.
Testing the configuration¶
The command g3t ping will confirm that the access key and gen3-client have been configured correctly
g3t ping
msg: 'Configuration OK: Connected using profile:production'
endpoint: https://aced-idp.org
username: someone@example.com
Usage¶
g3t [OPTIONS] COMMAND [ARGS]...
The following options and environmental variables are synonymous, you may set them as environmental variables or pass them as parameters to the command line.
| option | environment | comment | example |
|---|---|---|---|
| --project_id | G3T_PROJECT_ID | authorization | |
| --profile | G3T_PROFILE | gen3-client profile | |
| --format | G3T_FORMAT | Output format. | yaml |
Alternatively, you can set the environmental variables using the EXPORT function e.g.: