1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
python_awair
========================================
*python_awair* is an asyncio client for the Awair_ REST API_.
The main goal of the project is to provide a useful, object-oriented
client, rather than a thin veneer over the underlying API. A secondary
goal is to support the Home Assistant integration_, though the project
wishes to be useful to all.
Currently, the project supports:
* Fetching user information, devices owned by a user, and API usage information
* Retreiving current, summary, and raw air quality information for the *user* devices
Planned features:
* Supporting the *user* device management API
* Supporting the *organization* API
This library is considered active and supported by its author, and PRs or issues are
gladly accepted.
Getting started
---------------
Install *python_awair* from pip::
$ pip install python_awair
You'll need an access token for the Awair API, which you can obtain from the `developer portal`_.
.. _Awair: https://getawair.com
.. _API: https://docs.developer.getawair.com/?version=latest
.. _integration: https://www.home-assistant.io/integrations/awair/
.. _`developer portal`: https://developer.getawair.com
.. toctree::
:maxdepth: 2
:caption: Contents:
examples.rst
python_awair.rst
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
