automation_file API Reference
The API reference is the auto-generated Python reference for every public
module in automation_file. Each chapter covers one slice of the package;
use the table of contents on the left, or jump straight to a chapter below.
Chapter A — Core
ActionRegistry, ActionExecutor, CallbackExecutor,
PackageLoader, the JSON store, retry decorator, and quota guard.
Core
- Core
ActionRegistrybuild_default_registry()CallbackExecutorPackageLoaderread_action_json()write_action_json()retry_on_transient()QuotaRateLimiterCircuitBreakerFileLockSQLiteLockActionQueueQueueItemContentStoreCancellationTokenCancelledExceptionProgressRegistryProgressReporterprogress_cancel()progress_clear()progress_list()register_progress_ops()ChecksumMismatchExceptionfile_checksum()verify_checksum()ManifestExceptionverify_manifest()write_manifest()AuditExceptionAuditLogSubstitutionExceptionsubstitute()load_entry_point_plugins()ChainedSecretProviderEnvSecretProviderFileSecretProviderSecretExceptionSecretNotFoundExceptionSecretProviderdefault_provider()resolve_secret_refs()AddCommandExceptionArchiveExceptionArgparseExceptionBoxExceptionCASExceptionCallbackExecutorExceptionCircuitOpenExceptionDagExceptionDataOpsExceptionDiffExceptionDirNotExistsExceptionExecuteActionExceptionFileAutomationExceptionFileNotExistsExceptionFsspecExceptionJsonActionExceptionLockTimeoutExceptionMCPServerExceptionOneDriveExceptionPathTraversalExceptionQueueExceptionQuotaExceededExceptionRateLimitExceededExceptionRetryExhaustedExceptionSMBExceptionTCPAuthExceptionTemplateExceptionTextOpsExceptionTracingExceptionUrlValidationExceptionValidationExceptionVersioningExceptionWebDAVExceptionZipInputException
Chapter B — Local Operations
File, directory, ZIP, tar, and safe_paths strategy modules.
Local Operations
Chapter C — Remote Operations
URL validator, HTTP download, Google Drive, S3, Azure Blob, Dropbox, OneDrive, Box, SFTP, FTP / FTPS, WebDAV, SMB, and fsspec backends.
Chapter D — Server
TCPActionServer, HTTPActionServer, MCPServer,
MetricsServer, WebUIServer, and the ActionACL.
Server
Chapter E — Client SDK
The Python client for talking to a running TCP / HTTP action server.
Client SDK
Chapter F — Triggers
Composable trigger primitives that fire registered actions.
Triggers
Chapter G — Scheduler
Cron-style scheduler for periodic action execution.
Scheduler
Chapter H — Notifications
Notification sinks (Slack, Email, Discord, Telegram, Teams, PagerDuty, Webhook).
Notifications
Chapter I — Progress and Cancellation
Progress reporting and cooperative cancellation primitives.
Chapter J — Project Scaffolding
ProjectBuilder and the project skeleton templates.
Project Scaffolding
Chapter K — Graphical User Interface
MainWindow, ActionWorker, LogPanel, and the per-domain tab
modules.
Graphical User Interface
Chapter L — Utils
File-discovery, fast-find, deduplicate, grep, and rotate helpers.
Utils