Development

Instructions for developers.

On macOS

Install

• Homebrew

• pyenv and pyenv-virtualenv

  brew install pyenv pyenv-virtualenv
  

• pipx

  brew install pipx
  

• Poetry

  pipx install poetry
  

• ruff

  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

Build documentation:

mkdocs build

PyPi publish checklist

Ref: Digital Ocean

• Bump version
• pyproject.toml
• src/beancount_multitool/__version__.py
• Update changelog in the documentation.
• Run local tests and coverage.
• Update coverage number in project README.md.
• Update documentation, if necessary
  • Build documentation and check for warnings and errors.
• git commit and git push.
• Check that tests and deploy docs actions succeeded on GitHub Action.
• Tag the new version: git tag -a v0.5.0 -m "v0.5.0"
• poetry build
• poetry publish