Skip to main content

asyncio client for the Awair GraphQL and Local APIs

Project description

python_awair

Latest PyPI version CI codecov Documentation Status

This is an async library which accesses portions of the Awair REST API, and it exists primarily to support the Home Assistant integration for Awair devices.

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!

Status

This project could be considered in "maintenance mode". It meets the needs of the Home Assistant integration, and there are no current plans to add new features. Large PRs adding significant new features or drastically changing the library are unlikely to be accepted without prior discussion (please open an issue first).

However, bug fixes and updates to support python and/or Home Assistant compatibility are welcomed and accepted! I intend to keep passively maintaining the library, and please open an issue if there is an unaddressed need.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python_awair-0.2.5.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_awair-0.2.5-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

Details for the file python_awair-0.2.5.tar.gz.

File metadata

  • Download URL: python_awair-0.2.5.tar.gz
  • Upload date:
  • Size: 14.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.7 Darwin/24.6.0

File hashes

Hashes for python_awair-0.2.5.tar.gz
Algorithm Hash digest
SHA256 96f54754db6a3c35047bf4539cd76777fb9924d55f677d3d6cec36e2d82dc77f
MD5 697b09020d277f0b252d67d3a5a06031
BLAKE2b-256 86d7f43bcbfb3bd204cf1bff03b10dc40dec8c83fed11c6edcbb1f2e1daddcea

See more details on using hashes here.

File details

Details for the file python_awair-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: python_awair-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.7 Darwin/24.6.0

File hashes

Hashes for python_awair-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 86b08b957834f7dc0617794be27888368a14f0cdcf57b384bbda0aa27c1c18e1
MD5 9185aabb01c0328845c3c7b2205f9a18
BLAKE2b-256 62998f189e7b3042328f667f65573d5afff8b7d47963f46419f2108a3b0972d7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page