BDDUC

Base De Datos Unificada y Comunitaria 📚

SetUp

Python

Se utiliza python 3.9 para el desarrollo. Esta versión puede ser instalada con pyenv:

pyenv install 3.9
pyenv local 3.9

Además se necesita tener instalado poetry. Se pueden instalar las dependencias con:

poetry install

Base de Datos

Se necesita tener instalado PostgreSQl. Además se necesita activar la extensión PostGIS, que se puede hacer con:

CREATE EXTENSION IF NOT EXISTS postgis;

Variables de entorno

Hay que rellenar las variable de entorno locales en un archivo .env. Se puede obtener el template con:

cp .env.template .template

Correr el servidor

uvicorn src.api.main:app --reload

Documentación

La documentación se encuentra en docs y puede ser generada gracias a mkdocs-material con:

# de forma estática
mkdocs build -d docs-site
# servidor de desarrollo
mkdocs serve

Tests

python -m pytest