Skip to main content

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 for detailed docmentation

Quick start

You can find a basic Aries Community application here

To add aries_community to your own django application:

  1. Copy the requirements.txt file into your application directory and install requirements

  2. Add “aries_community” to your INSTALLED_APPS setting like this:

  1. 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'
        return '.so'

    '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',
  1. Ensure your local templates are loaded first:

        'DIRS': [
            os.path.join(BASE_DIR, '<your app>/templates'),
  1. 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'
  1. Include the indy URLconf in your project like this:

path('aries/', include('aries_community.urls')),
  1. Ensure you have all pre-requisites running, as per django-aries-community docs

  2. Run python migrate to create the indy models.

  1. Run python 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 for examples of how to do this.

View detailed documentation in the Docs directory (

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

django-aries-community-0.1.3.tar.gz (45.8 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page