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
☀️ Usage
First, get an API key: https://www.openuv.io/console
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.
- Install the dev environment:
make init
. - Enter the virtual environment:
pipenv shell
- Code your new feature or bug fix.
- Write a test that covers your new functionality.
- Run tests and ensure 100% code coverage:
make coverage
- 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.
Source Distribution
pyopenuv-1.0.6.tar.gz
(4.7 kB
view hashes)