A clean, well-tested Python3 API for Flu Near You
Project description
🤒 pyflunearyou: A Python3 API for Flu Near You
pyflunearyou
is a simple Python library for retrieving UV-related information
from Flu Near You.
Installation
pip install pyflunearyou
Python Versions
pyflunearyou
is currently supported on:
- Python 3.6
- Python 3.7
- Python 3.8
- Python 3.9
Usage
import asyncio
from aiohttp import ClientSession
from pyflunearyou import Client
async def main() -> None:
"""Run!"""
client = Client()
# Get user data for a specific latitude/longitude:
await client.user_reports.status_by_coordinates(<LATITUDE>, <LONGITUDE>)
# Get user data for a specific ZIP code:
await client.user_reports.status_by_zip("<ZIP_CODE>")
# Get CDC data for a specific latitude/longitude:
await client.cdc_reports.status_by_coordinates(<LATITUDE>, <LONGITUDE>)
# Get CDC data for a specific state:
await client.cdc_reports.status_by_state('<USA_CANADA_STATE_NAME>')
asyncio.run(main())
By default, the library creates a new connection to Flu Near You 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 pyflunearyou import Client
async def main() -> None:
"""Run!"""
async with ClientSession() as session:
client = Client(session=session)
# ...
asyncio.run(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.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.
Source Distribution
pyflunearyou-2.0.2.tar.gz
(8.2 kB
view hashes)
Built Distribution
Close
Hashes for pyflunearyou-2.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ac9717cb44ab453342181c7cc4c76b21b611f30e4110eae183455a4ba410040b |
|
MD5 | 7b688529aadfa23a255506c5613c4f76 |
|
BLAKE2b-256 | 1df691790478a97be03438ac27003cf0e63727934f00d07e91e67c5c858caa04 |