@@ -19,17 +19,18 @@ environment in the `.venv` folder with all dependencies installed in it, as
1919defined in ` pyproject.toml ` .
2020
2121Run any of the dev tools via the helper scripts in the ` tools ` folder. For
22- example ` uv run tools/lint.py ` to lint the code (same as ` uv run ruff check ` ),
23- ` uv run tools/types.py ` to check types, etc.
22+ example ` uv run tools/lint_code.py ` to lint the code for quality issues (same
23+ as ` uv run ruff check ` ), ` uv run tools/check_types.py ` to check type
24+ annotations, etc.
2425
25- You may also install into an existing virtual environment or even the global
26- Python environment with ` uv pip install --editable . ` . The ` --editable ` flag
27- makes it so that all code changes take immediate effect without re-installing
28- the package.
26+ Alternatively, you may also install from source into an existing virtual
27+ environment or even the global Python environment with `uv pip install --group
28+ dev --editable . ` . The ` --editable` flag makes it so that all code changes take
29+ immediate effect without re-installing the package.
2930
3031When using Pip, follow the standard workflow: Create a virtual Python
3132environment ` python -m venv .venv ` , activate it, and install the project in it
32- with ` pip install --editable . `
33+ with ` pip install --group dev -- editable . `
3334
3435[ UV ] : https://docs.astral.sh/uv
3536[ Pip ] : https://pip.pypa.io
@@ -42,17 +43,17 @@ with `pip install --editable .`
4243- Tag commit with version number, e.g. ` git tag v1.3.0 `
4344- Force ` stable ` branch to latest commit: ` git branch -f stable `
4445- Same for the current documentation branch: ` git branch -f 1.3 `
45- - Run code linter: ` uv run tools/lint .py `
46- - Test docs build: ` un run tools/docs .py `
47- - Test wheel build: ` uv run tools/wheel .py `
48- - Run code coverage: ` uv run tools/coverage .py `
46+ - Run code linter: ` uv run tools/lint_code .py `
47+ - Test docs build: ` un run tools/render_docs .py `
48+ - Test wheel build: ` uv run tools/build_wheel .py `
49+ - Run code coverage: ` uv run tools/measure_coverage .py `
4950- Push to GitHub:
5051```
5152git push origin main
5253git push --tags
5354git push origin stable
5455git push origin 1.3
5556```
56- - Upload coverage report: ` uv run tools/codecov .py `
57+ - Upload coverage report: ` uv run tools/report_codecov .py `
5758- Create new release on GitHub and add release notes.
58- - Publish to PyPI: ` uv run tools/publish.py `
59+ - Publish to PyPI via GitHub Action.
0 commit comments