Development#

Development environment is managed with poetry.

$ git clone https://github.com/Velocidensity/serializd-py
$ cd shorty
$ poetry install --with-dev

Pre-commit hooks#

To install pre-commit hooks, run:

$ pre-commit install

To build docs, install sphinx and furo theme with poetry, and then use make.

$ poetry install --with=docs
$ cd docs
$ make html