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
|
# python_awair


[](https://codecov.io/gh/ahayworth/python_awair)
[](https://python-awair.readthedocs.io/en/latest/?badge=latest)
This is an async library which accesses portions of the [Awair](https://getawair.com) REST API. It exists primarily
to support the Home Assistant integration, but is considered active and supported by its author. PRs welcome!
Features:
- Object-oriented approach to querying and handling data
- Supports the "user" portion of the API.
- Possible to list devices, user information, and to query for a variety of sensor data over various timeframes.
Not yet supported:
- Device API usage
- Organization API
- Device management (such as changing the display of a device)
Dive into our [documentation](https://python-awair.readthedocs.io/en/latest) to get started!
# Development
- We manage dependencies and builds via [poetry](https://python-poetry.org)
- We use [pytest](https://github.com/pytest-dev/pytest) and [tox](https://github.com/tox-dev/tox) to test
- A variety of linters are available and CI enforces them
After installing and configuring poetry:
- Run `poetry install` to install dev dependencies
- Run `poetry shell` to drop into a virtualenv
- Run `poetry run tox` (or just `tox` if you're in a virtualenv) to test
- Run `poetry run tox -e lint` (or just `tox -e lint` if you're in a virtualenv) to run linters.
|