Minimal Python 3.11 application for parsing inventory transactions and producing a text report.
.
|-- .devcontainer/
| `-- devcontainer.json
|-- .github/
| |-- copilot-instructions.md
| |-- agents/
| | |-- frontend-expert.agent.md
| | |-- test-expert.agent.md
| | |-- frontend-expert/
| | | |-- README.md
| | | |-- QUICK_REFERENCE.md
| | | |-- IMPLEMENTATION_GUIDE.md
| | | `-- CONFIG.md
| | `-- test-expert/
| | |-- README.md
| | |-- QUICK_REFERENCE.md
| | |-- IMPLEMENTATION_GUIDE.md
| | `-- CONFIG.md
| |-- instructions/
| | |-- app.instructions.md
| | `-- tests.instructions.md
| |-- prompts/
| | `-- implement-feature.prompt.md
| |-- skills/
| | `-- tdd-python/
| | `-- SKILL.md
| `-- workflows/
| `-- ci.yml
|-- app/
| |-- __init__.py
| |-- __main__.py
| `-- inventory.py
|-- tests/
| |-- test_cli.py
| `-- test_inventory.py
|-- sample-transactions.txt
|-- pyproject.toml
`-- README.md
python -m pip install -e .[dev]
python -m app sample-transactions.txt
pytestpython -m pip install -e .[dev]
pytestAll code in app/ must follow the TDD workflow:
- Write failing tests first
- Implement minimal code to pass tests
- Refactor while keeping tests green
- Target 100% line and branch coverage
See .github/instructions/app.instructions.md for details.
Every new test function must include author headers:
# Author: <your git username>
# Date: YYYY-MM-DD
def test_example() -> None:
...See .github/instructions/tests.instructions.md for details.
The repository uses layered instructions in .github:
.github/copilot-instructions.md- Repository-wide rules for workflow, README maintenance, and local ADR logging in
log/.
- Repository-wide rules for workflow, README maintenance, and local ADR logging in
.github/instructions/app.instructions.md- Any changes in
app/must follow TDD: fail first, pass, refactor, then verify full coverage.
- Any changes in
.github/instructions/tests.instructions.md- Every new
test_function intests/must include# Author:and# Date:headers.
- Every new
.github/skills/tdd-python/SKILL.md- Detailed Red-Green-Refactor guidance used when implementing Python code.
test-expert- Focused on generating and improving tests with strong line and branch coverage.
frontend-expert- Focused on building modern, responsive frontends for Python applications.
Agent definitions and references are under .github/agents/.
.github/prompts/implement-feature.prompt.md- Reusable prompt for implementing features while following repository rules.
.github/workflows/ci.yml- Runs automated checks for pushes and pull requests.