Skip to content

⬆️ Release 1.2.1-20250213 #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 20 commits into from
Feb 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install \
isort~=5.13.2 \
black~=24.10.0
isort~=6.0.0 \
black~=25.1.0
- name: Check import style with isort
run: |
isort . --check --profile black --diff
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-test-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ jobs:
run: |
python -m pip install --upgrade pip
pip install \
isort~=5.13.2 \
black~=24.10.0
isort~=6.0.0 \
black~=25.1.0
- name: Check import style with isort
run: |
isort . --check --profile black --diff
Expand Down
30 changes: 21 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,23 +33,32 @@
<a href="#license">License</a>
</p>

The Aries CloudController is a Python-based client library for interacting with an instance of [Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) (ACA-Py). It leverages the OpenAPI definition from ACA-Py to provide a fully-typed, rich API experience for cloud agent interaction.
The Aries CloudController is a Python-based client library for interacting with an instance of
[Aries Cloud Agent](https://github.com/hyperledger/aries-cloudagent-python) (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.
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.
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.
- **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
Expand Down Expand Up @@ -93,7 +102,8 @@ client = AcaPyClient(

### Interacting with the Client

The API, being fully typed, is best explored through the ACA-Py Swagger UI, which mirrors the available client properties.
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:

Expand All @@ -113,6 +123,7 @@ The client encompasses various APIs, each corresponding to ACA-Py Swagger UI top
- `anoncreds_credential_definitions`
- `anoncreds_revocation`
- `anoncreds_schemas`
- `anoncreds_wallet_upgrade`
- `basicmessage`
- `connection`
- `credential_definition`
Expand Down Expand Up @@ -144,7 +155,8 @@ The client encompasses various APIs, each corresponding to ACA-Py Swagger UI top

## Contributing

Contributions are welcome! Please see our [CONTRIBUTING](/CONTRIBUTING.md) guidelines for more information on how to get involved.
Contributions are welcome! Please see our [CONTRIBUTING](/CONTRIBUTING.md) guidelines
for more information on how to get involved.

## License

Expand Down
15 changes: 9 additions & 6 deletions aries_cloudcontroller/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
# flake8: noqa

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501


__version__ = "1.2.0-20241205"
__version__ = "1.2.1-20250213"

from aries_cloudcontroller.acapy_client import AcaPyClient

Expand Down Expand Up @@ -243,6 +243,7 @@
LedgerConfigInstance,
LedgerConfigList,
LinkedDataProof,
ListCredentialsResponse,
MediationDeny,
MediationGrant,
MediationIdMatchInfo,
Expand Down Expand Up @@ -326,6 +327,8 @@
SignedDoc,
SignRequest,
SignResponse,
StoreCredentialRequest,
StoreCredentialResponse,
SubmissionRequirements,
TAAAccept,
TAAAcceptance,
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/action_menu_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/anoncreds_revocation_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/anoncreds_schemas_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/anoncreds_wallet_upgrade_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/basicmessage_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
16 changes: 9 additions & 7 deletions aries_cloudcontroller/api/connection_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

import warnings
Expand Down Expand Up @@ -879,13 +879,15 @@ async def get_connections(
Field(description="Identifier of the associated Invitation Message"),
] = None,
limit: Annotated[
Optional[StrictInt], Field(description="Number of results to return")
Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]],
Field(description="Number of results to return"),
] = None,
my_did: Annotated[
Optional[Annotated[str, Field(strict=True)]], Field(description="My DID")
] = None,
offset: Annotated[
Optional[StrictInt], Field(description="Offset for pagination")
Optional[Annotated[int, Field(strict=True, ge=0)]],
Field(description="Offset for pagination"),
] = None,
order_by: Annotated[
Optional[StrictStr],
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/credential_definition_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
16 changes: 9 additions & 7 deletions aries_cloudcontroller/api/credentials_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down Expand Up @@ -444,10 +444,12 @@ async def get_records(
),
] = None,
limit: Annotated[
Optional[StrictInt], Field(description="Number of results to return")
Optional[Annotated[int, Field(le=10000, strict=True, ge=1)]],
Field(description="Number of results to return"),
] = None,
offset: Annotated[
Optional[StrictInt], Field(description="Offset for pagination")
Optional[Annotated[int, Field(strict=True, ge=0)]],
Field(description="Offset for pagination"),
] = None,
start: Annotated[
Optional[Annotated[str, Field(strict=True)]],
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/default_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

from typing import Any, Dict, List, Optional, Tuple, Union
Expand Down
10 changes: 5 additions & 5 deletions aries_cloudcontroller/api/did_exchange_api.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# coding: utf-8

"""
Aries Cloud Agent
Aries Cloud Agent

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1.2.0.post20241205
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: v1.2.1.post20250213
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501

import warnings
Expand Down
Loading