Aries Cloud Agent Python Code Documentation¶

Hyperledger Aries Cloud Agent Python (ACA-Py) is a foundation for building decentralized identity applications and services running in non-mobile environments.

This is the Read The Docs site for the Hyperledger Aries Cloud Agent Python. This site contains only the ACA-Py docstrings documentation extracted from the Python Code. For other documentation, please consult the links in the Readme for the ACA-Py GitHub Repo.

If you are getting started with verifiable credentials or Aries, we recommend that you start with this verifiable credentials and agents getting started guide.

Want to quick overview of the deployment model for ACA-Py? See this document.

To investigate the code, use search or click the package links in the left menu to drill into the modules, subpackages and submodules that make up ACA-Py.

Developers that are interested in what DIDComm protocols are supported in ACA-Py should take a look at the protocols package. These should align with the corresponding aries-rfcs protocols. Decorators defined in aries-rfcs and implemented in ACA-Py can be found here. Some general purpose subpackages that might be of interest include wallet and storage. For those agents playing different roles in a verifiable credential exchange, take a look at the issuer, holder and verifier packages.

Please see the ACA-Py Contribution guidelines for how to contribute to ACA-Py, including for how to submit issues about ACA-Py.

aries_cloudagent package¶

Subpackages¶

aries_cloudagent.admin package¶

Submodules¶

aries_cloudagent.admin.base_server module¶

aries_cloudagent.admin.error module¶

aries_cloudagent.admin.server module¶

aries_cloudagent.cache package¶

Submodules¶

aries_cloudagent.cache.base module¶

aries_cloudagent.cache.basic module¶

aries_cloudagent.commands package¶

Submodules¶

aries_cloudagent.commands.help module¶

aries_cloudagent.commands.provision module¶

aries_cloudagent.commands.start module¶

aries_cloudagent.config package¶

Submodules¶

aries_cloudagent.config.argparse module¶

aries_cloudagent.config.base module¶

aries_cloudagent.config.base_context module¶

aries_cloudagent.config.default_context module¶

aries_cloudagent.config.error module¶

aries_cloudagent.config.injection_context module¶

aries_cloudagent.config.injector module¶

aries_cloudagent.config.ledger module¶

aries_cloudagent.config.logging module¶

aries_cloudagent.config.provider module¶

aries_cloudagent.config.settings module¶

aries_cloudagent.config.util module¶

aries_cloudagent.config.wallet module¶

aries_cloudagent.core package¶

Submodules¶

aries_cloudagent.core.conductor module¶

aries_cloudagent.core.dispatcher module¶

aries_cloudagent.core.error module¶

aries_cloudagent.core.plugin_registry module¶

aries_cloudagent.core.protocol_registry module¶

aries_cloudagent.holder package¶

Submodules¶

aries_cloudagent.holder.base module¶

aries_cloudagent.holder.indy module¶

aries_cloudagent.holder.routes module¶

aries_cloudagent.indy package¶

Submodules¶

aries_cloudagent.indy.error module¶

aries_cloudagent.indy.util module¶

aries_cloudagent.issuer package¶

Submodules¶

aries_cloudagent.issuer.base module¶

aries_cloudagent.issuer.indy module¶

aries_cloudagent.ledger package¶

Submodules¶

aries_cloudagent.ledger.base module¶

aries_cloudagent.ledger.error module¶

aries_cloudagent.ledger.indy module¶

aries_cloudagent.ledger.provider module¶

aries_cloudagent.ledger.routes module¶

aries_cloudagent.ledger.util module¶

aries_cloudagent.messaging package¶

Subpackages¶

aries_cloudagent.messaging.ack package¶

Submodules¶

aries_cloudagent.messaging.ack.message module¶

aries_cloudagent.messaging.credential_definitions package¶

Submodules¶

aries_cloudagent.messaging.credential_definitions.routes module¶

aries_cloudagent.messaging.credential_definitions.util module¶

aries_cloudagent.messaging.decorators package¶

Submodules¶

aries_cloudagent.messaging.decorators.attach_decorator module¶

aries_cloudagent.messaging.decorators.base module¶

aries_cloudagent.messaging.decorators.default module¶

aries_cloudagent.messaging.decorators.localization_decorator module¶

aries_cloudagent.messaging.decorators.please_ack_decorator module¶

aries_cloudagent.messaging.decorators.signature_decorator module¶

aries_cloudagent.messaging.decorators.thread_decorator module¶

aries_cloudagent.messaging.decorators.timing_decorator module¶

aries_cloudagent.messaging.decorators.trace_decorator module¶

aries_cloudagent.messaging.decorators.transport_decorator module¶

aries_cloudagent.messaging.jsonld package¶

Submodules¶

aries_cloudagent.messaging.jsonld.create_verify_data module¶

aries_cloudagent.messaging.jsonld.credential module¶

aries_cloudagent.messaging.jsonld.routes module¶

aries_cloudagent.messaging.models package¶

Submodules¶

aries_cloudagent.messaging.models.base module¶

aries_cloudagent.messaging.models.base_record module¶

aries_cloudagent.messaging.schemas package¶

Submodules¶

aries_cloudagent.messaging.schemas.routes module¶

aries_cloudagent.messaging.schemas.util module¶

Submodules¶

aries_cloudagent.messaging.agent_message module¶

aries_cloudagent.messaging.base_handler module¶

aries_cloudagent.messaging.error module¶

aries_cloudagent.messaging.request_context module¶

aries_cloudagent.messaging.responder module¶

aries_cloudagent.messaging.util module¶

aries_cloudagent.messaging.valid module¶

aries_cloudagent.revocation package¶

Subpackages¶

aries_cloudagent.revocation.models package¶

Submodules¶

aries_cloudagent.revocation.models.indy module¶

aries_cloudagent.revocation.models.issuer_rev_reg_record module¶

aries_cloudagent.revocation.models.revocation_registry module¶

Submodules¶

aries_cloudagent.revocation.error module¶

aries_cloudagent.revocation.indy module¶

aries_cloudagent.revocation.routes module¶

aries_cloudagent.storage package¶

Submodules¶

aries_cloudagent.storage.base module¶

aries_cloudagent.storage.basic module¶

aries_cloudagent.storage.error module¶

aries_cloudagent.storage.indy module¶

aries_cloudagent.storage.provider module¶

aries_cloudagent.storage.record module¶

aries_cloudagent.transport package¶

Subpackages¶

aries_cloudagent.transport.inbound package¶

Submodules¶

aries_cloudagent.transport.inbound.base module¶

aries_cloudagent.transport.inbound.delivery_queue module¶

aries_cloudagent.transport.inbound.http module¶

aries_cloudagent.transport.inbound.manager module¶

aries_cloudagent.transport.inbound.message module¶

aries_cloudagent.transport.inbound.receipt module¶

aries_cloudagent.transport.inbound.session module¶

aries_cloudagent.transport.inbound.ws module¶

aries_cloudagent.transport.outbound package¶

Submodules¶

aries_cloudagent.transport.outbound.base module¶

aries_cloudagent.transport.outbound.http module¶

aries_cloudagent.transport.outbound.manager module¶

aries_cloudagent.transport.outbound.message module¶

aries_cloudagent.transport.outbound.ws module¶

aries_cloudagent.transport.queue package¶

Submodules¶

aries_cloudagent.transport.queue.base module¶

aries_cloudagent.transport.queue.basic module¶

Submodules¶

aries_cloudagent.transport.error module¶

aries_cloudagent.transport.pack_format module¶

aries_cloudagent.transport.stats module¶

aries_cloudagent.transport.wire_format module¶

aries_cloudagent.utils package¶

Submodules¶

aries_cloudagent.utils.classloader module¶

aries_cloudagent.utils.http module¶

aries_cloudagent.utils.outofband module¶

aries_cloudagent.utils.repeat module¶

aries_cloudagent.utils.stats module¶

aries_cloudagent.utils.task_queue module¶

aries_cloudagent.utils.temp module¶

aries_cloudagent.utils.tracing module¶

aries_cloudagent.verifier package¶

Submodules¶

aries_cloudagent.verifier.base module¶

aries_cloudagent.verifier.indy module¶

aries_cloudagent.wallet package¶

Submodules¶

aries_cloudagent.wallet.base module¶

aries_cloudagent.wallet.basic module¶

aries_cloudagent.wallet.crypto module¶

aries_cloudagent.wallet.error module¶

aries_cloudagent.wallet.indy module¶

aries_cloudagent.wallet.plugin module¶

aries_cloudagent.wallet.provider module¶

aries_cloudagent.wallet.routes module¶

aries_cloudagent.wallet.util module¶

Submodules¶

aries_cloudagent.version module¶

aries_cloudagent.connections package¶

Subpackages¶

aries_cloudagent.connections.models package¶

Subpackages¶

aries_cloudagent.connections.models.diddoc package¶

Submodules¶

aries_cloudagent.connections.models.diddoc.diddoc module¶

aries_cloudagent.connections.models.diddoc.publickey module¶

aries_cloudagent.connections.models.diddoc.service module¶

aries_cloudagent.connections.models.diddoc.util module¶

Submodules¶

aries_cloudagent.connections.models.connection_record module¶

aries_cloudagent.connections.models.connection_target module¶

aries_cloudagent.protocols package¶

Subpackages¶

aries_cloudagent.protocols.actionmenu package¶

Subpackages¶

aries_cloudagent.protocols.actionmenu.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.actionmenu.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.actionmenu.v1_0.handlers.perform_handler module¶

aries_cloudagent.protocols.actionmenu.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.actionmenu.v1_0.messages.perform module¶

aries_cloudagent.protocols.actionmenu.v1_0.models package¶

Submodules¶

aries_cloudagent.protocols.actionmenu.v1_0.base_service module¶

aries_cloudagent.protocols.actionmenu.v1_0.controller module¶

aries_cloudagent.protocols.actionmenu.v1_0.driver_service module¶

aries_cloudagent.protocols.actionmenu.v1_0.message_types module¶

aries_cloudagent.protocols.actionmenu.v1_0.routes module¶

aries_cloudagent.protocols.actionmenu.v1_0.util module¶

Submodules¶

aries_cloudagent.protocols.actionmenu.definition module¶

aries_cloudagent.protocols.basicmessage package¶

Subpackages¶

aries_cloudagent.protocols.basicmessage.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.basicmessage.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.basicmessage.v1_0.handlers.basicmessage_handler module¶

aries_cloudagent.protocols.basicmessage.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.basicmessage.v1_0.messages.basicmessage module¶

Submodules¶

aries_cloudagent.protocols.basicmessage.v1_0.message_types module¶

aries_cloudagent.protocols.basicmessage.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.basicmessage.definition module¶

aries_cloudagent.protocols.connections package¶

Subpackages¶

aries_cloudagent.protocols.connections.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.connections.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.connections.v1_0.handlers.connection_invitation_handler module¶

aries_cloudagent.protocols.connections.v1_0.handlers.connection_request_handler module¶

aries_cloudagent.protocols.connections.v1_0.handlers.connection_response_handler module¶

aries_cloudagent.protocols.connections.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.connections.v1_0.messages.connection_invitation module¶

aries_cloudagent.protocols.connections.v1_0.messages.connection_request module¶

aries_cloudagent.protocols.connections.v1_0.messages.connection_response module¶

aries_cloudagent.protocols.connections.v1_0.messages.problem_report module¶

aries_cloudagent.protocols.connections.v1_0.models package¶

Submodules¶

aries_cloudagent.protocols.connections.v1_0.models.connection_detail module¶

Submodules¶

aries_cloudagent.protocols.connections.v1_0.manager module¶

aries_cloudagent.protocols.connections.v1_0.message_types module¶

aries_cloudagent.protocols.connections.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.connections.definition module¶

aries_cloudagent.protocols.discovery package¶

Subpackages¶

aries_cloudagent.protocols.discovery.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.discovery.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.discovery.v1_0.handlers.disclose_handler module¶

aries_cloudagent.protocols.discovery.v1_0.handlers.query_handler module¶

aries_cloudagent.protocols.discovery.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.discovery.v1_0.messages.disclose module¶

aries_cloudagent.protocols.discovery.v1_0.messages.query module¶

Submodules¶

aries_cloudagent.protocols.discovery.v1_0.message_types module¶

aries_cloudagent.protocols.discovery.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.discovery.definition module¶

aries_cloudagent.protocols.introduction package¶

Subpackages¶

aries_cloudagent.protocols.introduction.v0_1 package¶

Subpackages¶

aries_cloudagent.protocols.introduction.v0_1.handlers package¶

Submodules¶

aries_cloudagent.protocols.introduction.v0_1.handlers.forward_invitation_handler module¶

aries_cloudagent.protocols.introduction.v0_1.handlers.invitation_handler module¶

aries_cloudagent.protocols.introduction.v0_1.handlers.invitation_request_handler module¶

aries_cloudagent.protocols.introduction.v0_1.messages package¶

Submodules¶

aries_cloudagent.protocols.introduction.v0_1.messages.forward_invitation module¶

aries_cloudagent.protocols.introduction.v0_1.messages.invitation module¶

aries_cloudagent.protocols.introduction.v0_1.messages.invitation_request module¶

Submodules¶

aries_cloudagent.protocols.introduction.v0_1.base_service module¶

aries_cloudagent.protocols.introduction.v0_1.demo_service module¶

aries_cloudagent.protocols.introduction.v0_1.message_types module¶

aries_cloudagent.protocols.introduction.v0_1.routes module¶

Submodules¶

aries_cloudagent.protocols.introduction.definition module¶

aries_cloudagent.protocols.issue_credential package¶

Subpackages¶

aries_cloudagent.protocols.issue_credential.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_ack_handler module¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_issue_handler module¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_offer_handler module¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_proposal_handler module¶

aries_cloudagent.protocols.issue_credential.v1_0.handlers.credential_request_handler module¶

aries_cloudagent.protocols.issue_credential.v1_0.messages package¶

Subpackages¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.inner package¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.inner.credential_preview module¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_ack module¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_issue module¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_offer module¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_proposal module¶

aries_cloudagent.protocols.issue_credential.v1_0.messages.credential_request module¶

aries_cloudagent.protocols.issue_credential.v1_0.models package¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v1_0.models.credential_exchange module¶

Submodules¶

aries_cloudagent.protocols.issue_credential.v1_0.manager module¶

aries_cloudagent.protocols.issue_credential.v1_0.message_types module¶

aries_cloudagent.protocols.issue_credential.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.issue_credential.definition module¶

aries_cloudagent.protocols.present_proof package¶

Subpackages¶

aries_cloudagent.protocols.present_proof.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.present_proof.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_ack_handler module¶

aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_handler module¶

aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_proposal_handler module¶

aries_cloudagent.protocols.present_proof.v1_0.handlers.presentation_request_handler module¶

aries_cloudagent.protocols.present_proof.v1_0.messages package¶

Subpackages¶

aries_cloudagent.protocols.present_proof.v1_0.messages.inner package¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.messages.inner.presentation_preview module¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation module¶

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_ack module¶

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_proposal module¶

aries_cloudagent.protocols.present_proof.v1_0.messages.presentation_request module¶

aries_cloudagent.protocols.present_proof.v1_0.models package¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.models.presentation_exchange module¶

aries_cloudagent.protocols.present_proof.v1_0.util package¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.util.indy module¶

aries_cloudagent.protocols.present_proof.v1_0.util.predicate module¶

Submodules¶

aries_cloudagent.protocols.present_proof.v1_0.manager module¶

aries_cloudagent.protocols.present_proof.v1_0.message_types module¶

aries_cloudagent.protocols.present_proof.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.present_proof.definition module¶

aries_cloudagent.protocols.problem_report package¶

Subpackages¶

aries_cloudagent.protocols.problem_report.v1_0 package¶

Submodules¶

aries_cloudagent.protocols.problem_report.v1_0.handler module¶

aries_cloudagent.protocols.problem_report.v1_0.message module¶

aries_cloudagent.protocols.problem_report.v1_0.message_types module¶

Submodules¶

aries_cloudagent.protocols.problem_report.definition module¶

aries_cloudagent.protocols.routing package¶

Subpackages¶

aries_cloudagent.protocols.routing.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.routing.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.routing.v1_0.handlers.forward_handler module¶

aries_cloudagent.protocols.routing.v1_0.handlers.route_query_request_handler module¶

aries_cloudagent.protocols.routing.v1_0.handlers.route_query_response_handler module¶

aries_cloudagent.protocols.routing.v1_0.handlers.route_update_request_handler module¶

aries_cloudagent.protocols.routing.v1_0.handlers.route_update_response_handler module¶

aries_cloudagent.protocols.routing.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.routing.v1_0.messages.forward module¶

aries_cloudagent.protocols.routing.v1_0.messages.route_query_request module¶

aries_cloudagent.protocols.routing.v1_0.messages.route_query_response module¶

aries_cloudagent.protocols.routing.v1_0.messages.route_update_request module¶

aries_cloudagent.protocols.routing.v1_0.messages.route_update_response module¶

aries_cloudagent.protocols.routing.v1_0.models package¶

Submodules¶

aries_cloudagent.protocols.routing.v1_0.models.paginate module¶

aries_cloudagent.protocols.routing.v1_0.models.paginated module¶

aries_cloudagent.protocols.routing.v1_0.models.route_query_result module¶

aries_cloudagent.protocols.routing.v1_0.models.route_record module¶

aries_cloudagent.protocols.routing.v1_0.models.route_update module¶

aries_cloudagent.protocols.routing.v1_0.models.route_updated module¶

Submodules¶

aries_cloudagent.protocols.routing.v1_0.manager module¶

aries_cloudagent.protocols.routing.v1_0.message_types module¶

Submodules¶

aries_cloudagent.protocols.routing.definition module¶

aries_cloudagent.protocols.trustping package¶

Subpackages¶

aries_cloudagent.protocols.trustping.v1_0 package¶

Subpackages¶

aries_cloudagent.protocols.trustping.v1_0.handlers package¶

Submodules¶

aries_cloudagent.protocols.trustping.v1_0.handlers.ping_handler module¶

aries_cloudagent.protocols.trustping.v1_0.handlers.ping_response_handler module¶

aries_cloudagent.protocols.trustping.v1_0.messages package¶

Submodules¶

aries_cloudagent.protocols.trustping.v1_0.messages.ping module¶

aries_cloudagent.protocols.trustping.v1_0.messages.ping_response module¶

Submodules¶

aries_cloudagent.protocols.trustping.v1_0.message_types module¶

aries_cloudagent.protocols.trustping.v1_0.routes module¶

Submodules¶

aries_cloudagent.protocols.trustping.definition module¶

Indices and tables¶

Index