A simple Django package to build web-based Indy/Aries agent applications.
Project description
Aries Community is a simple Django framework for building Hyperledger Indy/Aries Agent enabled web applications. Detailed documentation is in the “docs” directory.
Please see https://github.com/AnonSolutions/django-aries-community for detailed docmentation
Quick start
You can find a basic Aries Community application here https://github.com/AnonSolutions/aries-community-demo
To add aries_community to your own django application:
- Copy the requirements.txt file into your application directory and install requirements
- Add “aries_community” to your INSTALLED_APPS setting like this:
INSTALLED_APPS = [ ... 'aries_community', ]
- Add the following Indy configuration settings (this is for a local install):
import platform def file_ext(): if platform.system() == 'Linux': return '.so' elif platform.system() == 'Darwin': return '.dylib' elif platform.system() == 'Windows': return '.dll' else: return '.so' ARIES_CONFIG = { 'storage_config': {'url': 'localhost:5432'}, 'storage_credentials': {'account': 'postgres', 'password': 'mysecretpassword', 'admin_account': 'postgres', 'admin_password': 'mysecretpassword'}, 'register_dids': True, 'ledger_url': 'http://localhost:9000', 'genesis_url': 'http://localhost:9000/genesis', 'default_enterprise_seed': 'aries_community_enterprise_00000', 'default_institution_seed': 'aries_community_institution_0000', 'managed_agent_host': 'localhost', 'webhook_host': 'localhost', 'webhook_port': '8000', }
- Ensure your local templates are loaded first:
TEMPLATES = [ { ... 'DIRS': [ os.path.join(BASE_DIR, '<your app>/templates'), ], ... }, ]
- Override User, Organization and Relationship models, if you have your own subclass of these models:
AUTH_USER_MODEL = 'aries_community.IndyUser' ARIES_ORGANIZATION_MODEL = 'aries_community.IndyOrganization' ARIES_ORG_RELATION_MODEL = 'aries_community.IndyOrgRelationship'
- Include the indy URLconf in your project urls.py like this:
path('aries/', include('aries_community.urls')),
- Ensure you have all pre-requisites running, as per django-aries-community docs
- Run python manage.py migrate to create the indy models.
- Run python manage.py runserver and connect to http://localhost:8000/
You can customize the UI and add event handling for Aries Connection and Messaging events. See the demos in https://github.com/AnonSolutions/aries-community-demo for examples of how to do this.
View detailed documentation in the Docs directory (https://github.com/AnonSolutions/django-aries-community)
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django-aries-community-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8b2d6556af4bcdd63ed8addf68773155915fd57cb4be674fae0fbdbfa255d47 |
|
MD5 | ed65b2227ba76816870125e65ac223fb |
|
BLAKE2-256 | 856d6553c8c94968ff5a611d050d61ae14e08ccce45600c41a5cc8ca7f603fba |
Hashes for django_aries_community-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 590fbce6cad53f0e32e6046a82ba24e690367083bb64cbb988fa610ea92e584b |
|
MD5 | 6c89c9d41f8f1511cc586cff0489b1e7 |
|
BLAKE2-256 | ae9bb81df02494fd47c62452303a4c31d6bcaf22883388b86c80cbb9a23ac03e |