Development¶
Instructions for developers.
On macOS¶
Install
-
brew install pyenv pyenv-virtualenv
-
brew install pipx
-
pipx install poetry
-
brew install ruff
Similar to this setup, but no tox and uses ruff.
Procedure¶
Get repo:
git clone
Install development environment:
poetry install
Launch virtualenv:
poetry shell
Code formatting:
poetry run ruff format
Linter:
poetry run ruff check
Test with coverage:
pytest --cov --cov-report term
PyPi publish checklist¶
Ref: Digital Ocean
- Bump version
-
pyproject.toml
-
src/beancount_multitool/__version__.py
- Update changelog
- Run local tests and coverage.
- Update coverage number in project
README.md
. -
git commit
- Check that the test GitHub Action succeed.
- Docs are build with a GitHub Action.
-
git tag -a v0.5.0 -m "v0.5.0"
-
poetry build
-
poetry publish