Skip to content

Commit

Permalink
Another round of updates
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Curran <[email protected]>
  • Loading branch information
swcurran committed Oct 3, 2024
1 parent 9f9d1c4 commit 4306ea6
Show file tree
Hide file tree
Showing 11 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion NOTICES
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
The aries-cloudagent-python project relies on the following open source
The ACA-Py project relies on the following open source
components for run-time execution. These components are released under
separate copyright notices and license terms.

Expand Down
2 changes: 1 addition & 1 deletion demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aries Cloud Agent Python (ACA-Py) Demos <!-- omit in toc -->
# ACA-Py Demos <!-- omit in toc -->

The documentation for the ACA-Py demos is published on the [aca-py.org](https://aca-py.org) documentation site in the `Demos` tab. Jump over there to learn more about using ACA-Py and going through the many demos available.

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The ACA-Py `docs` Folder

The Aries Cloud Agent Python docs folder contains the source content for the
The ACA-Py `docs` folder contains the source content for the
ACA-Py documentation site [aca-py.org] and for the ACA-Py source code internals
documentation project at ReadTheDocs, published at [https://aries-cloud-agent-python.readthedocs.io].

Expand Down
4 changes: 2 additions & 2 deletions docs/demo/ACA-Py-Workshop.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ environments. Contributions back to the project are always welcome!

### What’s Next: The ACA-Py OpenAPI

Are you going to build an app that uses Traction or an instance of the [Aries Cloud Agent Python](https://aca-py.org/) (ACA-Py)? If so, your next step is to try out the ACA-Py OpenAPI (aka Swagger)—by hand at first, and then from your application. This is a VERY high level overview, assuming a developer is following this, and knows a bunch about Aries protocols, using HTTP APIs, and using OpenAPI interfaces.
Are you going to build an app that uses Traction or an instance of [ACA-Py](https://aca-py.org/)? If so, your next step is to try out the ACA-Py OpenAPI (aka Swagger)—by hand at first, and then from your application. This is a VERY high level overview, assuming a developer is following this, and knows a bunch about Aries protocols, using HTTP APIs, and using OpenAPI interfaces.

To access and use your Tenant's OpenAPI (aka Swagger) interface:

Expand All @@ -252,7 +252,7 @@ invoking the right sequence of OpenAPI calls.

### What's Next: Experiment With an Issuer Web App

If you are challenged to use Traction or [Aries Cloud Agent Python] to become an
If you are challenged to use Traction or [ACA-Py] to become an
issuer, you will likely be building API calls into your Line of Business web
application. To get an idea of what that will entail, we're delighted to direct
you to a very simple Web App that one of your predecessors on this same journey
Expand Down
4 changes: 2 additions & 2 deletions docs/demo/AliceGetsAPhone.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Note that with _Play with Docker_ it can be challenging to capture the informati
#### Running locally in a bash shell?

If you are running in a _local bash shell_, navigate to the `demo` directory in
your fork/clone of the Aries Cloud Agent Python repository and run:
your fork/clone of the ACA-Py repository and run:

```bash
TAILS_NETWORK=docker_tails-server LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo faber --aip 10 --revocation --events
Expand All @@ -152,7 +152,7 @@ The `TAILS_NETWORK` parameter lets the demo script know how to connect to the ta
#### Running in Play with Docker?

If you are running in _Play with Docker_, navigate to the `demo` folder in the
clone of Aries Cloud Agent Python and run the following:
clone of ACA-Py and run the following:

```bash
PUBLIC_TAILS_URL=https://c4f7fbb85911.ngrok.io LEDGER_URL=http://test.bcovrin.vonx.io ./run_demo faber --aip 10 --revocation --events
Expand Down
6 changes: 3 additions & 3 deletions docs/demo/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Aries Cloud Agent Python (ACA-Py) Demos <!-- omit in toc -->
# ACA-Py Demos <!-- omit in toc -->

There are several demos available for ACA-Py mostly (but not only) aimed at developers learning how to deploy an instance of the agent and an ACA-Py controller to implement an application.

Expand Down Expand Up @@ -66,13 +66,13 @@ Open three `bash` shells. For Windows users, `git-bash` is highly recommended. b

In the first terminal window, start `von-network` by following the [Building and Starting](https://github.com/bcgov/von-network/blob/main/docs/UsingVONNetwork.md#building-and-starting) instructions.

In the second terminal, change directory into `demo` directory of your clone of the Aries Cloud Agent Python repository. Start the `faber` agent by issuing the following command:
In the second terminal, change directory into `demo` directory of your clone of the ACA-Py repository. Start the `faber` agent by issuing the following command:

``` bash
./run_demo faber
```

In the third terminal, change directory into `demo` directory of your clone of the Aries Cloud Agent Python repository. Start the `alice` agent by issuing the following command:
In the third terminal, change directory into `demo` directory of your clone of the ACA-Py repository. Start the `alice` agent by issuing the following command:

``` bash
./run_demo alice
Expand Down
2 changes: 1 addition & 1 deletion docs/features/DevReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ See the [README](../../README.md) for details about this repository and informat

## Introduction

Aries Cloud Agent Python (ACA-Py) is a configurable, extensible, non-mobile Aries agent that implements an easy way for developers to build decentralized identity services that use verifiable credentials.
ACA-Py is a configurable, extensible, non-mobile Aries agent that implements an easy way for developers to build decentralized identity services that use verifiable credentials.

The information on this page assumes you are developer with a background in
decentralized identity, Aries, DID Methods, and verifiable credentials,
Expand Down
2 changes: 1 addition & 1 deletion docs/features/SupportedRFCs.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ A summary of the Aries Interop Profiles and Aries RFCs supported in ACA-Py can b
| Invitations using peer dids supporting connection reuse | :white_check_mark: | |
| Implicit pickup of messages in role of mediator | :white_check_mark: | |
| [Revocable AnonCreds Credentials](https://github.com/hyperledger/indy-hipe/tree/main/text/0011-cred-revocation) | :white_check_mark: | |
| Multi-Tenancy | :white_check_mark: | [Documentation](https://github.com/hyperledger/aries-cloudagent-python/blob/main/Multitenancy.md) |
| Multi-Tenancy | :white_check_mark: | [Documentation](https://github.com/openwallet-foundation/acapy/blob/main/Multitenancy.md) |
| Multi-Tenant Management | :white_check_mark: | The [Traction] open source project from BC Gov is a layer on top of ACA-Py that enables the easy management of ACA-Py tenants, with an Administrative UI ("The Innkeeper") and a Tenant UI for using ACA-Py in a web UI (setting up, issuing, holding and verifying credentials) |
| Connection-less (non OOB protocol / AIP 1.0) | :white_check_mark: | Only for issue credential and present proof |
| Connection-less (OOB protocol / AIP 2.0) | :white_check_mark: | Only for present proof |
Expand Down
10 changes: 5 additions & 5 deletions docs/features/W3cCredentials.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## Verifiable Credential Data Integrity (VC-DI) Credentials in Aries Cloud Agent Python (ACA-Py)
## Verifiable Credential Data Integrity (VC-DI) Credentials in ACA-Py

This document outlines a new functionality within Aries Agent that facilitates the issuance of credentials and presentations in compliance with the W3C standard.

### Table of Contents

- [Verifiable Credential Data Integrity (VC-DI) Credentials in Aries Cloud Agent Python (ACA-Py)](#verifiable-credential-data-integrity-vc-di-credentials-in-aries-cloud-agent-python-aca-py)
- [Verifiable Credential Data Integrity (VC-DI) Credentials in ACA-Py](#verifiable-credential-data-integrity-vc-di-credentials-in-aca-py)
- [Table of Contents](#table-of-contents)
- [General Concept](#general-concept)
- [Prerequisites](#prerequisites)
Expand Down Expand Up @@ -139,7 +139,7 @@ Ensure the credential data conforms to the VC-DI context.
2. **Select Credential type**
The ability to choose the credential type (indy, vc_di) to be issued. The credential type is used to determine the schema for the credential data.

The format to change credential can be seen in the ["Demo Instruction"](../demo/README.md)
The format to change credential can be seen in the [Demo Instruction](../demo/README.md)

3. **Send the Credential:**
Use the `/issue-credential-2.0/send` endpoint to issue the credential.
Expand Down Expand Up @@ -633,9 +633,9 @@ To verify presented proof, follow these steps:

#### References and Resources

- [Aries Cloud Agent Python Documentation](https://aca-py.org)
- [ACA-Py Documentation](https://aca-py.org)
- [Verifiable Credentials Data Model](https://www.w3.org/TR/vc-data-model/)
- [Verifiable Presentations Data Model](https://www.w3.org/TR/vc-data-model/#presentations)
- [DIF Presentation Format](https://identity.foundation/presentation-exchange/)
- [did:key Method Specification](https://w3c-ccg.github.io/did-method-key/)
- ["Aries Cloud Agent Python (ACA-Py) Demos"](https://github.com/sarthakvijayvergiya/aries-cloudagent-python/blob/whatscookin/feat/vc-di-proof/docs/demo/README.md)
- [ACA-Py Demos](https://github.com/sarthakvijayvergiya/aries-cloudagent-python/blob/whatscookin/feat/vc-di-proof/docs/demo/README.md)
2 changes: 1 addition & 1 deletion docs/testing/BDDTests.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ By default the test suite runs using a default (SQLite) wallet, to run the tests
using postgres run the following:

```bash
# run the above commands, up to cd aries-cloudagent-python/demo
# run the above commands, up to cd acapy/demo
docker run --name some-postgres -e POSTGRES_PASSWORD=mysecretpassword -d -p 5432:5432 postgres:10
ACAPY_ARG_FILE=postgres-indy-args.yml ./run_bdd
```
Expand Down
2 changes: 1 addition & 1 deletion scripts/generate-open-api-spec
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function buildACAPyDockerImage() {
}

# Start an ACA-py docker image
# A simplified version of aries-cloudagent-python/scripts/run_docker
# A simplified version of acapy/scripts/run_docker
# needed to run without tty or interactive.
# $1: The ACA-py docker image to use (i.e either from a repo or local)
# $2: The port mapping from docker to local host in format "docker1:local1 docker2:local2"
Expand Down

0 comments on commit 4306ea6

Please sign in to comment.