Metadata-Version: 2.1
Name: acapy-peopledata-did
Version: 0.1.0
Summary: ACA-Py plugin for MyData DID DIDComm protcol
Home-page: https://github.com/decentralised-dataexchange/acapy-mydata-did-protocol
License: License :: OSI Approved :: Apache Software License
Keywords: acapy,aries,peopledata,ssi
Author: jerry zhang
Author-email: jerry.zhang.bill@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: MarkupSafe (==2.0.1)
Requires-Dist: PyJWT (>=2.4.0,<3.0.0)
Requires-Dist: acapy-patched (==0.5.6.dev1)
Requires-Dist: dexa-sdk (==0.1.9)
Requires-Dist: py-multibase (>=1.0.3,<2.0.0)
Requires-Dist: py-solc-x (>=1.1.1,<2.0.0)
Requires-Dist: python3-indy (>=1.16.0,<2.0.0)
Requires-Dist: semver (>=2.13.0,<3.0.0)
Requires-Dist: validators (>=0.20.0,<0.21.0)
Project-URL: Repository, https://github.com/decentralised-dataexchange/acapy-mydata-did-protocol
Description-Content-Type: text/markdown

# ACA-Py plugin for Peopledata DID DIDComm protcol

## ACA-Py Version Compatibility

This plugin is compatible with ACA-Py version 0.5.6.

## Installation

Requirements:
- Python 3.6 or higher
- ACA-Py 0.5.6

### Setup Aries Cloud Agent - Python

If you already have an existing installation of ACA-Py, you can skip these steps
and move on to [plugin installation](#plugin-installation). It is also worth
noting that this is not the only way to setup an ACA-Py instance. For more setup
configurations, see the [Aries Cloud Agent - Python
repository](https://github.com/hyperledger/aries-cloudagent-python).

First, prepare a virtual environment:
```sh
$ python3 -m venv env
$ source env/bin/activate
```

Install ACA-Py 0.5.6 into the virtual environment:
```sh
$ pip install aries-cloudagent==0.5.6
```

### Plugin Installation

Install this plugin into the virtual environment:

```sh
$ pip install acapy-peopledata-did
```

**Note:** Depending on your version of `pip`, you may need to drop or add 
`#egg=peopledata_did` to install the plugin with the above command.

### Plugin Loading
Start up ACA-Py with the plugin parameter:
```sh
$ aca-py start \
    -it http 0.0.0.0 8002 \
    -ot http \
    -e "http://localhost:8002/" \
    --label "Agent" \
    --admin 0.0.0.0 8001 \
    --admin-insecure-mode \
    --auto-accept-requests \
    --auto-ping-connection \
    --auto-respond-credential-offer \
    --auto-respond-credential-request \
    --auto-store-credential \
    --auto-respond-presentation-proposal \
    --auto-respond-presentation-request \
    --auto-verify-presentation \
    --genesis-url https://indy.igrant.io/genesis \
    --wallet-type indy \
    --wallet-name "agent_wallet" \
    --log-level info \
    --wallet-key "wallet@123" \
    --plugin "Peopledata_did"
```

## Licensing

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.


