Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/carlkidcrypto/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/
https://github.com/carlkidcrypto/purpleair_api
purpleair purpleair-api purpleair-sensor purpleairapi python python3
Last synced: 3 months ago
JSON representation
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/
- Host: GitHub
- URL: https://github.com/carlkidcrypto/purpleair_api
- Owner: carlkidcrypto
- License: mit
- Created: 2023-01-22T05:01:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T14:46:42.000Z (3 months ago)
- Last Synced: 2024-09-26T14:49:13.903Z (3 months ago)
- Topics: purpleair, purpleair-api, purpleair-sensor, purpleairapi, python, python3
- Language: Python
- Homepage: https://carlkidcrypto.github.io/purpleair_api/
- Size: 5.97 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# purple_air_api (PAA)
This is a python3 wrapper for the new PurpleAirAPI (PAA). Details of the API can be found using this link:
To use the PurpleAirAPI (PAA) api keys are required. You can get API keys by sending an email to `[email protected]` with a first and last name to assign them to.
| [](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_pypi.yml) | [](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/build_and_publish_to_test_pypi.yml) | [](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/black.yml) |
| --------------- | --------------- | --------------- |
| [](https://github.com/carlkidcrypto/purpleair_api/actions/workflows/tests.yml) | [](https://github.com/carlkidcrypto/purpleair_api/releases) | [](https://github.com/carlkidcrypto/purpleair_api/releases/tag/v1.2.0) |
| --------------- | --------------- | --------------- |
## 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 -
## Installation
You can install the PurpleAir API via pip.
```bash
python3 -m pip install purple_air_api
```
You can install PurpleAir API by cloning down this repo.
```bash
git clone https://github.com/carlkidcrypto/purple_air_api.git
cd purple_air_api
python3 setup.py install
```
## PurpleAirAPI Usage Example
First we need to import the PurpleAir API (PAA)
```python
from purpleair_api.PurpleAirAPI import PurpleAirAPI
```
Next we need to make an instance of PAA.
```python
my_paa = PurpleAirAPI(your_api_read_key, your_api_write_key, your_ipv4_address)
```
Now you can use that PAA instance to do things like...
```python
retval = my_paa.request_sensor_data(1234)
```
> Note: PurpleAirAPI is the main entry point. It will load read, write, and local submodules
based on the parameters that are passed in upon construction. If you wish to only use a
small piece of PurpleAirAPI then see the examples below.
## PurpleAirReadAPI Usage Example
First we need to import the PurpleAirReadAPI.
```python.
from purpleair_api.PurpleAirReadAPI import PurpleAirReadAPI
```
Now we need to make an instance if it.
```python
my_paa = PurpleAirReadAPI(api_read_key)
```
Now we can use that instance to do things like...
```python
retval = my_paa.request_multiple_sensors_data("name")
```
## PurpleAirWriteAPI Usage Example
First we need to import the PurpleAirWriteAPI.
```python.
from purpleair_api.PurpleAirWriteAPI import PurpleAirWriteAPI
```
Now we need to make an instance if it.
```python
my_paa = PurpleAirWriteAPI(api_write_key)
```
Now we can use that instance to do things like...
```python
retval = my_paa.post_create_member(1234)
```
## PurpleAirLocalAPI Usage Example
First we need to import the PurpleAirLocalAPI.
```python.
from purpleair_api.PurpleAirLocalAPI import PurpleAirLocalAPI
```
Now we need to make an instance if it.
```python
my_paa = PurpleAirLocalAPI(["ipv4_address"])
```
Now we can use that instance to do things like...
```python
retval = my_paa.request_local_sensor_data()
```
## Tests
Refer to the test [readme](/tests/README.md)