Asynchronous python client for Home Assistant Supervisor.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mdegat01 from gravatar.com mdegat01

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: The Home Assistant Authors
  • Tags docker , home-assistant , api , client-library
  • Requires: Python >=3.12.0
  • Provides-Extra: dev
Report project as malware

Project description

Home Assistant Supervisor Client

Client Library for Home Assistant Supervisor

Python client for interfacing with the Home Assistant Supervisor via its REST API. Currently used in the Home Assistant Supervisor integration in Home Assistant.

Add-ons which interface with Supervisor can also leverage it. The library expects to find the access token in the SUPERVISOR_TOKEN env which is set automatically by Supervisor for add-ons. Currently there is no way to get a long-lived access token for Supervisor outside these use cases so the library's usage is limited to these.

Installation

The library is published on pip and can be installed that way:

pip install aiohasupervisor

And then used via import

import asyncio
import supervisor_client

asyncio.run(supervisor_client.info())

Output would look like the example response in /info from here

Developing & contributing

Prerequisites

The client can interact remotely with the Home Assistant Supervisor using the remote_api add-on from the developer add-ons repository.

After installing and starting the add-on, a token is shown in the remote_api add-on log, which is needed for further development.

It is also recommended you use Visual Studio Code for development with the devcontainer extension. This will read the published devcontainer configuration and setup the development environment for you.

Get the source code

Fork (https://github.com/home-assistant-libs/python-supervisor-client/fork) or clone this repository.

Using it in development

From within the devcontainer, open terminal and do the following:

uv pip install -e .
export SUPERVISOR_API_URL=http://192.168.1.2
export SUPERVISOR_TOKEN=replace_this_with_remote_api_token
python examples/connectivity_test.py

Output should match the example response in /info as shown/linked above in Installation.

Note: Replace the 192.168.1.2 with the IP address of your Home Assistant instance running the remote_api add-on and use the token provided.

Contributing a change

  1. Create a feature branch on your fork/clone of the git repository.
  2. Commit your changes.
  3. Rebase your local changes against the main branch.
  4. Run test suite with the pytest tests command or use Test Explorer and confirm that it passes.
  5. Use ruff to format your code with the rules configured in this project
  6. Create a new Pull Request

Release

Any time the API changes for Home Assistant Supervisor a corresponding release should be published here. Once that release is available on pip a PR should be created to Home Assistant Core updating its Home Assistant Supervisor integration. Follow the directions for updating Requirements in the Integration manifest.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for mdegat01 from gravatar.com mdegat01

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache-2.0
  • Author: The Home Assistant Authors
  • Tags docker , home-assistant , api , client-library
  • Requires: Python >=3.12.0
  • Provides-Extra: dev

Release history Release notifications | RSS feed

This version

0.3.1

0.3.1b1 pre-release

0.3.1b0 pre-release

0.3.0

0.3.0b0 pre-release

0.2.2b6 pre-release

0.2.2b5 pre-release

0.2.2b4 pre-release

0.2.2b3 pre-release

0.2.2b2 pre-release

0.2.2b1 pre-release

0.2.2b0 pre-release

0.2.1

0.2.0

0.2.0b0 pre-release

0.1.0

0.1.0b1 pre-release

0.1.0b0 pre-release

Download files

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

Source Distribution

aiohasupervisor-0.3.1.tar.gz (41.3 kB view details)

Uploaded Source

Built Distribution

aiohasupervisor-0.3.1-py3-none-any.whl (38.8 kB view details)

Uploaded Python 3

File details

Details for the file aiohasupervisor-0.3.1.tar.gz.

File metadata

  • Download URL: aiohasupervisor-0.3.1.tar.gz
  • Upload date:
  • Size: 41.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for aiohasupervisor-0.3.1.tar.gz
Algorithm Hash digest
SHA256 6d88c32e640932855cf5d7ade573208a003527a9687129923a71e3ab0f0cdf26
MD5 3ed10ef9c9daf8b90843e7bed2afd678
BLAKE2b-256 28c2cd208f6b6bc78675130a4ed883bfd6de3e401131233ee85c4e3f6c231166

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohasupervisor-0.3.1.tar.gz:

Publisher: release.yaml on home-assistant-libs/python-supervisor-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aiohasupervisor-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aiohasupervisor-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d5fa5df20562177703c701e95889a52595788c5790a856f285474d68553346a3
MD5 b616633b5590925fe4a003ea8be90073
BLAKE2b-256 d9a3f1d1e351c722f1a6343289b0aaff86391f3e4b2e2292760f9420f8a3628e

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohasupervisor-0.3.1-py3-none-any.whl:

Publisher: release.yaml on home-assistant-libs/python-supervisor-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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