Accelerator Terminal Client and Python API
This package provides:
- A command-line client (
accli) for interacting with the Accelerator. - A Python API via the
acclipackage.
Both interfaces communicate with the Accelerator’s REST API, implemented in the Control Services Backend.
🔐 Authentication
This client uses device authentication via Auth0.
- **OAuth Flow **: Device Authorization Flow
- Token Validity: 7 days
- Access Control: Role-Based Access Control (RBAC) with stateless tokens
- Grants: Limited and scoped
📖 User Guide
✅ Requirements
- Python >= 3.7.17
📦 Installation
Option 1: Standalone Binaries (Recommended)
No Python install required. Run the appropriate command for your system:
Linux / macOS:
curl -fsSL https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.sh | bash
Windows (PowerShell):
irm https://raw.githubusercontent.com/iiasa/accli/master/scripts/install.ps1 | iex
Option 2: Via PIP
pip install accli --user
▶️ Usage
As a Python Module
python -m accli
As an Executable
After installation, the executable might not be in your system PATH. You may see a warning like this:
WARNING: The script accli.exe is installed in 'C:\Users\<user>\AppData\Roaming\Python\Python311\Scripts' which is not on PATH.
Consider adding this directory to PATH or, if you prefer to suppress this warning, use --no-warn-script-location.
To resolve this, add the script's path to your system's environment variables:
Note: On Linux/macOS, you may need to prefix the command with
./, and on Windows, with.\.
🔍 Help Command
accli --help
Sample Output:
Usage: accli [OPTIONS] COMMAND [ARGS]...
👩💻 Developer Guide
Handling self-signed certificates
- Copy and paste certificates from
<control_services_backend>/certs/ca.crtas./certs/dev-backend.crtand<accelerator_service>/minio_certs/ca.crtas./certs/dev-minio-ca.crt. - Run
cd scripts import_certs_certutil.ps1
🛠 Build & Upload
Follow the official Python packaging tutorial:
Packaging Projects – Python.org
🚀 Release Process
-
Update the version in
accli/_version.py -
Tag the release:
python scripts/tag.py -
Build the package:
python -m build
-
Upload to PyPI:
twine upload -r pypi -u __token__ -p <password-or-token> ./dist/*
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file accli-2.0.0.tar.gz.
File metadata
- Download URL: accli-2.0.0.tar.gz
- Upload date:
- Size: 43.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ee8205dea1ee2df6bd61e1077f4506f90b5988e33779fd7d26b4a4f59b13076
|
|
| MD5 |
8a2c55aaeb89aaf3405d72939f1b41fe
|
|
| BLAKE2b-256 |
85f0aed34ed4bbfe568546b778b77911e4a01a0e424b906eee571aef30a10b4a
|
File details
Details for the file accli-2.0.0-py3-none-any.whl.
File metadata
- Download URL: accli-2.0.0-py3-none-any.whl
- Upload date:
- Size: 46.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.11.15
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6b4b796bc78fde78b83ff84149f5d49075a5b9dfa13e52b056693b84e1172889
|
|
| MD5 |
7b378e1cb20195803122f263376363d7
|
|
| BLAKE2b-256 |
b18da618f026165cabf2cceda3b27dd635d7918c72c972610231709c922542da
|
