<h1 align="center">
Data Exchange Agreements (DEXA) SDKs
</h1>
<p align="center">
<a href="/../../commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/decentralised-dataexchange/dexa-sdk?style=flat"></a>
<a href="/../../issues" title="Open Issues"><img src="https://img.shields.io/github/issues/decentralised-dataexchange/dexa-sdk?style=flat"></a>
<a href="./LICENSE" title="License"><img src="https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat"></a>
</p>
<p align="center">
<a href="#about">About</a> •
<a href="#release-status">Release Status</a> •
<a href="#contributing">Contributing</a> •
<a href="#licensing">Licensing</a>
</p>
## About
This repository hosts the source code for DEXA SDKs and is part of the deliverables for Provenance services with smart data agreement ([PS-SDA](https://ontochain.ngi.eu/content/ps-sda)) project that has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 957338. It implements common functions for DEXA that is used to implement dexa-protocols.
## Release Status
Not released, work in progress.
## Installation
Requirements:
- Python 3.8.9 or higher
### Plugin Installation
Install this plugin into the virtual environment:
```sh
$ pip install dexa-sdk
```
### Usage
Hyperledger aries agents with DEXA protocols enabled can be created using DEXA SDK. Sample script is given below:
In `agent.py`, copy the following.
```python
from dexa_sdk.agent.commands.start import execute
args = [
"-it",
"http",
"0.0.0.0",
"8006",
"-ot",
"http",
"-e",
"http://localhost:8006/",
"--label",
"Data Source",
"--admin",
"0.0.0.0",
"8005",
"--admin-insecure-mode",
"--auto-accept-requests",
"--auto-ping-connection",
"--auto-respond-credential-proposal",
"--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",
"Data Source",
"--log-level",
"info",
"--wallet-key",
"Data Source",
"--webhook-url",
"http://localhost:8005/webhooks",
"--public-invites",
"--plugin",
"mydata_did",
"--plugin",
"dexa_protocol",
"--eth-node-rpc",
"<ethereum node rpc endpoint>",
"--intermediary-eth-private-key",
"<data intermediary ethereum private key>",
"--org-eth-private-key",
"<org ethereum private key>",
"--contract-address",
"<contract address>"
]
execute(args)
```
and run by executing `python agent.py`.
#### Using docker
```sh
docker run -it igrantio/dexa-sdk:0.1.8 -- -it http 0.0.0.0 8006 -ot http -e http://localhost:8006/ --label Data Source --admin 0.0.0.0 8005 --admin-insecure-mode --auto-accept-requests --auto-ping-connection --auto-respond-credential-proposal --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 Data Source --log-level info --wallet-key Data Source --webhook-url http://localhost:8005/webhooks --public-invites --plugin mydata_did --plugin dexa_protocol --eth-node-rpc <ethereum node rpc endpoint> --intermediary-eth-private-key <data intermediary ethereum private key> --org-eth-private-key <org ethereum private key> --contract-address <contract address>
```
## Contributing
Feel free to improve the plugin and send us a pull request. If you found any problems, please create an issue in this repo.
## Licensing
Copyright (c) 2022-25 LCubed AB (iGrant.io), Sweden
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.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.
Raw data
{
"_id": null,
"home_page": "https://github.com/decentralised-dataexchange/dexa-sdk",
"name": "dexa-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "acapy,aries,dataexchange,ssi",
"author": "George J Padayatti",
"author_email": "george.padayatti@igrant.io",
"download_url": "https://files.pythonhosted.org/packages/9f/d6/a5aa3ecc7c0b045b6d845c32d64a6185bf19a8f288fc00ecd01b07787e48/dexa-sdk-0.1.14.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n Data Exchange Agreements (DEXA) SDKs\n</h1>\n\n<p align=\"center\">\n <a href=\"/../../commits/\" title=\"Last Commit\"><img src=\"https://img.shields.io/github/last-commit/decentralised-dataexchange/dexa-sdk?style=flat\"></a>\n <a href=\"/../../issues\" title=\"Open Issues\"><img src=\"https://img.shields.io/github/issues/decentralised-dataexchange/dexa-sdk?style=flat\"></a>\n <a href=\"./LICENSE\" title=\"License\"><img src=\"https://img.shields.io/badge/License-Apache%202.0-green.svg?style=flat\"></a>\n</p>\n\n<p align=\"center\">\n <a href=\"#about\">About</a> \u2022\n <a href=\"#release-status\">Release Status</a> \u2022\n <a href=\"#contributing\">Contributing</a> \u2022\n <a href=\"#licensing\">Licensing</a>\n</p>\n\n## About\n\nThis repository hosts the source code for DEXA SDKs and is part of the deliverables for Provenance services with smart data agreement ([PS-SDA](https://ontochain.ngi.eu/content/ps-sda)) project that has received funding from the European Union\u2019s Horizon 2020 research and innovation programme under grant agreement No 957338. It implements common functions for DEXA that is used to implement dexa-protocols. \n## Release Status\n\nNot released, work in progress.\n\n## Installation\n\nRequirements:\n- Python 3.8.9 or higher\n\n### Plugin Installation\n\nInstall this plugin into the virtual environment:\n\n```sh\n$ pip install dexa-sdk\n```\n\n### Usage\n\nHyperledger aries agents with DEXA protocols enabled can be created using DEXA SDK. Sample script is given below:\n\nIn `agent.py`, copy the following.\n\n```python\nfrom dexa_sdk.agent.commands.start import execute\n\nargs = [\n \"-it\",\n \"http\",\n \"0.0.0.0\",\n \"8006\",\n \"-ot\",\n \"http\",\n \"-e\",\n \"http://localhost:8006/\",\n \"--label\",\n \"Data Source\",\n \"--admin\",\n \"0.0.0.0\",\n \"8005\",\n \"--admin-insecure-mode\",\n \"--auto-accept-requests\",\n \"--auto-ping-connection\",\n \"--auto-respond-credential-proposal\",\n \"--auto-respond-credential-offer\",\n \"--auto-respond-credential-request\",\n \"--auto-store-credential\",\n \"--auto-respond-presentation-proposal\",\n \"--auto-respond-presentation-request\",\n \"--auto-verify-presentation\",\n \"--genesis-url\",\n \"https://indy.igrant.io/genesis\",\n \"--wallet-type\",\n \"indy\",\n \"--wallet-name\",\n \"Data Source\",\n \"--log-level\",\n \"info\",\n \"--wallet-key\",\n \"Data Source\",\n \"--webhook-url\",\n \"http://localhost:8005/webhooks\",\n \"--public-invites\",\n \"--plugin\",\n \"mydata_did\",\n \"--plugin\",\n \"dexa_protocol\",\n \"--eth-node-rpc\",\n \"<ethereum node rpc endpoint>\",\n \"--intermediary-eth-private-key\",\n \"<data intermediary ethereum private key>\",\n \"--org-eth-private-key\",\n \"<org ethereum private key>\",\n \"--contract-address\",\n \"<contract address>\"\n]\n\nexecute(args)\n```\n\nand run by executing `python agent.py`.\n\n#### Using docker\n\n```sh\ndocker run -it igrantio/dexa-sdk:0.1.8 -- -it http 0.0.0.0 8006 -ot http -e http://localhost:8006/ --label Data Source --admin 0.0.0.0 8005 --admin-insecure-mode --auto-accept-requests --auto-ping-connection --auto-respond-credential-proposal --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 Data Source --log-level info --wallet-key Data Source --webhook-url http://localhost:8005/webhooks --public-invites --plugin mydata_did --plugin dexa_protocol --eth-node-rpc <ethereum node rpc endpoint> --intermediary-eth-private-key <data intermediary ethereum private key> --org-eth-private-key <org ethereum private key> --contract-address <contract address>\n```\n\n## Contributing\n\nFeel free to improve the plugin and send us a pull request. If you found any problems, please create an issue in this repo.\n\n## Licensing\nCopyright (c) 2022-25 LCubed AB (iGrant.io), Sweden\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License.\n\nYou may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.\n\nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.\n",
"bugtrack_url": null,
"license": "License :: OSI Approved :: Apache Software License",
"summary": "Store and manage Data Exchange Agreements (DEXA)",
"version": "0.1.14",
"split_keywords": [
"acapy",
"aries",
"dataexchange",
"ssi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "150bc9c7f51f4021f6d1bc31dfbfea0c808b5dc846a0d199f493e0e382394097",
"md5": "b7b385420c65aa9861b61b3ccec1747e",
"sha256": "519f56348fcd8ab204aeb7ef4402240cda445aee129dd9b6a9e038516b8a03ab"
},
"downloads": -1,
"filename": "dexa_sdk-0.1.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7b385420c65aa9861b61b3ccec1747e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 2795112,
"upload_time": "2023-02-08T16:35:57",
"upload_time_iso_8601": "2023-02-08T16:35:57.733956Z",
"url": "https://files.pythonhosted.org/packages/15/0b/c9c7f51f4021f6d1bc31dfbfea0c808b5dc846a0d199f493e0e382394097/dexa_sdk-0.1.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9fd6a5aa3ecc7c0b045b6d845c32d64a6185bf19a8f288fc00ecd01b07787e48",
"md5": "377f20764103fa8789a607812f38a70e",
"sha256": "2cbe09ff2b43e24be0ad63a73454a24104e13595c4e106b2f45ed21a13d32910"
},
"downloads": -1,
"filename": "dexa-sdk-0.1.14.tar.gz",
"has_sig": false,
"md5_digest": "377f20764103fa8789a607812f38a70e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 2738220,
"upload_time": "2023-02-08T16:35:54",
"upload_time_iso_8601": "2023-02-08T16:35:54.195151Z",
"url": "https://files.pythonhosted.org/packages/9f/d6/a5aa3ecc7c0b045b6d845c32d64a6185bf19a8f288fc00ecd01b07787e48/dexa-sdk-0.1.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-08 16:35:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "decentralised-dataexchange",
"github_project": "dexa-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "dexa-sdk"
}
JSON
