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

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:

• Update PATH on Windows
• Update PATH on Linux

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

1. Copy and paste certificates from <control_services_backend>/certs/ca.crt as ./certs/dev-backend.crt and <accelerator_service>/minio_certs/ca.crt as ./certs/dev-minio-ca.crt.
2. Run as Administrator

   cd 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/*