aiohasupervisor 0.1.0__tar.gz

aiohasupervisor-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

aiohasupervisor-0.1.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.1
+Name: aiohasupervisor
+Version: 0.1.0
+Summary: Asynchronous python client for Home Assistant Supervisor.
+Author-email: The Home Assistant Authors <hello@home-assistant.io>
+License: Apache-2.0
+Project-URL: Homepage, https://www.home-assistant.io/
+Project-URL: Source Code, https://github.com/home-assistant-libs/python-supervisor-client
+Project-URL: Bug Reports, https://github.com/home-assistant-libs/python-supervisor-client/issues
+Project-URL: Docs: Dev, https://developers.home-assistant.io/
+Project-URL: Discord, https://www.home-assistant.io/join-chat/
+Project-URL: Forum, https://community.home-assistant.io/
+Keywords: docker,home-assistant,api,client-library
+Platform: any
+Requires-Python: >=3.12.0
+Description-Content-Type: text/markdown
+Provides-Extra: dev
+License-File: LICENSE
+
+# Home Assistant Supervisor Client
+
+## Client Library for Home Assistant Supervisor
+
+Python client for interfacing with the [Home Assistant Supervisor](https://github.com/home-assistant/supervisor)
+via its [REST API](https://developers.home-assistant.io/docs/api/supervisor/endpoints).
+Currently used in the [Home Assistant Supervisor integration](https://www.home-assistant.io/integrations/hassio/)
+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:
+
+```sh
+pip install aiohasupervisor
+```
+
+And then used via import
+
+```py
+import asyncio
+import supervisor_client
+
+asyncio.run(supervisor_client.info())
+```
+
+Output would look like the example response in `/info` from [here](https://developers.home-assistant.io/docs/api/supervisor/endpoints#root)
+
+## 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](https://github.com/home-assistant/addons-development).
+
+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](https://github.com/home-assistant/python-supervisor-client/fork)) or clone this repository.
+
+### Using it in development
+
+From within the devcontainer, open terminal and do the following:
+
+```shell
+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](#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](https://github.com/home-assistant/core) updating
+its [Home Assistant Supervisor integration](https://github.com/home-assistant/core/blob/dev/homeassistant/components/hassio).
+Follow the directions for updating [Requirements](https://developers.home-assistant.io/docs/creating_integration_manifest#requirements)
+in the Integration manifest.

aiohasupervisor-0.1.0/README.md

@@ -0,0 +1,85 @@
+# Home Assistant Supervisor Client
+
+## Client Library for Home Assistant Supervisor
+
+Python client for interfacing with the [Home Assistant Supervisor](https://github.com/home-assistant/supervisor)
+via its [REST API](https://developers.home-assistant.io/docs/api/supervisor/endpoints).
+Currently used in the [Home Assistant Supervisor integration](https://www.home-assistant.io/integrations/hassio/)
+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:
+
+```sh
+pip install aiohasupervisor
+```
+
+And then used via import
+
+```py
+import asyncio
+import supervisor_client
+
+asyncio.run(supervisor_client.info())
+```
+
+Output would look like the example response in `/info` from [here](https://developers.home-assistant.io/docs/api/supervisor/endpoints#root)
+
+## 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](https://github.com/home-assistant/addons-development).
+
+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](https://github.com/home-assistant/python-supervisor-client/fork)) or clone this repository.
+
+### Using it in development
+
+From within the devcontainer, open terminal and do the following:
+
+```shell
+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](#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](https://github.com/home-assistant/core) updating
+its [Home Assistant Supervisor integration](https://github.com/home-assistant/core/blob/dev/homeassistant/components/hassio).
+Follow the directions for updating [Requirements](https://developers.home-assistant.io/docs/creating_integration_manifest#requirements)
+in the Integration manifest.

aiohasupervisor-0.1.0/aiohasupervisor/__init__.py

@@ -0,0 +1,27 @@
+"""Init file for aiohasupervisor."""
+
+from aiohasupervisor.exceptions import (
+    SupervisorAuthenticationError,
+    SupervisorBadRequestError,
+    SupervisorConnectionError,
+    SupervisorError,
+    SupervisorForbiddenError,
+    SupervisorNotFoundError,
+    SupervisorResponseError,
+    SupervisorServiceUnavailableError,
+    SupervisorTimeoutError,
+)
+from aiohasupervisor.root import SupervisorClient
+
+__all__ = [
+    "SupervisorError",
+    "SupervisorConnectionError",
+    "SupervisorAuthenticationError",
+    "SupervisorBadRequestError",
+    "SupervisorForbiddenError",
+    "SupervisorNotFoundError",
+    "SupervisorResponseError",
+    "SupervisorServiceUnavailableError",
+    "SupervisorTimeoutError",
+    "SupervisorClient",
+]

aiohasupervisor-0.1.0/aiohasupervisor/addons.py

@@ -0,0 +1,94 @@
+"""Addons client for Supervisor."""
+
+from typing import Any
+
+from .client import _SupervisorComponentClient
+from .const import ResponseType
+from .models.addons import (
+    AddonsConfigValidate,
+    AddonsList,
+    AddonsOptions,
+    AddonsSecurityOptions,
+    AddonsStats,
+    AddonsUninstall,
+    InstalledAddon,
+    InstalledAddonComplete,
+)
+
+
+class AddonsClient(_SupervisorComponentClient):
+    """Handles installed addon access in Supervisor."""
+
+    async def list(self) -> list[InstalledAddon]:
+        """Get installed addons."""
+        result = await self._client.get("addons")
+        return AddonsList.from_dict(result.data).addons
+
+    async def addon_info(self, addon: str) -> InstalledAddonComplete:
+        """Get all info for addon."""
+        result = await self._client.get(f"addons/{addon}/info")
+        return InstalledAddonComplete.from_dict(result.data)
+
+    async def uninstall_addon(
+        self,
+        addon: str,
+        options: AddonsUninstall | None = None,
+    ) -> None:
+        """Uninstall an addon."""
+        await self._client.post(
+            f"addons/{addon}/uninstall",
+            json=options.to_dict() if options else None,
+        )
+
+    async def start_addon(self, addon: str) -> None:
+        """Start an addon."""
+        await self._client.post(f"addons/{addon}/start")
+
+    async def stop_addon(self, addon: str) -> None:
+        """Stop an addon."""
+        await self._client.post(f"addons/{addon}/stop")
+
+    async def restart_addon(self, addon: str) -> None:
+        """Restart an addon."""
+        await self._client.post(f"addons/{addon}/restart")
+
+    async def addon_options(self, addon: str, options: AddonsOptions) -> None:
+        """Set options for addon."""
+        await self._client.post(f"addons/{addon}/options", json=options.to_dict())
+
+    async def addon_config_validate(
+        self,
+        addon: str,
+        config: dict[str, Any],
+    ) -> AddonsConfigValidate:
+        """Validate config for an addon."""
+        result = await self._client.post(
+            f"addons/{addon}/options/validate",
+            response_type=ResponseType.JSON,
+            json=config,
+        )
+        return AddonsConfigValidate.from_dict(result.data)
+
+    async def addon_config(self, addon: str) -> dict[str, Any]:
+        """Get config for addon."""
+        result = await self._client.get(f"addons/{addon}/options/config")
+        return result.data
+
+    async def rebuild_addon(self, addon: str) -> None:
+        """Rebuild an addon (only available for local addons built from source)."""
+        await self._client.post(f"addons/{addon}/rebuild")
+
+    async def addon_stdin(self, addon: str, stdin: bytes) -> None:
+        """Write to stdin of an addon (if supported by addon)."""
+        await self._client.post(f"addons/{addon}/stdin", data=stdin)
+
+    async def addon_security(self, addon: str, options: AddonsSecurityOptions) -> None:
+        """Set security options for addon."""
+        await self._client.post(f"addons/{addon}/security", json=options.to_dict())
+
+    async def addon_stats(self, addon: str) -> AddonsStats:
+        """Get stats for addon."""
+        result = await self._client.get(f"addons/{addon}/stats")
+        return AddonsStats.from_dict(result.data)
+
+    # Omitted for now - Log endpoints