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.10
- Python 3.11
- Python 3.12
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
Thanks to all of our contributors so far!
- 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 on a new branch.
- Write tests that cover your new functionality.
- Run tests and ensure 100% code coverage:
poetry run pytest --cov pyoutbreaksnearme tests
- Update
README.md
with any new documentation. - 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-2023.12.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b5b7126b6057e913d145599aed79ff0d0eead8c9477c91924c25795da0d72db |
|
MD5 | 1209b59c7c3f399b0378046e6af74608 |
|
BLAKE2b-256 | 832b4220f94d8d6f6d81822e5a5caf58399e807ca415e8b4c7f93979cca30521 |
Close
Hashes for pyoutbreaksnearme-2023.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53cbcda994cd7afebae46a615f800d0d7e0d33291b135b7e5d24e222e03e0fbb |
|
MD5 | c1be5bab1797a33bda02d5fab8ad2503 |
|
BLAKE2b-256 | fbf813ac13b75faebd9ada521f569d7a41149f55a745ae520c1a8fcdae237b5e |