API that consumes building limits and height plateaus, splits up the building limits according to the height plateaus, and stores these three entities (building limits, height plateaus and split building limits) in a persistent way.
The API is deployed at: https://api-split-building-limits.onrender.com/
The postgres database instance is deployed at: https://www.elephantsql.com/.
https://api-split-building-limits.onrender.com/docs
docker compose upThis will spin up a postgres local data base container.
A local or deployed database instance is needed to run the application.
Copy the .envrc.template to .envrc, and run direnv allow or source
the .envrc file manually. It should contain the database url DB_URL
of a deployed or local database.
poetry install
poetry run uvicorn src.app:app --reload --port 4011The API docs can be accessed at: http://127.0.0.1:4011/docs
Tests are using fast api test client, so there is no need to run the service.
Make sure you have the DB_URL environment variable set.
Run tests with:
poetry run pytestThe examples can be found in this jupyter notebook
Make sure you have the DB_URL environment variable set and the
application running.
To open the examples notebook you can use: poetry run jupyter notebook.
- The
notebookpackage. It is part of the dev group dependencies so it will automatically be installed usingpoetry install.
- Height plateaus should fully cover building limits. Otherwise a 400 (BAD REQUEST) is sent to the client.
- Neither height plateaus or building limits can contain overlapping geometries or inner holes. Otherwise a 400 (BAD REQUEST) is sent to the client.
Tracing, metrics and logs for the deployed version are monitored in Uptrace: https://app.uptrace.dev/
Uptrace documentation: https://uptrace.dev/get/instrument/opentelemetry-fastapi.html#what-is-opentelemetry