Skip to content

DEVELOPING.md

Latest commit

 

History

History
86 lines (56 loc) · 1.33 KB

DEVELOPING.md

File metadata and controls

86 lines (56 loc) · 1.33 KB

Python

This project uses A | B syntax for type unions in type annotations, which requires Python 3.10+.

Native deps

Some Python packages assume that corresponding native dependencies are already present.

MacOS

brew install freetype imagemagick

virtualenv

You should use a virtualenv, through your preferred version management tool, for example pyenv or uv.

uv (optional)

uv is an all-in-one Python environment manager. Our current configuration permits, but does not require, the use of uv. To use uv, prefix Python-related commands with:

uv run

For example:

uv run python

Install this package as editable

uv

uv pip install --editable '.[dev]'

virtualenv (no uv)

source .venv/bin/activate
pip install --editable '.[dev]'

Run the web server

flask --app main.app run

or

gunicorn -w 4 'main:app'

Service dependencies via Docker Compose

Pano depends on service dependencies Postgres and MinIO. For your convenience, we provide a Docker Compose configuration that contains all service dependencies.

Start all service dependencies

docker compose --file ./dev/docker-compose.yml up --detach

Stop all service dependencies

docker compose --file ./dev/docker-compose.yml down

Automated tests

Run unit tests

pytest tests/unit/