Skip to content

ahayworth/python_awair

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2d42e4e · Sep 13, 2022
Sep 13, 2022
Mar 30, 2022
Aug 12, 2022
Aug 12, 2022
Aug 12, 2022
Apr 11, 2020
Apr 8, 2020
Sep 16, 2020
Apr 8, 2020
Apr 10, 2020
Apr 11, 2020
Apr 14, 2020
Nov 17, 2018
Sep 21, 2020
Apr 14, 2020
Aug 16, 2022
Aug 16, 2022

Repository files navigation

python_awair

Latest PyPI version CI codecov Documentation Status

This is an async library which accesses portions of the Awair 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 to get started!

Development

  • We manage dependencies and builds via poetry
  • We use pytest and 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.