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
API Key
You can get an API key from the OpenUV console.
Usage
pyopenuv starts within an
aiohttp ClientSession:
import asyncio
from aiohttp import ClientSession
from pyopenuv import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as websession:
# YOUR CODE HERE
asyncio.get_event_loop().run_until_complete(main())
Create a client, initialize it, then get to it:
import asyncio
from aiohttp import ClientSession
from pyopenuv import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as websession:
client = pyopenuv.Client(
"<OPENUV.IO API KEY>",
"<LATITUDE>",
"<LONGITUDE>",
websession,
altitude="<ALTITUDE>")
# Get current UV index information:
await client.uv_index()
# Get forecasted UV information:
await client.uv_forecast()
# Get information on the window of time during which SPF protection
# should be used:
await client.uv_protection_window()
asyncio.get_event_loop().run_until_complete(main())
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.mdwith any new documentation. - Add yourself to
AUTHORS.md. - Submit a pull request!
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.
Source Distribution
pyopenuv-1.0.13.tar.gz
(4.7 kB
view hashes)
Built Distribution
Close
Hashes for pyopenuv-1.0.13-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ef27d846af6c2c4bb246aca08a763264b9dfc2d24e365b959c6af56fe2b7c20b |
|
| MD5 | beb1aba80fc840c6c3955e32cd87ea82 |
|
| BLAKE2b-256 | 6ea4002391be64df6572542c5831606ba9d621dc737b8bdd99d39b97c91870fd |
