Aries CloudController Python
Features | Usage | Available APIs | Contributing | License
The Aries CloudController is a Python-based client library for interacting with an instance of Aries Cloud Agent (ACA-Py). It leverages the OpenAPI definition from ACA-Py to provide a fully-typed, rich API experience for cloud agent interaction.
Versioning Update: As of version 0.8.0, the Aries CloudController has aligned its versioning with ACA-Py. This means that each new version of ACA-Py will correspond directly to the same version of the Aries CloudController. This change ensures a more straightforward and predictable upgrade path for users.
In other words, CloudController 0.8.0 is compatible with ACA-Py 0.8.0, CloudController 0.9.0 is compatible with ACA-Py 0.9.0, etc.
For legacy versions, please review our release history to found the version compatible with ACA-Py pre-0.8.0.
Features
Aries CloudController Python provides a robust client for interacting with Aries Cloud Agents (ACA-Py).
- Fully Typed: Offers a strongly-typed wrapper around the Aries Cloud Agent Python, enhancing developer experience and reducing errors.
- Up-to-Date Support: Compatible with the latest ACA-Py version (1.1.0), ensuring access to the most recent features and improvements.
- Auto-Generated Client: Utilizes OpenAPI definitions for automatic generation, ensuring timely updates in line with new ACA-Py releases.
- Multi-Tenancy and Authentication Support: Facilitates working with multi-tenant APIs and integrates various authentication mechanisms.
- Asynchronous API: Supports asynchronous operations, enabling efficient handling of I/O-bound tasks.
Usage
Install Aries Cloud Controller Python via pip:
pip install aries-cloudcontroller
Creating a Client
Easily initialize the AcaPyClient:
from aries_cloudcontroller import AcaPyClient
client = AcaPyClient(
base_url="http://localhost:8000",
api_key="myApiKey"
)
Admin Insecure Mode: If running ACA-Py with the --admin-insecure-mode flag and without an API key:
client = AcaPyClient(
base_url="http://localhost:8000",
admin_insecure=True # No API key needed
)
Multitenancy: For specific tenant contexts:
client = AcaPyClient(
base_url="http://localhost:8000",
tenant_jwt="eyXXX"
)
Interacting with the Client
The API, being fully typed, is best explored through the ACA-Py Swagger UI, which mirrors the available client properties.
Example: Creating and receiving an invitation:
invitation = await client.connection.create_invitation(
body=CreateInvitationRequest(my_label="Cloud Controller")
)
connection = await client.connection.receive_invitation(body=invitation.invitation)
Available APIs
The client encompasses various APIs, each corresponding to ACA-Py Swagger UI topics:
action_menuanoncreds_credential_definitionsanoncreds_revocationanoncreds_schemasanoncreds_wallet_upgradebasicmessageconnectioncredential_definitioncredentialsdefaultdid_exchangedid_rotatediscover_featuresdiscover_features_v2_0endorse_transactionintroductionissue_credential_v1_0issue_credential_v2_0jsonldledgermediationmultitenancyout_of_bandpresent_proof_v1_0present_proof_v2_0resolverrevocationschemaserversettingstrustpingvcwallet
Contributing
Contributions are welcome! Please see our CONTRIBUTING guidelines for more information on how to get involved.
License
This project is licensed under the Apache License Version 2.0 (Apache-2.0).
Metadata
Release files for aries-cloudcontroller 1.3.0.post20250526
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| aries_cloudcontroller-1.3.0.post20250526.tar.gz | 179.4 kB | Without provenance | Details for aries_cloudcontroller-1.3.0.post20250526.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| aries_cloudcontroller-1.3.0.post20250526-py3-none-any.whl | Python 3 | none | any | Details for aries_cloudcontroller-1.3.0.post20250526-py3-none-any.whl |
Total release size: 872.5 kB
Release files / aries_cloudcontroller-1.3.0.post20250526.tar.gz
| Download URL | aries_cloudcontroller-1.3.0.post20250526.tar.gz |
|---|---|
| Size | 179.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8f4cc4a9a037c446c22279299ac1d019ab2ba7ddf60f55c2ab7529a917ff073e
|
|
BLAKE2b-256 checksum How to use checksums |
7c4d11c5e8cb8caba8480441d3c045e6c63eb28db2432fd1114f96286d098994
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Release files / aries_cloudcontroller-1.3.0.post20250526-py3-none-any.whl
| Download URL | aries_cloudcontroller-1.3.0.post20250526-py3-none-any.whl |
|---|---|
| Size | 693.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f251951814330a06b474e30cf96b8697433fb7129f42e3cc37700b727d023ad6
|
|
BLAKE2b-256 checksum How to use checksums |
7744b9236f0c5675a337bd179d9429e1482621f778b2e999e7a8d3cbbc82df3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Security for aries-cloudcontroller 1.3.0.post20250526
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.