Defines an API to help with building frontends pertaining to displaying wind and solar data.

The application is configured via the use of environment variables. For the environment variable please set: DB_URL in bash Currently there is only one source adaptor so there is nothing to configure.

You can either download the latest image from GitHub container registry:

$ docker run ghcr.io/openclimatefix/india-api:latest

Or build and run locally using the Containerfile:

$ docker build -t india-api .
$ docker run india-api

Clone the repository, and create a new virtual environment with your favorite environment manager. Install the dependencies with

$ pip install -e .

The service is then runnable via the command india-api. You should see the following output:

INFO:     Started server process [87312]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on https://0.0.0.0:8000 (Press CTRL+C to quit)

The API should then be accessible at https://localhost:8000, and the docs at https://localhost:8000/docs.

Clone the repository, and create a new environment with your favorite environment manager. Install all the dependencies with

pip install -e ".[all]"

You can run the service with the command india-api. Changes will be hot-reloaded by the server.

Make sure that you have pytest and testcontainers installed.

Then run the tests using

pytest

There may be some issues when installing this with windows.

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!