What problem does it solve?
Conventions for static deploy automation Python CLIs in scripts/static-deploy/. Use when working with deployment scripts, AWS S3/CloudFront automation, or Python CLIs in the static-deploy directory.
Core Features & Use Cases
- Establishes typing everywhere (arg/return types, TypedDict/Protocol/Enum) and Google-style docstrings on public functions/classes to improve readability and tooling.
- Enforces small, pure functions, frozen dataclasses for config, pathlib.Path usage, and deterministic subprocess.run invocations with structured results.
- Provides a consistent CLI shape via argparse, a --dry-run option, AWS profile support, and CI-ready exit codes; includes architecture for Makefile entries and testability with pytest; isolates AWS calls for testability.
- Applicable for deploying static assets to cloud storage, performing build-time validations, and safely executing deployment pipelines.
Quick Start
Run the static-deploy CLI against your scripts/static-deploy directory with --dry-run to test deployment workflows safely.