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.

Python Versions

pypollencom is currently supported on:

  • Python 3.5
  • Python 3.6
  • Python 3.7

However, running the test suite currently requires Python 3.6 or higher; tests run on Python 3.5 will fail.

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 current asthma information:
      await client.asthma.current()

      # 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.2.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

pypollencom-2.2.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pypollencom-2.2.2.tar.gz
  • Upload date:
  • Size: 7.4 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.2.tar.gz
Algorithm Hash digest
SHA256 d351407ebcbd46b5c830d6499bb34aae95f1ae0af1c3dfadfed34b1ba73795fd
MD5 ea39a1c50e0ccd6caa5927d74a9307da
BLAKE2b-256 432e2ad7d9a3198c08cf3a70cf499b6d62ba33f5bd76a3d3251be2e600a3c13f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pypollencom-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 530bbddc1a379849e76fbc51371a0fb7c51ba207f7239d297fb1d56be5ebff88
MD5 29d0e97ab67604a0bb21a86b34481d59
BLAKE2b-256 366d49752d8b6babb892dea2e799c04fa8e19fb7e770c946cc18a484fdb44e64

See more details on using hashes here.

Supported by

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