generated from coulomb/repo-seed
Complete SAND-WP-0001: bootstrap Python dev workflow
Scaffold sandboxer package (src layout, typer CLI stub, pytest, ruff), Makefile targets, and document install/test/lint/build commands in AGENTS.md and stack-and-commands.md. Mark bootstrap workplan finished.
This commit is contained in:
@@ -1,19 +1,40 @@
|
||||
## Stack
|
||||
|
||||
<!-- TODO: Fill in language, frameworks, and key dependencies -->
|
||||
- **Language:**
|
||||
- **Key deps:**
|
||||
- **Language:** Python 3.11+
|
||||
- **Package manager:** [uv](https://docs.astral.sh/uv/)
|
||||
- **Build:** hatchling (src layout: `src/sandboxer/`)
|
||||
- **CLI:** typer (`sandboxer` entry point)
|
||||
- **Test:** pytest
|
||||
- **Lint / format:** ruff
|
||||
|
||||
## Dev Commands
|
||||
|
||||
Run from the repo root. First-time setup:
|
||||
|
||||
```bash
|
||||
# TODO: Fill in the standard commands for this repo
|
||||
|
||||
# Install dependencies
|
||||
|
||||
# Run tests
|
||||
|
||||
# Lint / type check
|
||||
|
||||
# Build / package (if applicable)
|
||||
make setup # uv sync --all-groups → .venv
|
||||
```
|
||||
|
||||
Day-to-day verification (run before committing):
|
||||
|
||||
```bash
|
||||
make check # lint + test
|
||||
make test # pytest
|
||||
make lint # ruff check
|
||||
make format # ruff format (apply fixes)
|
||||
make build # uv build (wheel + sdist)
|
||||
make cli-version # smoke test: sandboxer version
|
||||
```
|
||||
|
||||
Equivalent `uv` invocations without Make:
|
||||
|
||||
```bash
|
||||
uv sync --all-groups
|
||||
uv run pytest
|
||||
uv run ruff check .
|
||||
uv run ruff format .
|
||||
uv build
|
||||
uv run sandboxer version
|
||||
```
|
||||
|
||||
No long-running service yet — API and provisioner land in SAND-WP-0002.
|
||||
Reference in New Issue
Block a user