Skip to main content

Accelerator Terminal Client and Python API

This package provides:

  • A command-line client (accli) for interacting with the Accelerator.
  • A Python API via the accli package.

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

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]...

📋 Jobs

List root jobs, newest first, with each job's type (standalone, children, callback or children+callback), its own status and the status of its whole graph:

accli jobs my-project                       # latest 10
accli jobs my-project -n 50
accli jobs my-project -s failed             # graphs with a failed job
accli jobs my-project -s processing,error

--status filters on the graph status: processing (or active), error (or failed) and done. A standalone job counts by its own status.

Show a job's status and details. For a job holding children or callbacks, Graph status covers the jobs below it (the same as GRAPH in accli jobs) and each one is listed; any job also links to the pipeline it is part of. Read a job's output with accli logs <project> <job>:

accli job my-project 1234
accli job my-project 1234 --json

👩‍💻 Developer Guide

Handling self-signed certificates

Import the certificates from accelerator_service into the Windows Root store (auto-elevates to Administrator if needed):

cd <path to>/accelerator_service/scripts
.\import_certs_certutil.ps1

🛠 Build & Upload

Follow the official Python packaging tutorial:
Packaging Projects – Python.org

🚀 Release Process

  1. Update the version in accli/_version.py

  2. Tag the release:

    python scripts/tag.py
    
  3. Build the package:

    python -m build
    
  4. Upload to PyPI:

    twine upload -r pypi -u __token__ -p <password-or-token> ./dist/*
    

Metadata

Release files for accli 2.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for accli 2.1.1
File Size Uploaded Provenance Actions
accli-2.1.1.tar.gz 65.0 kB Without provenance Details for accli-2.1.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for accli 2.1.1
File Interpreter ABI Platform Actions
accli-2.1.1-py3-none-any.whl Python 3 none any Details for accli-2.1.1-py3-none-any.whl

Total release size: 128.9 kB

Release files / accli-2.1.1.tar.gz

Download URL accli-2.1.1.tar.gz
Size 65.0 kB
Tags Source
SHA-256 checksum
How to use checksums
9624e235253371133c02a926b4e7de75dd6cf43a39192b6673810cdc8bc70dc7
BLAKE2b-256 checksum
How to use checksums
5a4c2bc9690a7700065fd21f33990eda45afcfb210785ae784ce38019785f2d7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Release files / accli-2.1.1-py3-none-any.whl

Download URL accli-2.1.1-py3-none-any.whl
Size 63.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
af37d162605936c9c3d46c9bcf5bb7aafd1ce25a702ed78d7e503e2a64ce1778
BLAKE2b-256 checksum
How to use checksums
db5dd6d421199ea16703d26f59dfd1f357fffbb33f1f175913698be7395f8993
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.17

Security for accli 2.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page