Pre-release

This release is a pre-release and may not be stable for production use.

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

Create a feature branch on your fork/clone of the git repository.
Commit your changes.
Rebase your local changes against the main branch.
Run test suite with the pytest tests command or use Test Explorer and confirm that it passes.
Use ruff to format your code with the rules configured in this project
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.

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.2.2b4.tar.gz (38.9 kB view details)

Uploaded Dec 20, 2024 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

aiohasupervisor-0.2.2b4-py3-none-any.whl (36.7 kB view details)

Uploaded Dec 20, 2024 Python 3

File details

Details for the file aiohasupervisor-0.2.2b4.tar.gz.

File metadata

Download URL: aiohasupervisor-0.2.2b4.tar.gz
Upload date: Dec 20, 2024
Size: 38.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for aiohasupervisor-0.2.2b4.tar.gz
Algorithm	Hash digest
SHA256	`1a26d3214ad60dddf1624b27552e8114bab1b28cefdaa3f033936ec230013147`
MD5	`3df8e285b4806749e99775d4d66b4c44`
BLAKE2b-256	`205a470b78d423326d60884fdc8afc9e6b833e3768a9c84b5a0399a6c38f2130`

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiohasupervisor-0.2.2b4.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.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: aiohasupervisor-0.2.2b4.tar.gz
- Subject digest: 1a26d3214ad60dddf1624b27552e8114bab1b28cefdaa3f033936ec230013147
- Sigstore transparency entry: 157037827
- Sigstore integration time: Dec 20, 2024
Source repository:
- Permalink: home-assistant-libs/python-supervisor-client@3d8a26ed5a28d88b71f8118134ef2cf0e5f92c8c
- Branch / Tag: refs/tags/0.2.2b4
- Owner: https://github.com/home-assistant-libs
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yaml@3d8a26ed5a28d88b71f8118134ef2cf0e5f92c8c
- Trigger Event: release