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:
2026-05-26 23:21:23 +02:00
parent 8c7bfb57f4
commit b483bf1f34
5 changed files with 118 additions and 14 deletions

View File

@@ -18,13 +18,61 @@ usable after `pip install -e .`:
- Automatic rule-based risk classification with mandatory confirmation for anything destructive, privileged, mass-edit, or network-affecting
- All LLM interaction flows through a documented `LLMAdapter` seam (currently a deterministic fake; ready for real `llm-connect`)
## Installation (development)
## Installation
### Recommended: Install from Development Head (Latest Code)
This is the easiest way to stay on the absolute latest version while you work:
```bash
git clone <this-repo>
git clone https://github.com/worsch/can-you-assist.git
cd can-you-assist
pip install -e .
# One-command developer install (includes dev tools)
make dev-install
# Or manually:
# pip install -e ".[dev]"
```
This installs the package in editable mode from your local checkout. You will always get the newest code when you pull.
After installation:
```bash
cya --help
cya --version # Will show a development version (e.g. 0.2.0.devN+g...)
```
### Alternative: Install Directly from Git (No Local Clone)
You can also install the latest code directly from GitHub without cloning first:
```bash
pip install "git+https://github.com/worsch/can-you-assist.git@main#egg=can-you-assist[dev]"
```
This is useful for quick testing or on remote machines.
### For Future Released Versions
Once we publish packages (future work), you will be able to do:
```bash
pip install can-you-assist
```
or a specific version:
```bash
pip install "can-you-assist>=0.3.0"
```
### Updating to Latest Development Code
```bash
cd can-you-assist
git pull
pip install -e ".[dev]" # or just `make dev-install`
```
## Usage examples
@@ -135,9 +183,12 @@ decisions, and integration guide.
## Development
```bash
pip install -e .
# Recommended one-liner (see Installation section above)
make dev-install
pytest tests/ -q
cya "..." # manual verification
make version # show current dev version
```
## License