A simple Python API data from openuv.io
Project description
☀️ pyopenuv: A simple Python API for data from openuv.io
pyopenuv
is a simple Python library for retrieving UV-related information from
openuv.io.
Installation
pip install pyopenuv
Python Versions
pyopenuv
is currently supported on:
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9
API Key
You can get an API key from the OpenUV console.
Usage
import asyncio from pyopenuv import Client from pyopenuv.errors import OpenUvError async def main(): client = Client( "<OPENUV_API_KEY>", "<LATITUDE>", "<LONGITUDE>", altitude="<ALTITUDE>" ) try: # Get current UV info: print(await client.uv_index()) # Get forecasted UV info: print(await client.uv_forecast()) # Get UV protection window: print(await client.uv_protection_window()) except OpenUvError as err: print(f"There was an error: {err}") asyncio.run(main())
By default, the library creates a new connection to OpenUV with each coroutine. If you
are calling a large number of coroutines (or merely want to squeeze out every second of
runtime savings possible), an
aiohttp
ClientSession
can be used for connection
pooling:
import asyncio from aiohttp import ClientSession from pyopenuv import Client from pyopenuv.errors import OpenUvError async def main(): async with ClientSession() as session: client = Client( "<OPENUV_API_KEY>", "<LATITUDE>", "<LONGITUDE>", altitude="<ALTITUDE>", session=session, ) try: # Get current UV info: print(await client.uv_index()) # Get forecasted UV info: print(await client.uv_forecast()) # Get UV protection window: print(await client.uv_protection_window()) except OpenUvError as err: print(f"There was an error: {err}") asyncio.run(main())
Check out the examples directory for more info.
Contributing
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- (optional, but highly recommended) Create a virtual environment:
python3 -m venv .venv
- (optional, but highly recommended) Enter the virtual environment:
source ./venv/bin/activate
- Install the dev environment:
script/setup
- Code your new feature or bug fix.
- Write tests that cover your new functionality.
- Run tests and ensure 100% code coverage:
script/test
- Update
README.md
with any new documentation. - Add yourself to
AUTHORS.md
. - Submit a pull request!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pyopenuv-2.0.2-py3-none-any.whl (5.0 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size pyopenuv-2.0.2.tar.gz (5.1 kB) | File type Source | Python version None | Upload date | Hashes View |