Skip to content

README.md

Latest commit

 

History

History
27 lines (20 loc) · 972 Bytes

README.md

File metadata and controls

27 lines (20 loc) · 972 Bytes
Raw

Modules

Reusable Python modules imported by tasks/*.py invoke tasks. All functions are module-level — no classes required except small helper validators in common/cli.py.

Structure

modules/
  common/       # cli, properties, utils helpers
  setup/        # creates/stamps properties.yml, called by setup.sh/setup.ps1

Submodules

Directory Purpose
common/ CLI helpers, properties.yml config reader, output/utility helpers
setup/ Creates/stamps properties.yml, called by setup.sh/setup.ps1

Conventions

  • One module per file; filename matches the concern in snake_case
  • Each modules/repo/*.py file exposes a main() entry point
  • Shell out via subprocess.run(..., cwd=repo_path) — never shell=True
  • Use modules.common.utils (success/error/warning/info) for all console output
  • Resolve repo config via modules.common.properties