praful-dodda / purpleair_api

A Python3 wrapper written for the new PurpleAir API [https://api.purpleair.com/]. Find this package on pypi: https://pypi.org/project/purpleair-api/#history You can grab your own sensor here: https://www2.purpleair.com/

purple_air_api (PAA)

This is a python3 wrapper for the new PurpleAirAPI (PAA). Details of the API can be found using this link: https://api.purpleair.com/#api-welcome To use the PurpleAirAPI (PAA) api keys are required. You can get API keys by sending an email to [e-mail] with a first and last name to assign them to.

How to Support This Project

Purpose

This package is designed to be used for making tools around the PurpleAir API.

For example, PAA data loggers - https://github.com/carlkidcrypto/purpleair_data_logger

Installation

You can install the PurpleAir API via pip.

python3 -m pip install purple_air_api

You can install PurpleAir API by cloning down this repo.

git clone https://github.com/carlkidcrypto/purple_air_api.git
cd purple_air_api
python3 setup.py install

Usage Example

First we need to import the PurpleAir API (PAA)

from purpleair_api.PurpleAirAPI

Next we need to make an instance of PAA.

my_paa = PurpleAirAPI(your_api_read_key, your_api_write_key)

Now you can use that PAA instance to do things like...

retval = my_paa.request_sensor_data(1234)