diff options
author | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:59:27 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-05-18 04:59:27 +0000 |
commit | b21afeec20963de1f9263563d85f1e1a37636b69 (patch) | |
tree | ebed9f4b917d29cf80867ea286db5a3e44d9cf18 | |
parent | 22ce59be0d332723d069ea190492587bd1999c8d (diff) |
automatic import of python-aries-cloudcontroller
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-aries-cloudcontroller.spec | 533 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 535 insertions, 0 deletions
@@ -0,0 +1 @@ +/aries_cloudcontroller-0.7.0.tar.gz diff --git a/python-aries-cloudcontroller.spec b/python-aries-cloudcontroller.spec new file mode 100644 index 0000000..7df9e19 --- /dev/null +++ b/python-aries-cloudcontroller.spec @@ -0,0 +1,533 @@ +%global _empty_manifest_terminate_build 0 +Name: python-aries-cloudcontroller +Version: 0.7.0 +Release: 1 +Summary: A simple python package for controlling an aries agent through the admin-api interface +License: Apache Software License +URL: https://github.com/didx-xyz/aries-cloudcontroller-python/tree/main/aries_cloudcontroller +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/55/ff/9f861447a672abec578d2a1bb314c58a43f4987313a3cfc12b36cf2bf80c/aries_cloudcontroller-0.7.0.tar.gz +BuildArch: noarch + +Requires: python3-aiohttp +Requires: python3-uplink[aiohttp,pydantic] + +%description +<p align="center"> + <br /> + <img + alt="Hyperledger Aries logo" + src="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/assets/aries-logo.png" + height="250px" + /> +</p> +<h1 align="center"><b>Aries Cloud Controller Python</b></h1> +<p align="center"> + <img + alt="Pipeline Status" + src="https://github.com/didx-xyz/aries-cloudcontroller-python/actions/workflows/python-publish.yml/badge.svg?branch=main" + /> + <a href="https://pypi.org/project/aries-cloudcontroller/"> + <img alt="aries-cloudcontroller version" src="https://badge.fury.io/py/aries-cloudcontroller.svg"/> + </a> + <a + href="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/LICENSE" + ><img + alt="License" + src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" + /></a> + <a href="https://www.python.org/" + ><img + alt="Python" + src="https://img.shields.io/badge/%3C%2F%3E-Python-%230074c1.svg" + /></a> +</p> +<br /> + +<p align="center"> + <a href="#features">Features</a> | + <a href="#usage">Usage</a> | + <a href="#available-apis">Available APIs</a> | + <a href="#contributing">Contributing</a> | + <a href="#license">License</a> +</p> + +Aries Cloud Controller Python is a client library written in Python for interacting with an [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python) instance. It is generated based on the OpenAPI definition provided by ACA-Py, giving a fully-typed rich API for interacting the cloud agent. + +Each Cloud Controller version maps to a specific ACA-Py version, which is outlined in the table below. Although not strictly adhered to in the past, a new ACA-Py version will result in a new Minor version bump for the Cloud Controller, as there are often times breaking changes. + +| Aries Cloud Controller Version | Aries Cloud Agent Python Version | +| ------------------------------ | -------------------------------- | +| 0.5.1-0.5.2 | 0.7.3 | +| 0.6.0-0.6.3 | 0.7.4 | +| 0.7.0 | 0.7.5 | + +## Features + +Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py. + +- Fully Typed wrapper around Aries Cloud Agent Python +- Supports latest ACA-Py version (0.7.5) +- Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases. +- Supports multi-tenant APIs and authentication +- Async API + +## Usage + +Aries Cloud Controller Python is published to PyPi and can be installed using pip: + +```sh +pip install aries-cloudcontroller +``` + +### Creating a client + +```python +from aries_cloudcontroller import AcaPyClient + +client = AcaPyClient( + base_url="http://localhost:8000", + api_key="myApiKey" +) +``` + +**Admin insecure mode** + +If you are running ACA-Py with the admin insecure flag and don't have the API key, you must set the `admin_insecure` property: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + # Explicitly mark that no api key is used + admin_insecure=True +) +``` + +**Multitenancy** + +To provision the agent in the context of specific tenant of the agent, the `tenant_jwt` property must be set: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + tenant_jwt="eyXXX" +) +``` + +### Interacting with the client + +Once you have the client set up, you're ready to interact with it. Because the API is fully typed, the best way to know what is available is by looking at the ACA-Py swagger UI, and the available properties on the client. + +For example to create and receive an invitation the following methods can be called: + +```python +invitation = await client.connection.create_invitation( + body=CreateInvitationRequest(my_label="Cloud Controller") +) + +connection = await client.connection.receive_invitation(body=result.invitation) +``` + +## Available APIs + +Currently the following top-level APIs are available in the client. Each api maps to the topics as used by the ACA-Py swagger UI. + +- `action_menu` +- `basicmessage` +- `connection` +- `credential_definition` +- `credentials` +- `default` +- `did_exchange` +- `discover_features` +- `discover_features_v2_0` +- `endorse_transaction` +- `introduction` +- `issue_credential_v1_0` +- `issue_credential_v2_0` +- `jsonld` +- `ledger` +- `mediation` +- `multitenancy` +- `out_of_band` +- `present_proof_v1_0` +- `present_proof_v2_0` +- `resolver` +- `revocation` +- `schema` +- `server` +- `trustping` +- `wallet` + +## Contributing + +If you would like to contribute to the framework, please read [CONTRIBUTING](/CONTRIBUTING.md) guidelines. These documents will provide more information to get you started! + +## License + +Aries Cloud Controller Python is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE). + + +%package -n python3-aries-cloudcontroller +Summary: A simple python package for controlling an aries agent through the admin-api interface +Provides: python-aries-cloudcontroller +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-aries-cloudcontroller +<p align="center"> + <br /> + <img + alt="Hyperledger Aries logo" + src="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/assets/aries-logo.png" + height="250px" + /> +</p> +<h1 align="center"><b>Aries Cloud Controller Python</b></h1> +<p align="center"> + <img + alt="Pipeline Status" + src="https://github.com/didx-xyz/aries-cloudcontroller-python/actions/workflows/python-publish.yml/badge.svg?branch=main" + /> + <a href="https://pypi.org/project/aries-cloudcontroller/"> + <img alt="aries-cloudcontroller version" src="https://badge.fury.io/py/aries-cloudcontroller.svg"/> + </a> + <a + href="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/LICENSE" + ><img + alt="License" + src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" + /></a> + <a href="https://www.python.org/" + ><img + alt="Python" + src="https://img.shields.io/badge/%3C%2F%3E-Python-%230074c1.svg" + /></a> +</p> +<br /> + +<p align="center"> + <a href="#features">Features</a> | + <a href="#usage">Usage</a> | + <a href="#available-apis">Available APIs</a> | + <a href="#contributing">Contributing</a> | + <a href="#license">License</a> +</p> + +Aries Cloud Controller Python is a client library written in Python for interacting with an [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python) instance. It is generated based on the OpenAPI definition provided by ACA-Py, giving a fully-typed rich API for interacting the cloud agent. + +Each Cloud Controller version maps to a specific ACA-Py version, which is outlined in the table below. Although not strictly adhered to in the past, a new ACA-Py version will result in a new Minor version bump for the Cloud Controller, as there are often times breaking changes. + +| Aries Cloud Controller Version | Aries Cloud Agent Python Version | +| ------------------------------ | -------------------------------- | +| 0.5.1-0.5.2 | 0.7.3 | +| 0.6.0-0.6.3 | 0.7.4 | +| 0.7.0 | 0.7.5 | + +## Features + +Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py. + +- Fully Typed wrapper around Aries Cloud Agent Python +- Supports latest ACA-Py version (0.7.5) +- Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases. +- Supports multi-tenant APIs and authentication +- Async API + +## Usage + +Aries Cloud Controller Python is published to PyPi and can be installed using pip: + +```sh +pip install aries-cloudcontroller +``` + +### Creating a client + +```python +from aries_cloudcontroller import AcaPyClient + +client = AcaPyClient( + base_url="http://localhost:8000", + api_key="myApiKey" +) +``` + +**Admin insecure mode** + +If you are running ACA-Py with the admin insecure flag and don't have the API key, you must set the `admin_insecure` property: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + # Explicitly mark that no api key is used + admin_insecure=True +) +``` + +**Multitenancy** + +To provision the agent in the context of specific tenant of the agent, the `tenant_jwt` property must be set: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + tenant_jwt="eyXXX" +) +``` + +### Interacting with the client + +Once you have the client set up, you're ready to interact with it. Because the API is fully typed, the best way to know what is available is by looking at the ACA-Py swagger UI, and the available properties on the client. + +For example to create and receive an invitation the following methods can be called: + +```python +invitation = await client.connection.create_invitation( + body=CreateInvitationRequest(my_label="Cloud Controller") +) + +connection = await client.connection.receive_invitation(body=result.invitation) +``` + +## Available APIs + +Currently the following top-level APIs are available in the client. Each api maps to the topics as used by the ACA-Py swagger UI. + +- `action_menu` +- `basicmessage` +- `connection` +- `credential_definition` +- `credentials` +- `default` +- `did_exchange` +- `discover_features` +- `discover_features_v2_0` +- `endorse_transaction` +- `introduction` +- `issue_credential_v1_0` +- `issue_credential_v2_0` +- `jsonld` +- `ledger` +- `mediation` +- `multitenancy` +- `out_of_band` +- `present_proof_v1_0` +- `present_proof_v2_0` +- `resolver` +- `revocation` +- `schema` +- `server` +- `trustping` +- `wallet` + +## Contributing + +If you would like to contribute to the framework, please read [CONTRIBUTING](/CONTRIBUTING.md) guidelines. These documents will provide more information to get you started! + +## License + +Aries Cloud Controller Python is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE). + + +%package help +Summary: Development documents and examples for aries-cloudcontroller +Provides: python3-aries-cloudcontroller-doc +%description help +<p align="center"> + <br /> + <img + alt="Hyperledger Aries logo" + src="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/assets/aries-logo.png" + height="250px" + /> +</p> +<h1 align="center"><b>Aries Cloud Controller Python</b></h1> +<p align="center"> + <img + alt="Pipeline Status" + src="https://github.com/didx-xyz/aries-cloudcontroller-python/actions/workflows/python-publish.yml/badge.svg?branch=main" + /> + <a href="https://pypi.org/project/aries-cloudcontroller/"> + <img alt="aries-cloudcontroller version" src="https://badge.fury.io/py/aries-cloudcontroller.svg"/> + </a> + <a + href="https://raw.githubusercontent.com/didx-xyz/aries-cloudcontroller-python/main/LICENSE" + ><img + alt="License" + src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" + /></a> + <a href="https://www.python.org/" + ><img + alt="Python" + src="https://img.shields.io/badge/%3C%2F%3E-Python-%230074c1.svg" + /></a> +</p> +<br /> + +<p align="center"> + <a href="#features">Features</a> | + <a href="#usage">Usage</a> | + <a href="#available-apis">Available APIs</a> | + <a href="#contributing">Contributing</a> | + <a href="#license">License</a> +</p> + +Aries Cloud Controller Python is a client library written in Python for interacting with an [Aries Cloud Agent Python](https://github.com/hyperledger/aries-cloudagent-python) instance. It is generated based on the OpenAPI definition provided by ACA-Py, giving a fully-typed rich API for interacting the cloud agent. + +Each Cloud Controller version maps to a specific ACA-Py version, which is outlined in the table below. Although not strictly adhered to in the past, a new ACA-Py version will result in a new Minor version bump for the Cloud Controller, as there are often times breaking changes. + +| Aries Cloud Controller Version | Aries Cloud Agent Python Version | +| ------------------------------ | -------------------------------- | +| 0.5.1-0.5.2 | 0.7.3 | +| 0.6.0-0.6.3 | 0.7.4 | +| 0.7.0 | 0.7.5 | + +## Features + +Aries Cloud Controller Python is a fully featured client for interacting with ACA-Py. + +- Fully Typed wrapper around Aries Cloud Agent Python +- Supports latest ACA-Py version (0.7.5) +- Client is auto generated based on OpenAPI definitions, allowing us to keep up to date with new releases. +- Supports multi-tenant APIs and authentication +- Async API + +## Usage + +Aries Cloud Controller Python is published to PyPi and can be installed using pip: + +```sh +pip install aries-cloudcontroller +``` + +### Creating a client + +```python +from aries_cloudcontroller import AcaPyClient + +client = AcaPyClient( + base_url="http://localhost:8000", + api_key="myApiKey" +) +``` + +**Admin insecure mode** + +If you are running ACA-Py with the admin insecure flag and don't have the API key, you must set the `admin_insecure` property: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + # Explicitly mark that no api key is used + admin_insecure=True +) +``` + +**Multitenancy** + +To provision the agent in the context of specific tenant of the agent, the `tenant_jwt` property must be set: + +```python +client = AcaPyClient( + base_url="http://localhost:8000", + tenant_jwt="eyXXX" +) +``` + +### Interacting with the client + +Once you have the client set up, you're ready to interact with it. Because the API is fully typed, the best way to know what is available is by looking at the ACA-Py swagger UI, and the available properties on the client. + +For example to create and receive an invitation the following methods can be called: + +```python +invitation = await client.connection.create_invitation( + body=CreateInvitationRequest(my_label="Cloud Controller") +) + +connection = await client.connection.receive_invitation(body=result.invitation) +``` + +## Available APIs + +Currently the following top-level APIs are available in the client. Each api maps to the topics as used by the ACA-Py swagger UI. + +- `action_menu` +- `basicmessage` +- `connection` +- `credential_definition` +- `credentials` +- `default` +- `did_exchange` +- `discover_features` +- `discover_features_v2_0` +- `endorse_transaction` +- `introduction` +- `issue_credential_v1_0` +- `issue_credential_v2_0` +- `jsonld` +- `ledger` +- `mediation` +- `multitenancy` +- `out_of_band` +- `present_proof_v1_0` +- `present_proof_v2_0` +- `resolver` +- `revocation` +- `schema` +- `server` +- `trustping` +- `wallet` + +## Contributing + +If you would like to contribute to the framework, please read [CONTRIBUTING](/CONTRIBUTING.md) guidelines. These documents will provide more information to get you started! + +## License + +Aries Cloud Controller Python is licensed under the [Apache License Version 2.0 (Apache-2.0)](/LICENSE). + + +%prep +%autosetup -n aries-cloudcontroller-0.7.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-aries-cloudcontroller -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu May 18 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.0-1 +- Package Spec generated @@ -0,0 +1 @@ +6ae8cb052e983c305905b5d22d8e364e aries_cloudcontroller-0.7.0.tar.gz |