From 30fdd38ffaf4b3fd3f73969b53f639ca32d872f7 Mon Sep 17 00:00:00 2001 From: ff137 Date: Wed, 11 Dec 2024 19:29:27 +0200 Subject: [PATCH 01/10] :memo: Update README - Fixes Codacy badge links - Updates "under development" note --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index eb499c224..63cd33760 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # aries-cloudapi-python -[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ceca5ac566f74a3a8bfb3095074117ad)](https://www.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=github.com&utm_medium=referral&utm_content=didx-xyz/aries-cloudapi-python&utm_campaign=Badge_Grade) -[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ceca5ac566f74a3a8bfb3095074117ad)](https://www.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=github.com&utm_medium=referral&utm_content=didx-xyz/aries-cloudapi-python&utm_campaign=Badge_Coverage) +[![Codacy Badge](https://app.codacy.com/project/badge/Grade/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) +[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) -:construction: This project is currently under development. Please do not use -this in production. +:construction: This project is currently under development. If you would like to use +this in production, please contact us first to discuss your use case. ## Overview From 75dc75c87aaef0b48126d5ce2f667fd4c1bfd376 Mon Sep 17 00:00:00 2001 From: ff137 Date: Wed, 11 Dec 2024 23:25:36 +0200 Subject: [PATCH 02/10] :lipstick: Add more badges! --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 63cd33760..ab90c0805 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # aries-cloudapi-python +![Python](https://img.shields.io/badge/python-3.12-blue.svg) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![DIDx GitHub](https://img.shields.io/badge/GitHub-DIDx-181717.svg?style=flat&logo=github)](https://github.com/didx-xyz) +![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg) :construction: This project is currently under development. If you would like to use this in production, please contact us first to discuss your use case. From 5ff43aabe47f18df810c0c2c96aa59056671395a Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 12 Dec 2024 21:09:44 +0200 Subject: [PATCH 03/10] :lipstick: Edit badges --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ab90c0805..b21654abc 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ # aries-cloudapi-python ![Python](https://img.shields.io/badge/python-3.12-blue.svg) +[![Toolset: Mise](https://img.shields.io/badge/toolset-Mise-orange.svg?style=flat)](https://mise.jdx.dev/) +[![Dev Experience: Tilt](https://img.shields.io/badge/devex-Tilt-blue.svg?style=flat)](https://tilt.dev) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) -[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![DIDx GitHub](https://img.shields.io/badge/GitHub-DIDx-181717.svg?style=flat&logo=github)](https://github.com/didx-xyz) -![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg) +[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](./CONTRIBUTING.md) :construction: This project is currently under development. If you would like to use this in production, please contact us first to discuss your use case. From 1995d8b9ea748115821561bfeed4572986856f3e Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 12 Dec 2024 21:10:22 +0200 Subject: [PATCH 04/10] :art: Rename title --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b21654abc..165033826 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# aries-cloudapi-python +# didx-cloud ![Python](https://img.shields.io/badge/python-3.12-blue.svg) [![Toolset: Mise](https://img.shields.io/badge/toolset-Mise-orange.svg?style=flat)](https://mise.jdx.dev/) From 03f53a43450ca4ea43643ad2052d3d91e0b89afb Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 12 Dec 2024 22:28:59 +0200 Subject: [PATCH 05/10] :memo: Update overview --- README.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 165033826..5e111116d 100644 --- a/README.md +++ b/README.md @@ -14,24 +14,29 @@ this in production, please contact us first to discuss your use case. ## Overview -This project essentially comprises a [FastAPI](https://fastapi.tiangolo.com/) -application built around the -[Hyperledger Aries stack](https://github.com/hyperledger/), primarily tailored -for [Yoma](https://yoma.world)-specific use cases. +This project comprises a [FastAPI](https://fastapi.tiangolo.com/) application built +around [ACA-Py](https://github.com/openwallet-foundation/aries-cloudagent-python), +primarily tailored for [Yoma](https://yoma.world)-specific use cases. The FastAPI app serves as a wrapper around common workflows, facilitating -real-life applications of the stack. It acts as a form of middleware or interface -for client applications (e.g., a mobile app) and the backend stack, using -[Aries CloudController](https://github.com/didx-xyz/aries-cloudcontroller-python) -and [ACA-Py](https://github.com/openwallet-foundation/acapy). The aim is -to streamline a client's workflow by providing convenient API endpoints for -common workflows, such as creating wallets, managing connections, credentials, -proofs, and workflows. - -Multiple API calls to the AriesCloudAgent can often be condensed into a single -call via this API. For example, creating a wallet, which involves writing to the -ledger, awaiting the result, accepting a TAA, creating a DID, and finally -creating the wallet itself, can be done in a single call. Convenient, isn't it? +real-life applications of self-sovereign identity. It acts as an interface +for client applications (e.g., a mobile app) and the backend, using our +[OpenAPI client](https://github.com/didx-xyz/aries-cloudcontroller-python) and ACA-Py. + +Multiple API calls to ACA-Py can be condensed into a single call through this API. +For instance, onboarding an issuer — which involves creating a wallet, establishing a +connection with an endorser, generating a public DID, accepting the Transaction Author +Agreement (TAA), publishing the DID to the ledger, and awaiting confirmation — can all +be achieved with a single API call. Convenient, isn't it? + +We enable and simplify several key capabilities, including: + +- Creating and managing wallets +- Onboarding issuers and verifiers +- Managing connections between parties +- Creating schemas and credential definitions +- Issuing verifiable credentials and handling revocations +- Requesting and validating proofs ## How to Run It From e7082a1cd685a90de5558c543cae0829d3a56767 Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 12 Dec 2024 22:29:14 +0200 Subject: [PATCH 06/10] :art: Move Contributions badge --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5e111116d..dc223936e 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/ceca5ac566f74a3a8bfb3095074117ad)](https://app.codacy.com/gh/didx-xyz/aries-cloudapi-python/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![DIDx GitHub](https://img.shields.io/badge/GitHub-DIDx-181717.svg?style=flat&logo=github)](https://github.com/didx-xyz) -[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](./CONTRIBUTING.md) :construction: This project is currently under development. If you would like to use this in production, please contact us first to discuss your use case. @@ -150,11 +149,13 @@ You can find more detailed documentation in the ## Contributing +[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](./CONTRIBUTING.md) + While this project was primarily developed to meet the needs of [Yoma](https://yoma.world), it is an open-source project that can be used for other Hyperledger Aries projects as well. We welcome contributions from -everyone. Feel free to engage in discussions, create a PR against a ticket, or -open an issue yourself, following the GitHub guidelines. +everyone. Feel free to engage in discussions, create pull requests against +existing tickets, or open new issues following the GitHub guidelines. ## Running Tests From e8c20e7ea3657cf8dc589c701d00899ed36bea44 Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 12 Dec 2024 22:29:39 +0200 Subject: [PATCH 07/10] :art: Add contact us address --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dc223936e..5518ff3a0 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![DIDx GitHub](https://img.shields.io/badge/GitHub-DIDx-181717.svg?style=flat&logo=github)](https://github.com/didx-xyz) -:construction: This project is currently under development. If you would like to use -this in production, please contact us first to discuss your use case. +🚧 This project is currently under development. If you would like to use +this in production, please [contact us](mailto:info@didx.co.za) first to discuss your use case. ## Overview From d5f08d4cc5bb554073909ff50366aa11c16f4684 Mon Sep 17 00:00:00 2001 From: ff137 Date: Fri, 13 Dec 2024 11:02:58 +0200 Subject: [PATCH 08/10] :art: Rearrange sections --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 5518ff3a0..4455fe0c3 100644 --- a/README.md +++ b/README.md @@ -37,6 +37,12 @@ We enable and simplify several key capabilities, including: - Issuing verifiable credentials and handling revocations - Requesting and validating proofs +## Docs + +You can find more detailed documentation in the +[`./docs` folder](docs/README.md). The `Quick Start`, `Common Steps` and +`Example Flows` will be most useful. + ## How to Run It > [!NOTE] @@ -141,22 +147,6 @@ information. > [additional steps](https://kind.sigs.k8s.io/docs/user/using-wsl2/) for Kind to > work. -## Docs - -You can find more detailed documentation in the -[`./docs` folder](docs/README.md). The `Quick Start`, `Common Steps` and -`Example Flows` will be most useful. - -## Contributing - -[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](./CONTRIBUTING.md) - -While this project was primarily developed to meet the needs of -[Yoma](https://yoma.world), it is an open-source project that can be used for -other Hyperledger Aries projects as well. We welcome contributions from -everyone. Feel free to engage in discussions, create pull requests against -existing tickets, or open new issues following the GitHub guidelines. - ## Running Tests The tests use `pytest`. For convenience, use Mise to run them. First, ensure @@ -230,3 +220,13 @@ helmfile apply \ Please, refer to the [CI/CD docs](./.github/workflows/README.md) for more information. + +## Contributing + +[![Contributions](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](./CONTRIBUTING.md) + +While this project was primarily developed to meet the needs of +[Yoma](https://yoma.world), it is an open-source project that can be used for +other Hyperledger Aries projects as well. We welcome contributions from +everyone. Feel free to engage in discussions, create pull requests against +existing tickets, or open new issues following the GitHub guidelines. From 43ddb24c5cf0d2207eadaea932230fda9b3145d7 Mon Sep 17 00:00:00 2001 From: ff137 Date: Fri, 13 Dec 2024 11:15:20 +0200 Subject: [PATCH 09/10] :memo: Add overview of other services --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4455fe0c3..0f4c3ac56 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,13 @@ We enable and simplify several key capabilities, including: - Issuing verifiable credentials and handling revocations - Requesting and validating proofs -## Docs +To enable this, the project includes essential supporting services: + +- An [Endorser](endorser) for authorizing ledger transactions +- A [Trust Registry](trustregistry) for authorizing valid issuers, verifiers, + and approved credential schemas +- A webhooks service ([Waypoint](waypoint)) for real-time, server-sent event + (SSE) notifications and updates You can find more detailed documentation in the [`./docs` folder](docs/README.md). The `Quick Start`, `Common Steps` and From 3fb5f17d7018ba194803688cefa19a2b6a64e0d2 Mon Sep 17 00:00:00 2001 From: ff137 Date: Fri, 13 Dec 2024 11:20:48 +0200 Subject: [PATCH 10/10] :art: Finishing touches --- README.md | 39 ++++++++++++++++++--------------------- 1 file changed, 18 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 0f4c3ac56..41ab98de0 100644 --- a/README.md +++ b/README.md @@ -17,18 +17,19 @@ This project comprises a [FastAPI](https://fastapi.tiangolo.com/) application bu around [ACA-Py](https://github.com/openwallet-foundation/aries-cloudagent-python), primarily tailored for [Yoma](https://yoma.world)-specific use cases. -The FastAPI app serves as a wrapper around common workflows, facilitating -real-life applications of self-sovereign identity. It acts as an interface -for client applications (e.g., a mobile app) and the backend, using our -[OpenAPI client](https://github.com/didx-xyz/aries-cloudcontroller-python) and ACA-Py. +The main [app](app) provides an API interface +that simplifies complex self-sovereign identity (SSI) workflows. Using our +[ACA-Py controller](https://github.com/didx-xyz/aries-cloudcontroller-python), it +provides a streamlined layer of abstraction for client applications (e.g., a +mobile app) to interact within an SSI ecosystem. -Multiple API calls to ACA-Py can be condensed into a single call through this API. -For instance, onboarding an issuer — which involves creating a wallet, establishing a -connection with an endorser, generating a public DID, accepting the Transaction Author -Agreement (TAA), publishing the DID to the ledger, and awaiting confirmation — can all -be achieved with a single API call. Convenient, isn't it? +What would normally require multiple calls to ACA-Py can be condensed into a single call +through this API. For example, onboarding an issuer — which involves creating a wallet, +establishing a connection with an endorser, generating a public DID, accepting the +Transaction Author Agreement (TAA), publishing the DID to the ledger, and awaiting +confirmation — can all be achieved with a single API call. Convenient, isn't it? -We enable and simplify several key capabilities, including: +We simplify several key capabilities, including: - Creating and managing wallets - Onboarding issuers and verifiers @@ -39,25 +40,21 @@ We enable and simplify several key capabilities, including: To enable this, the project includes essential supporting services: -- An [Endorser](endorser) for authorizing ledger transactions -- A [Trust Registry](trustregistry) for authorizing valid issuers, verifiers, +- An [Endorser](endorser) agent and service for authorizing ledger transactions +- A [Trust Registry](trustregistry) implementation for authorizing valid issuers, verifiers, and approved credential schemas - A webhooks service ([Waypoint](waypoint)) for real-time, server-sent event (SSE) notifications and updates -You can find more detailed documentation in the -[`./docs` folder](docs/README.md). The `Quick Start`, `Common Steps` and -`Example Flows` will be most useful. +You can find more detailed documentation in the [docs folder](docs/README.md). +The `Quick Start`, `Common Steps` and `Example Flows` will be most useful. ## How to Run It > [!NOTE] -> For local development we migrated away from Docker Compose and now use Tilt -> and Kind. -> -> The original `./manage` script and Docker Compose files are still available in -> this repository, however they are now deprecated, no longer maintained, and -> will be removed in the future. +> For local development we now use Tilt and Kind instead of Docker Compose. +> Legacy Docker Compose files are still available, but deprecated and will be +> removed in the future. Running the project is straightforward — it's all containerized. Simply execute `mise run tilt:up` from the project root. This command will spin up a Kind