Metadata-Version: 2.1
Name: srf-weather
Version: 0.1.0
Summary: A weather app for SRF
License: MIT
Author: Andreas Weier
Author-email: andreas.weier.open.source@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/markdown

# SRF Weather
Wrapper around the SRF freemium API (https://developer.srgssr.ch/api-catalog/srf-weather/srf-weather-description)
For api definition see also https://developer.srgssr.ch/api-catalog/srf-weather


## Installation
~~~ bash
pip install srf-weather
~~~

## Development
In order to develop this package, you need to install the following tools:
* [poetry](https://python-poetry.org/docs/#installation)
* [tox](https://tox.readthedocs.io/en/latest/install.html)

poetry is used to manage the dependencies and to build the package.
tox is used to run automated tests.


### Build, Test and Publish
~~~ bash
poetry build
poetry install dist/srf_weather-0.1.0-py3-none-any.whl --all-extras
poetry publish --build
~~~



### Test
Tox is used to run automated tests. Tox is configured to run tests for python 3.8 and 3.10
To run tests, install tox and run `tox` in the root directory of the project.
In order to run the tests, the following environment variables must be set:
* `SRF_WEATHER_API_KEY`: The api key to use for the tests
* `SRF_WEATHER_API_SECRET`: The api secret to use for the tests


~~~ bash
pip install tox
tox
~~~


