Skip to main content

Local setup

Install dependencies with Poetry:
Run commands against a selected environment:

Tests and lint

Run tests:
Run lint:

Build

Build source and wheel distributions:
Smoke test a local wheel:
Local wheel installs are useful for smoke testing, but they are not a good long-term pipx source because pipx upgrade hevn-cli reinstalls from the same local artifact.

Publishing

PyPI publishing is handled by the Publish to PyPI GitHub Actions workflow. Run it manually from main. The workflow:
  • runs lint and tests,
  • checks hevn --help on Ubuntu, macOS, and Windows,
  • builds the package once from Ubuntu,
  • publishes to PyPI with trusted publishing.
Configure the PyPI trusted publisher for:

Homebrew formula guidance

The Homebrew formula should install the PyPI package inside Homebrew’s isolated Python virtualenv. Do not shell out to system pip install hevn-cli from the formula.