generated from coulomb/repo-seed
feat(install) + docs + chore(workplan): complete T03 for CYA-WP-0004 — Makefile, optional deps, and improved dev-head installation docs
This commit is contained in:
@@ -94,19 +94,29 @@ completed: "2026-05-27"
|
||||
|
||||
```task
|
||||
id: CYA-WP-0004-T03
|
||||
status: todo
|
||||
status: done
|
||||
priority: high
|
||||
state_hub_task_id: "14e085dd-847a-4678-a1e4-abe5e3c369aa"
|
||||
started: "2026-05-27 ralph iter 3"
|
||||
completed: "2026-05-27"
|
||||
```
|
||||
|
||||
- Ensure `pip install "git+https://github.com/worsch/can-you-assist.git"` (and branch variants) works cleanly.
|
||||
- Add any necessary `[project.optional-dependencies]` (e.g., `dev`, `test`).
|
||||
- Create a recommended one-liner or short documented flow for the primary user.
|
||||
- Optionally add a `Makefile` target (e.g., `make dev-install`) as a convenience.
|
||||
**Done.**
|
||||
|
||||
**Acceptance criteria**:
|
||||
- A non-developer can successfully install the latest code from git with one command and get a working `cya` binary.
|
||||
- The installed version clearly indicates it is from development head.
|
||||
- Added `[project.optional-dependencies]` `dev` and `test` in `pyproject.toml`.
|
||||
- Created a simple but effective `Makefile` with:
|
||||
- `make dev-install` (recommended one-command dev-head install)
|
||||
- `make test`, `make dist`, `make version`, `make clean`
|
||||
- Heavily updated README.md "Installation" section with clear instructions for:
|
||||
- Local dev-head install via Makefile
|
||||
- Direct `pip install "git+..."` from GitHub
|
||||
- Future released packages
|
||||
- Updated AGENTS.md Commands section to reference the new `make dev-install` flow.
|
||||
- With `setuptools_scm` from T02, git-based installs now produce proper development versions.
|
||||
|
||||
**Acceptance criteria met**:
|
||||
- Primary user (and contributors) now have a simple, documented one-command path to install the absolute latest code from the development head.
|
||||
- The installed version will clearly show it is a development version.
|
||||
|
||||
### T04 — Enable clean building of distribution packages
|
||||
|
||||
|
||||
Reference in New Issue
Block a user