A Python3 API for Outbreaks Near Me
Project description
🚰 pyoutbreaksnearme: A Python3 API for Outbreaks Near Me
pyoutbreaksnearme
is a Python3, asyncio-based library for getting data from
Outbreaks Near Me.
Installation
pip install pyoutbreaksnearme
Python Versions
pyoutbreaksnearme
is currently supported on:
- Python 3.8
- Python 3.9
- Python 3.10
Usage
import asyncio
from aiohttp import ClientSession
from pyoutbreaksnearme import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
client = await Client()
# Get user-reported data for the location closest to a latitude/longitude:
nearest_user_data = await client.user_data.async_get_nearest_by_coordinates(
40.7152, -73.9877
)
# Get totals for user-reported data:
user_totals_data = await client.user_data.async_get_totals()
# Get CDC data for the location closest to a latitude/longitude:
nearest_user_data = await client.cdc_data.async_get_nearest_by_coordinates(
40.7152, -73.9877
)
asyncio.run(main())
By default, the library creates a new connection to Outbreaks Near Me 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 pyoutbreaksnearme import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as session:
# Create a Notion API client:
client = await Client(session=session)
# Get to work...
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:
nox -rs coverage
- 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
Built Distribution
Close
Hashes for pyoutbreaksnearme-2022.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0a7220c873f606c86c252481f2f3b281518767173ff0e0dce196217574b4ede |
|
MD5 | 8be0448dac40c5bfe433c6cd6d728567 |
|
BLAKE2b-256 | 9be0612d3153fd7d25e339d34adf9ce9bda2e647cfbc8ac15a4d3f45bd81cb0c |
Close
Hashes for pyoutbreaksnearme-2022.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7e1f48b2b75bf27c97981a391e2db4d6c66c893d4afae84005520f95d447de58 |
|
MD5 | 1e2df8bc1a64b82cc96e45f37c6f922a |
|
BLAKE2b-256 | 8b1aa25d7e6af1b09210c586dd37f208fb3c1e28d041edc42b1f0661e501023f |