Skip to main content

A clean, well-tested Python3 API for Flu Near You

Project description

🤒 pyflunearyou: A Python3 API for Flu Near You

Travis CI PyPi Version License Code Coverage Maintainability Say Thanks

pyflunearyou is a simple Python library for retrieving UV-related information from Flu Near You.

Installation

pip install pyflunearyou

Python Versions

pyflunearyou 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.

API Key

Usage

pyflunearyou starts within an aiohttp ClientSession:

import asyncio

from aiohttp import ClientSession

from pyflunearyou 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 work:

import asyncio

from aiohttp import ClientSession

from pyflunearyou import create_client


async def main() -> None:
    """Create the aiohttp session and run the example."""
    async with ClientSession() as websession:
      client = await create_client(<LATITUDE>, <LONGITUDE>, websession)

      # Get user data for the client's latitude/longitude:
      await client.user_reports.status()

      # Get user data for the a specific ZIP code:
      await client.user_reports.status_by_zip("90046")

      # Get CDC data for the client's latitude/longitude:
      await client.cdc_reports.status()

      # Get CDC data for North Dakota
      await client.cdc_reports.status_by_state('North Dakota')

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

pyflunearyou-0.0.2.tar.gz (6.7 kB view hashes)

Uploaded Source

Built Distribution

pyflunearyou-0.0.2-py3-none-any.whl (9.1 kB view hashes)

Uploaded Python 3

Supported by

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