PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

2.0.13

PyPI

accli

IIASA Accelerator Client

Published15 Oct 2026
Direct dependencies8
Transitive dependenciesNot calculated

README

Version 2.0.13 documentation

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:

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

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 8

Native requirements
8 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
urllib3
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
urllib3>=1.26.5runtime
typer
Environment
{
  "extras": "all",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
typer[all]>=0.4.0runtime
tinydb
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
tinydb>=4.5.2runtime
requests
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
requests>=2.25.1runtime
jsonschema
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
jsonschema>=4.5.1runtime
pydantic
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
pydantic>=2.0runtime
GitPython
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
GitPythonruntime
hf-xet
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.7",
  "evaluation": "NOT_EVALUATED"
}
hf-xet==1.5.2runtime

Distribution files

2 collected
accli-2.0.13-py3-none-any.whl

bdist_wheel · 54.52 KB · Python py3

Source file
accli-2.0.13.tar.gz

sdist · 53.23 KB · Python source

Source file

Repository

PENDING
iiasa/accli

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:59 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:122aa61c8e604fd438c2ff15898db09e8a90937e02f40b1357fab03c27211c2a

Other collected versions

View all collected versions →