Quartz API

API providing external access to Quartz forecast data.

Running the service

Configuration

The application is configured via the use of environment variables. See src/quartz_api/cmd/server.conf for the full specification of available environmental configuration.

Using Docker

Run the latest image from GitHub container registry:

$ docker run 
    -p 8000:8000 \
    -e <ENV_KEY>=<ENV_VALUE> \
    ghcr.io/openclimatefix/quartz-api:latest

Development

Clone the repository. Install all the dependencies with

$ uv sync

Running the service

To run the API locally, use the command

$ uv run quartz-api

The API should then be accessible at http://localhost:8000, and the docs at http://localhost:8000/docs (or whatever port you have configured).

Running Tests

Make sure that you have install the development dependencies (uv sync will do this for you). Then run the tests using

uv run pytest

Known Bugs

There may be some issues when installing this with windows.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Rahul Maurya 💻

Dubraska Solórzano 💻

Nicholas Tucker 💻

devsjc 💻

Suvan Banerjee 💻

Anas Khan 🚇

Edwardcg17 💻

This project follows the all-contributors specification. Contributions of any kind welcome!