Datatrail CLI
Install · Docs
🛠️ Installation
Python 3.10 or newer is required for the supported dependency versions.
Install from PYPI
pip install datatrail-cli
Clone the repository
git clone https://github.com/CHIMEFRB/datatrail-cli
cd datatrail-cli
pip install .
⚙️ Configuration
Local
# Create Datatrail config file
datatrail config init --site local
# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]
CANFAR
The Configuration steps at CANFAR are similar to the local configuration.
One notable exception is that after installation, the datatrail command
may not be in the PATH. It is installed to ~/.local/bin, in which case
you may need to add it to your PATH or prepend it to the follwing commands.
# Create Datatrail config file
datatrail config init --site canfar
# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]
CHIME
# Create Datatrail config file
datatrail config init --site chime
# Ensure valid CADC Certificate exists
cadc-get-cert -u [username]
Building the documentation
From the repository root, install the locked documentation dependencies with uv, then build the standalone public site:
uv sync --locked --group docs
uv run --no-sync mkdocs build --strict --config-file mkdocs-site.yml
The site is written to site/. To preview it locally, run
uv run --no-sync mkdocs serve --config-file mkdocs-site.yml.
The installed checkout supplies the generated CLI reference. mkdocs-site.yml
adds the public site's theme and rendering extensions while inheriting the
navigation from mkdocs.yml, which remains the handbook configuration.
Release files for datatrail-cli 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| datatrail_cli-1.0.2.tar.gz | 1.5 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| datatrail_cli-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.6 MB
Release files / datatrail_cli-1.0.2.tar.gz
| Download URL | datatrail_cli-1.0.2.tar.gz |
|---|---|
| Size | 1.5 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bfc54bec5f6c3768791fd3b97a1544fd9556a82b45c8c1b12cf1c6d0520614a7
|
|
BLAKE2b-256 checksum How to use checksums |
4b6d8849b6611682cfa507579f54740c425c09188bec269e71593466bf9d9a8e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.20 {"installer":{"name":"uv","version":"0.12.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / datatrail_cli-1.0.2-py3-none-any.whl
| Download URL | datatrail_cli-1.0.2-py3-none-any.whl |
|---|---|
| Size | 53.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f998bab276e7eac04e362387e31ca7f9d510c71e9721c61783bc41b6be8f5376
|
|
BLAKE2b-256 checksum How to use checksums |
d4b047628d846fcb32a194d22fc09405d8b6314d9462f0b00d1b8424735f71e0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.20 {"installer":{"name":"uv","version":"0.12.20","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
