Skip to main content

A simple API for Pollen.com data

Project description

🌼 pypollencom: A Simple Python API for Pollen.com

Travis CI PyPi Version License Code Coverage Maintainability Say Thanks

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

  1. Check for open features/bugs or initiate a discussion on one.
  2. Fork the repository.
  3. Install the dev environment: make init.
  4. Enter the virtual environment: pipenv shell
  5. Code your new feature or bug fix.
  6. Write a test that covers your new functionality.
  7. Run tests and ensure 100% code coverage: make coverage
  8. Add yourself to AUTHORS.md.
  9. Submit a pull request!

Project details


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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pypollencom-2.2.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file pypollencom-2.2.0.tar.gz.

File metadata

  • Download URL: pypollencom-2.2.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for pypollencom-2.2.0.tar.gz
Algorithm Hash digest
SHA256 e5c2ae8d361357ddb22b38f5084e28b432493398ea46c30f09217f1cb74f1007
MD5 8cd86e37b07b34a21f2e4e1947e55fe4
BLAKE2b-256 a63c82401cb05422b4c6ebefddf452a654cf3716ac24a435b8fed92e7214e9f4

See more details on using hashes here.

File details

Details for the file pypollencom-2.2.0-py3-none-any.whl.

File metadata

  • Download URL: pypollencom-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for pypollencom-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8b96cbf89853a3e75b76f1978ed3a4be4b8f5b4f8744886c1a5fea987fa15c27
MD5 d65227fc25432d0bac3b846dd703fff5
BLAKE2b-256 967b59b6dd435b5dbbcda1d386f686d4a96da5557e0ee59cb122768d17f645a7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page