Vishesh 'ironeagle' Bangotra
582b6809a0
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README - rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs - add pydoclint (google style) gate to dev extras and pyproject config - fix mcp nav resources doc:// -> docs:// - refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group - update wiki pages and add GSDFC + MCP guides under 05_development
21 lines
430 B
Markdown
21 lines
430 B
Markdown
# Environment Setup
|
|
|
|
## Create the environment
|
|
|
|
```bash
|
|
python -m venv .venv
|
|
.venv\Scripts\activate
|
|
pip install -e .
|
|
```
|
|
|
|
Requires Python 3.10+ (per `pyproject.toml`).
|
|
|
|
## Dependencies
|
|
|
|
Development extras include:
|
|
|
|
- `pytest`, `pytest-cov` — test suite and coverage
|
|
- `ruff` — lint and format checking
|
|
- `black` — auto-formatting
|
|
- `mypy` — strict typing checks
|
|
- `pydoclint` — docstring ↔ signature consistency checks |