Development

uv is a required package to develop.

Bootstrap the project

Install and git and uv

Clone:

$ git clone https://github.com/vcs-python/g.git

$ cd g

Install packages:

$ uv sync --all-extras --dev

Tests

uv run py.test

Helpers: make test

Automatically run tests on file save

1. make start (via pytest-watcher)

2. make watch_test (requires installing entr(1))

Documentation

Default preview server: http://localhost:8034

sphinx-autobuild will automatically build the docs, watch for file changes and launch a server.

From home directory: make start_docs From inside docs/: make start

Manual documentation (the hard way)

cd docs/ and make html to build. make serve to start http server.

Helpers: make build_docs, make serve_docs

Rebuild docs on file change: make watch_docs (requires entr(1))

Rebuild docs and run server via one terminal: make dev_docs (requires above, and a make(1) with -J support, e.g. GNU Make)

Formatting / Linting

ruff

The project uses ruff to handle formatting, sorting imports and linting.

Command

uv:

$ uv run ruff

If you setup manually:

$ ruff check .

make

$ make ruff

Watch

$ make watch_ruff

requires entr(1).

Fix files

uv:

$ uv run ruff check . --fix

If you setup manually:

$ ruff check . --fix

ruff format

ruff format is used for formatting.

Command

uv:

$ uv run ruff format .

If you setup manually:

$ ruff format .

make

$ make ruff_format

mypy

mypy is used for static type checking.

Command

uv:

$ uv run mypy .

If you setup manually:

$ mypy .

make

$ make mypy

Watch

$ make watch_mypy

requires entr(1).

Releasing

uv handles virtualenv creation, package requirements, versioning, building, and publishing. Therefore there is no setup.py or requirements files.

Update __version__ in __about__.py and pyproject.toml::

git commit -m 'build(g): Tag v0.1.1'
git tag v0.1.1
git push
git push --tags