/winds-mobi-api

Real-time weather observations: data api

Primary LanguagePythonGNU Affero General Public License v3.0AGPL-3.0

winds-mobi-api

Uptime Uptime

Python standalone asyncIO API that provides different endpoints to get weather data from winds.mobi mongodb.

Deployed API versions:

OpenAPI documentation:

  • /doc
  • /redoc

Run the project with docker compose (simple way)

Dependencies

Create an .env file from .env.template read by docker compose:

  • cp .env.template .env

Then start the api:

Run the project locally

Dependencies

Create an .env.localhost file from .env.localhost.template read by dotenv for our local commands:

  • cp .env.localhost.template .env.localhost

Create python virtual environment and install dependencies

  • poetry install

Activate python virtual environment

  • poetry shell

Run the server

  • dotenv -f .env.localhost run uvicorn --proxy-headers --root-path "${ROOT_PATH}" --port 8001 winds_mobi_api.main:app
  • OpenAPI client: http://localhost:8001/doc

Licensing

winds.mobi is licensed under the AGPL License, Version 3.0. See LICENSE.txt