CONTRIBUTING.md

Contributing

Developer Setup

Install:

Note: you may have an issue installing psycopg2, see stackoverflow

pip install poetry # poetry is the python package manager for the repo

poetry install # will install project in a virtualenv

pre-commit install # setup linters etc.

pre-commit run --all-files # check pre-commit is happy before changing code

poetry shell

Run Python tests:

pytest -n=auto # Note: Some tests will fail if you don't run against Postgres

Build frontend and Python package

make

Build Docker image

docker build --tag hl .

Start HL in a temporary container

docker run -it --rm --entrypoint bash -p 8000:8000 hl -c 'hl initdb && hl up'