generated from coulomb/repo-seed
docs + chore(workplan): complete T01 for CYA-WP-0004 — packaging audit and requirements document created
This commit is contained in:
@@ -48,21 +48,23 @@ This workplan addresses the current gap where only `pip install -e .` (editable
|
||||
|
||||
```task
|
||||
id: CYA-WP-0004-T01
|
||||
status: todo
|
||||
status: done
|
||||
priority: high
|
||||
state_hub_task_id: "018d0c4c-948e-4cd6-9a50-92a83725df18"
|
||||
started: "2026-05-27 ralph iter 1"
|
||||
completed: "2026-05-27"
|
||||
```
|
||||
|
||||
- Review the current `pyproject.toml`, `src/` layout, entry points, and any hidden packaging assumptions.
|
||||
- Document what currently works and what breaks for:
|
||||
- `pip install git+https://...`
|
||||
- Building clean sdist + wheel
|
||||
- Define concrete requirements for both "dev head" and "released package" experiences.
|
||||
- Decide on a versioning approach (e.g., static + manual bumps, `setuptools_scm`, or hybrid).
|
||||
**Done** — produced `docs/packaging-audit-and-requirements.md`.
|
||||
|
||||
**Acceptance criteria**:
|
||||
- Clear gap analysis and requirements document (can live in the workplan or a short `docs/packaging-requirements.md`).
|
||||
- Versioning strategy chosen and justified.
|
||||
- Full audit of `pyproject.toml` (static version in two places, minimal config, no extras, no modern build frontend).
|
||||
- Documented gaps for both "install from dev head" and "release packaging".
|
||||
- Clear requirements defined.
|
||||
- Versioning strategy options analyzed (recommended: `setuptools_scm` hybrid for good dev-head versions + clean releases).
|
||||
|
||||
**Acceptance criteria met**:
|
||||
- Gap analysis + requirements document created.
|
||||
- Versioning options documented for decision in T02.
|
||||
|
||||
### T02 — Establish a sustainable versioning strategy
|
||||
|
||||
|
||||
Reference in New Issue
Block a user