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. It supports both sync and async use cases.
Installation
pip install pyopenuv
Python Versions
pyopenuv
is currently supported on:
- Python 3.6
- Python 3.7
- Python 3.8
API Key
You can get an API key from the OpenUV console.
Usage
Sync (Normal) Usage
from pyopenuv import Client
from pyopenuv.errors import OpenUvError
API_KEY = "<OPENUV_API_KEY>"
LATITUDE = 39.7974509
LONGITUDE = -104.8887227
ALTITUDE = 1609.3
client = Client(API_KEY, LATITUDE, LONGITUDE, altitude=ALTITUDE)
try:
# Get current UV info:
print(client.uv_index())
# Get forecasted UV info:
print(client.uv_forecast())
# Get UV protection window:
print(client.uv_protection_window())
except OpenUvError as err:
print(f"There was an error: {err}")
Async Usage
To use the library in an asyncio
-friendly way, simply pass the use_async
parameter when
creating a client. From there, the same methods can be used, but now as coroutines:
import asyncio
from pyopenuv import Client
from pyopenuv.errors import OpenUvError
API_KEY = "<OPENUV_API_KEY>"
LATITUDE = 39.7974509
LONGITUDE = -104.8887227
ALTITUDE = 1609.3
async def main():
client = Client(API_KEY, LATITUDE, LONGITUDE, altitude=ALTITUDE, use_async=True)
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.get_event_loop().run_until_complete(main())
By default, the asyncio
-friendly method creates a new connection to OpenUV with each
coroutine; this means that you won't get much in the way of runtime speed savings over
the normal, sync API. 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
API_KEY = "<OPENUV_API_KEY>"
LATITUDE = 39.7974509
LONGITUDE = -104.8887227
ALTITUDE = 1609.3
async def main():
async with ClientSession() as session:
client = Client(
API_KEY,
LATITUDE,
LONGITUDE,
altitude=ALTITUDE,
session=session,
use_async=True,
)
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.get_event_loop().run_until_complete(main())
Check out the [examples/
](https://github.com/bachya/pyopenuv/tree/dev/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.