Vishesh 'ironeagle' Bangotra
06ffd2febd
Squash-merge lib-standardisation: adopt repo standards across packaging, tooling, docs, and CI. - standardize pyproject.toml (canonical packaging, lint config, extras, GSDFC pydoclint) - add py.typed marker, modernize type hints and Google-style docstrings - nest generated docs under docs/lib and docs/mcp; add hand-written wiki - adopt standard Type A PyPI CI pipeline (tag==version guard + quality gate) - promote generated CHANGELOG.md; bump version to 0.0.7
30 lines
573 B
Markdown
30 lines
573 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
|
||
|
||
---
|
||
|
||
## Related
|
||
- [04 – Iterative Workflow](../04_iterative_workflow.md) · [02 – Quality Gates](02_quality_gates.md) |