A simple API for Pollen.com data
Project description
🌼 pypollencom: A Simple Python API for Pollen.com
pypollencom
is a simple Python library for allergen, asthma, and disease data
from Pollen.com.
PLEASE READ: Version 2.0.0 and Beyond
Version 2.0.0 of pypollencom
makes several breaking, but necessary changes:
- Moves the underlying library from Requests to aiohttp
- Changes the entire library to use
asyncio
- Makes 3.6 the minimum version of Python required
If you wish to continue using the previous, synchronous version of
pypollencom
, make sure to pin version 1.1.2.
Installation
pip install pypollencom
Usage
pypollencom
starts within an
aiohttp ClientSession
:
import asyncio
from aiohttp import ClientSession
from pypollencom 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 and get to it:
import asyncio
from aiohttp import ClientSession
from pypollencom import Client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as websession:
client = Client(80012, websession)
# ZIP codes starting with 0 need to be provided as strings:
client = Client('00544', websession)
# Get current allergen information:
await client.allergens.current()
# Get more information on the current allergen outlook:
await client.allergens.outlook()
# Get extended forecast allergen information:
await client.allergens.extended()
# Get historic allergen information:
await client.allergens.historic()
# Get extended forecast asthma information:
await client.asthma.extended()
# Get historic asthma information:
await client.asthma.historic()
# Get extended forecast cold and flu information:
await client.disease.extended()
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
pypollencom-2.2.0.tar.gz
(7.0 kB
view hashes)
Built Distribution
Close
Hashes for pypollencom-2.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b96cbf89853a3e75b76f1978ed3a4be4b8f5b4f8744886c1a5fea987fa15c27 |
|
MD5 | d65227fc25432d0bac3b846dd703fff5 |
|
BLAKE2b-256 | 967b59b6dd435b5dbbcda1d386f686d4a96da5557e0ee59cb122768d17f645a7 |