After cloning the project, you'll need to set up the development environment. Here are the guidelines on how to do this.
The development workflow should look like this:
- Add feature/fix bug
- Run tests
- Add tests
- Run tests
- Lint
- Add docs
- Open PR
Create venv with PDM
pdm venv create 3.10
source .venv/bin/activate
Install dependencies with just
just install
or
pdm install -G:all
pip install -r docs/requirements.txt
pre-commit install
just test
or
pytest tests --cov=asgi_monitor --cov-append --cov-report term-missing -v
just lint
or
pre-commit run --all-files
just doc
or
sphinx-build -M html docs docs-build
echo "Open file://`pwd`/docs-build/html/index.html"