This commit is contained in:
+32
@@ -0,0 +1,32 @@
|
||||
# Build Instructions — Wedding Newspaper Generator
|
||||
|
||||
## Dependencies
|
||||
- `uv` (0.11.x) — the confirmed local runtime (Python 3.12 in the venv).
|
||||
- `newspaper/.venv` created by `uv sync`; pytest installed as a dev extra.
|
||||
|
||||
## Install
|
||||
```bash
|
||||
cd newspaper && uv sync --extra dev
|
||||
```
|
||||
|
||||
## Build
|
||||
This is a pure-Python static generator — there is no compile/bundle step.
|
||||
The "build" is producing the packaged `newspaper` package importable and the
|
||||
CLI working:
|
||||
```bash
|
||||
uv run --project newspaper python -c "import newspaper.generator, newspaper.ai_draft, newspaper.funnies; print('packages import OK')"
|
||||
```
|
||||
|
||||
## Verify
|
||||
- Run the full test suite (see `integration-test-instructions.md`).
|
||||
- Generate a sample issue:
|
||||
```bash
|
||||
uv run --project newspaper python -m newspaper.generator.cli --project <sample_dir>
|
||||
```
|
||||
and open/eyeball the A4 print in the browser (the real print acceptance).
|
||||
|
||||
## Troubleshooting
|
||||
- `ModuleNotFoundError: newspaper` → run with `UV_PROJECT_PATH`/from repo root,
|
||||
or `uv sync && uv run --project newspaper pytest`.
|
||||
- Missing deps → rerun `uv sync --extra dev`.
|
||||
- `__pycache__` artifacts → ignored via `.gitignore` (never commit).
|
||||
Reference in New Issue
Block a user