Skip to content

Latest commit

 

History

History
44 lines (41 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

44 lines (41 loc) · 1.03 KB

Development

This project is managed using Poetry. Development requires Python 3.7+.

  • If you want to take advantage of the default VSCode integration, then first configure Poetry to make its virtual environment in the repository:
    poetry config virtualenvs.in-project true
    
  • After cloning the repository, activate the tooling:
    poetry install
    poetry run pre-commit install
    
  • Run unit tests:
    poetry run pytest --cov
    
  • Render documentation:
    pipx install mkdocs
    pipx runpip mkdocs install -r docs/requirements.txt
    mkdocs serve
    

VCS setup

Some of the VCS tools tested require a minimum configuration to work. Here is an example of how to configure them: