Skip to content

ntadej/Vremenar-API

Repository files navigation

Vremenar API

Homepage Latest release License Continuous Integration codecov.io CodeFactor pre-commit

A simple API server for ARSO and DWD weather data.

Installation and running

Vremenar API is python-based, with Python 3.11 as the minimum supported version.

Python PDM

This project uses PDM to track dependencies. For basic setup run

pdm sync

Production running

Gunicorn is recommended and tested in production workflows. An example command is:

pdm run start

It is recommended to run the API behind a caching server such as varnish as none of the requests are cached by default.

Development running

Uvicorn can be used directly for development:

pdm run dev

Contributing

pre-commit

This project uses pre-commit. To setup, run

pre-commit install

To check all files run

pre-commit run --all

Copyright info

Copyright (C) 2020-2023 Tadej Novak

This project may be used under the terms of the GNU Affero General Public License version 3.0 as published by the Free Software Foundation and appearing in the file LICENSE.