SdamGIA API Maintainer
Maintain this repository with a domain-first, OOP style and explicit behavior changes.
Workflow
- •Read baseline context.
- •Read
AGENTS.md,README.md,pyproject.toml. - •Read touched modules under
sdamgia/and related tests undertests/. - •Check git status before editing to avoid clobbering user work.
- •Load only required references.
- •Load
references/coding-rules.mdfor coding, docstring, and testing constraints. - •Load
references/api-surface.mdfor public contracts and payload shapes. - •Load only the reference relevant to the active task.
- •Keep module ownership clear.
- •Change transport/retry/request behavior in
sdamgia/client.py. - •Change HTML extraction and payload shaping in
sdamgia/parsers.py. - •Change image-render backends in
sdamgia/rendering.py. - •Change OCR integration in
sdamgia/images.py. - •Re-export public API from
sdamgia/__init__.pyonly.
- •Implement with repository rules.
- •Use explicit domain names from the codebase.
- •Keep logic straightforward; avoid speculative helper layers.
- •Keep public APIs fully type hinted.
- •Use Google-style docstrings with
Summary,Args:,Returns:only. - •Handle failures explicitly; avoid silent broad exception swallowing.
- •Validate in layers.
- •Run
python3 -m compileall -q sdamgiafirst. - •Run targeted tests for touched behavior.
- •Run
pytest -qfor deterministic coverage. - •Run
pytest -m live -qonly when integration behavior changed.
- •Sync external contracts.
- •Update
README.mdwhen user-facing behavior changes. - •Update
references/api-surface.mdwhen signatures/payloads change. - •Call out breaking changes explicitly in the final handoff.