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.9
- Python 3.10
- Python 3.11
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:
poetry run pytest --cov pyoutbreaksnearme tests
- 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.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f304040b78c5b2bcb4408b3cdd09a5ffcbd0e6c88c5c7c18dd6aede29560d1e1 |
|
MD5 | fab804c8d72c000646423155306566b1 |
|
BLAKE2b-256 | 853ededbcd78dc30dbb5768fff247f1334574abe43be92c6208519a95f68c5a0 |
Close
Hashes for pyoutbreaksnearme-2022.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 53827cb9da9887c2646cdd1bd5e8a5a3d7437c551381870cbc7706a252ee07bc |
|
MD5 | ca83dd8d482112b29cc1fb3f4242b08b |
|
BLAKE2b-256 | c6257eef38883f56f04268ab61bbae14420774957a2c63d09e306d616cc5ae44 |