acapy_agent.tails package

Submodules

acapy_agent.tails.anoncreds_tails_server module

AnonCreds tails server interface class.

class acapy_agent.tails.anoncreds_tails_server.AnonCredsTailsServer[source]

Bases: BaseTailsServer

AnonCreds tails server interface.

async upload_tails_file(context: InjectionContext, filename: str, tails_file_path: str, interval: float = 1.0, backoff: float = 0.25, max_attempts: int = 5) → Tuple[bool, str][source]

Upload tails file to tails server.

Parameters:

  • context – context with configuration settings

  • filename – file name given to tails server

  • tails_file_path – path to the tails file to upload

  • interval – initial interval between attempts

  • backoff – exponential backoff in retry interval

  • max_attempts – maximum number of attempts to make

Returns:

tuple with success status and url of uploaded public file uri or error message if failed

Return type:

Tuple[bool, str]

acapy_agent.tails.base module

Tails server interface base class.

class acapy_agent.tails.base.BaseTailsServer[source]

Bases: ABC

Base class for tails server interface.

abstractmethod async upload_tails_file(context: InjectionContext, filename: str, tails_file_path: str, interval: float = 1.0, backoff: float = 0.25, max_attempts: int = 5) → Tuple[bool, str][source]

Upload tails file to tails server.

Parameters:

  • context – context with configuration settings

  • filename – file name given to tails server

  • tails_file_path – path to tails file to upload

  • interval – initial interval between attempts

  • backoff – exponential backoff in retry interval

  • max_attempts – maximum number of attempts to make

Returns:

tuple with success status and url of uploaded public file uri or error message if failed

Return type:

Tuple[bool, str]

acapy_agent.tails.error module

Tails server related errors.

exception acapy_agent.tails.error.TailsServerNotConfiguredError(*args, error_code: str | None = None, **kwargs)[source]

Bases: BaseError

Error indicating the tails server plugin hasn’t been configured.

acapy_agent.tails.indy_tails_server module