aries_cloudagent.commands package¶
Commands module common setup.
-
aries_cloudagent.commands.
load_command
(command: str)[source]¶ Load the module corresponding with a named command.
-
aries_cloudagent.commands.
run_command
(command: str, argv: Sequence[str] = None)[source]¶ Execute a named command with command line arguments.
Submodules¶
aries_cloudagent.commands.help module¶
Help command for indexing available commands.
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)[source]¶ Bases:
aries_cloudagent.core.error.BaseError
Base exception for provisioning errors.
aries_cloudagent.commands.start module¶
Entrypoint.
-
aries_cloudagent.commands.start.
init_argument_parser
(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f0ea79865b0>)[source]¶ Initialize an argument parser with the module’s arguments.
-
aries_cloudagent.commands.start.
run_loop
(startup: Coroutine, shutdown: Coroutine)[source]¶ Execute the application, handling signals and ctrl-c.
aries_cloudagent.commands.upgrade module¶
Upgrade command for handling breaking changes when updating ACA-PY versions.
-
class
aries_cloudagent.commands.upgrade.
ExplicitUpgradeOption
[source]¶ Bases:
enum.Enum
Supported explicit upgrade codes.
-
ERROR_AND_STOP
= 'critical'¶
-
LOG_AND_PROCEED
= 'warning'¶
-
-
exception
aries_cloudagent.commands.upgrade.
UpgradeError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.core.error.BaseError
Base exception for upgrade related errors.
-
class
aries_cloudagent.commands.upgrade.
VersionUpgradeConfig
(config_path: str = None)[source]¶ Bases:
object
Handle ACA-Py version upgrade config.
-
aries_cloudagent.commands.upgrade.
add_version_record
(profile: aries_cloudagent.core.profile.Profile, version: str)[source]¶ Add an acapy_version storage record for provided version.
-
aries_cloudagent.commands.upgrade.
explicit_upgrade_required_check
(to_apply_version_list: List, upgrade_config: dict) → Tuple[bool, List, Optional[str]][source]¶ 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[source]¶ Get available versions from the upgrade config.
-
aries_cloudagent.commands.upgrade.
init_argument_parser
(parser: <sphinx.ext.autodoc.importer._MockObject object at 0x7f0ea77b9fd0>)[source]¶ Initialize an argument parser with the module’s arguments.