aries_cloudagent.commands package

Commands module common setup.

aries_cloudagent.commands.available_commands()

Index available commands.

aries_cloudagent.commands.load_command(command: str)

Load the module corresponding with a named command.

aries_cloudagent.commands.run_command(command: str, argv: Sequence[str] = None)

Execute a named command with command line arguments.

Submodules

aries_cloudagent.commands.help module

Help command for indexing available commands.

aries_cloudagent.commands.help.execute(argv: Sequence[str] = None)

Execute the help command.

aries_cloudagent.commands.help.main()

Execute the main line.

aries_cloudagent.commands.provision module

Provision command for setting up agent settings before starting.

exception aries_cloudagent.commands.provision.ProvisionError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Base exception for provisioning errors.

aries_cloudagent.commands.provision.execute(argv: Sequence[str] = None)

Entrypoint.

aries_cloudagent.commands.provision.init_argument_parser(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04627c550>)

Initialize an argument parser with the module’s arguments.

aries_cloudagent.commands.provision.main()

Execute the main line.

aries_cloudagent.commands.provision.provision(settings: dict)

Perform provisioning.

aries_cloudagent.commands.start module

Entrypoint.

aries_cloudagent.commands.start.execute(argv: Sequence[str] = None)

Entrypoint.

aries_cloudagent.commands.start.init_argument_parser(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc046292e20>)

Initialize an argument parser with the module’s arguments.

aries_cloudagent.commands.start.main()

Execute the main line.

aries_cloudagent.commands.start.run_loop(startup: Coroutine, shutdown: Coroutine)

Execute the application, handling signals and ctrl-c.

aries_cloudagent.commands.start.shutdown_app(conductor: aries_cloudagent.core.conductor.Conductor)

Shut down.

aries_cloudagent.commands.start.start_app(conductor: aries_cloudagent.core.conductor.Conductor)

Start up.

aries_cloudagent.commands.upgrade module

Upgrade command for handling breaking changes when updating ACA-PY versions.

class aries_cloudagent.commands.upgrade.ExplicitUpgradeOption

Bases: enum.Enum

Supported explicit upgrade codes.

ERROR_AND_STOP = 'critical'

LOG_AND_PROCEED = 'warning'

get = <bound method ExplicitUpgradeOption.get of <enum 'ExplicitUpgradeOption'>>

exception aries_cloudagent.commands.upgrade.UpgradeError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Base exception for upgrade related errors.

class aries_cloudagent.commands.upgrade.VersionUpgradeConfig(config_path: str = None)

Bases: object

Handle ACA-Py version upgrade config.

get_callable(executable: str) → Optional[Callable]

Return callable function for executable name.

setup_version_upgrade_config(path: str)

Set ups config dict from the provided YML file.

aries_cloudagent.commands.upgrade.add_version_record(profile: aries_cloudagent.core.profile.Profile, version: str)

Add an acapy_version storage record for provided version.

aries_cloudagent.commands.upgrade.execute(argv: Sequence[str] = None)

Entrypoint.

aries_cloudagent.commands.upgrade.explicit_upgrade_required_check(to_apply_version_list: List, upgrade_config: dict) → Tuple[bool, List, Optional[str]]

Check if explicit upgrade is required.

aries_cloudagent.commands.upgrade.get_upgrade_version_list(from_version: str, sorted_version_list: Optional[List] = None, config_path: Optional[str] = None) → List

Get available versions from the upgrade config.

aries_cloudagent.commands.upgrade.init_argument_parser(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7fc04631eb80>)

Initialize an argument parser with the module’s arguments.

aries_cloudagent.commands.upgrade.main()

Execute the main line.

aries_cloudagent.commands.upgrade.update_existing_records(profile: aries_cloudagent.core.profile.Profile)

Update existing records.

Parameters:profile – Root profile

aries_cloudagent.commands.upgrade.upgrade(settings: Union[Mapping[str, Any], aries_cloudagent.config.base.BaseSettings, None] = None, profile: Optional[aries_cloudagent.core.profile.Profile] = None)

Perform upgradation steps.