HomeAssistant-API 5.0.2.post2__tar.gz → 6.0.0__tar.gz

homeassistant_api-6.0.0/.gitignore

@@ -0,0 +1,161 @@
+CHANGELOG.draft.md
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Pycharm
+.idea/
+venv/
+
+# Ruff
+.ruff_cache
+
+# Repl.it
+.replit
+.breakpoints
+
+# Informal testing
+main*.py
+
+# Cache files
+*.sqlite
+
+# Test Server
+test_server/
+
+# Custom Components
+volumes/config/.storage/custom_components/
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+uv.lock
+poetry.lock
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Docker Outputs
+volumes/coverage/
+volumes/config/.HA_VERSION
+volumes/config/home-assistant*
+volumes/config/deps
+.code-graph/

{homeassistant_api-5.0.2.post2 → homeassistant_api-6.0.0}/PKG-INFO

@@ -1,30 +1,17 @@
 Metadata-Version: 2.4
 Name: HomeAssistant-API
-Version: 5.0.2.post2
+Version: 6.0.0
 Summary: Python Wrapper for Homeassistant's REST API
-License: GPL-3.0-or-later
-License-File: LICENSE
-Author: GrandMoff100
-Author-email: minecraftcrusher100@gmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: aiohttp (>=3,<4)
-Requires-Dist: aiohttp-client-cache (>=0,<1)
-Requires-Dist: pydantic (>=2,<3)
-Requires-Dist: requests (>=2,<3)
-Requires-Dist: requests-cache (>=1,<2)
-Requires-Dist: simplejson (>=3,<4)
-Requires-Dist: websockets (>=15,<16)
 Project-URL: Documentation, https://homeassistantapi.readthedocs.io
 Project-URL: Homepage, https://github.com/GrandMoff100/HomeAssistantAPI
 Project-URL: Repository, https://github.com/GrandMoff100/HomeAssistantAPI
+Author-email: GrandMoff100 <minecraftcrusher100@gmail.com>
+License-Expression: GPL-3.0-or-later
+License-File: LICENSE
+Requires-Python: <4.0,>=3.11
+Requires-Dist: niquests[ws]>=3
+Requires-Dist: pydantic<3,>=2
+Requires-Dist: simplejson<4,>=3
 Description-Content-Type: text/markdown
 
 # HomeassistantAPI
@@ -54,25 +41,22 @@ with Client(
     '<API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
     '<Your Long Lived Access-Token>'
 ) as client:
-    light = client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-All the methods also support async/await!
-Just prefix the method with `async_` and pass the `use_async=True` argument to the `Client` constructor.
-Then you can use the methods as coroutines
-(i.e. `await light.async_turn_on(...)`).
+All four client classes share the same method names.
+The async clients (`AsyncClient`, `AsyncWebsocketClient`) use `async def` methods that you `await`.
 
 ```py
 import asyncio
-from homeassistant_api import Client
+from homeassistant_api import AsyncClient
 
 async def main():
-    with Client(
+    async with AsyncClient(
         '<REST API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
         '<Your Long Lived Access-Token>',
-        use_async=True
     ) as client:
-    light = await client.async_trigger_service('light', 'turn_on', entity_id="light.living_room")
+        await client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 
 asyncio.run(main())
 ```
@@ -86,11 +70,9 @@ with WebsocketClient(
     '<WS API Server URL>', # i.e. 'ws://homeassistant.local:8123/api/websocket'
     '<Your Long Lived Access-Token>'
 ) as ws_client:
-    light = ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-> Note: The Websocket API is not yet supported in async/await mode.
-
 ## Documentation
 
 All documentation, API reference, contribution guidelines and pretty much everything else
@@ -105,4 +87,3 @@ We'd love to hear about how you use our library!!
 ## License
 
 This project is under the GNU GPLv3 license, as defined by the Free Software Foundation.
-

{homeassistant_api-5.0.2.post2 → homeassistant_api-6.0.0}/README.md

@@ -25,25 +25,22 @@ with Client(
     '<API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
     '<Your Long Lived Access-Token>'
 ) as client:
-    light = client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-All the methods also support async/await!
-Just prefix the method with `async_` and pass the `use_async=True` argument to the `Client` constructor.
-Then you can use the methods as coroutines
-(i.e. `await light.async_turn_on(...)`).
+All four client classes share the same method names.
+The async clients (`AsyncClient`, `AsyncWebsocketClient`) use `async def` methods that you `await`.
 
 ```py
 import asyncio
-from homeassistant_api import Client
+from homeassistant_api import AsyncClient
 
 async def main():
-    with Client(
+    async with AsyncClient(
         '<REST API Server URL>', # i.e. 'http://homeassistant.local:8123/api/'
         '<Your Long Lived Access-Token>',
-        use_async=True
     ) as client:
-    light = await client.async_trigger_service('light', 'turn_on', entity_id="light.living_room")
+        await client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 
 asyncio.run(main())
 ```
@@ -57,11 +54,9 @@ with WebsocketClient(
     '<WS API Server URL>', # i.e. 'ws://homeassistant.local:8123/api/websocket'
     '<Your Long Lived Access-Token>'
 ) as ws_client:
-    light = ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
+    ws_client.trigger_service('light', 'turn_on', entity_id="light.living_room")
 ```
 
-> Note: The Websocket API is not yet supported in async/await mode.
-
 ## Documentation
 
 All documentation, API reference, contribution guidelines and pretty much everything else

homeassistant_api-6.0.0/homeassistant_api/__init__.py

@@ -0,0 +1,127 @@
+"""Interact with your Homeassistant Instance remotely."""
+
+__all__ = (
+    "AsyncClient",
+    "AsyncDomain",
+    "AsyncEntity",
+    "AsyncEvent",
+    "AsyncGroup",
+    "AsyncService",
+    "AsyncWebsocketClient",
+    "AuthInvalid",
+    "AuthOk",
+    "AuthRequired",
+    "BaseDomain",
+    "BaseEntity",
+    "BaseEvent",
+    "BaseGroup",
+    "BaseService",
+    "Client",
+    "ConfigEntry",
+    "ConfigEntryChange",
+    "ConfigEntryDisabler",
+    "ConfigEntryEvent",
+    "ConfigEntryState",
+    "ConfigFlowContext",
+    "ConfigSubEntry",
+    "Context",
+    "DisableEnableResult",
+    "DiscoveryKey",
+    "Domain",
+    "Entity",
+    "EntityCategory",
+    "EntityDisabledBy",
+    "EntityHiddenBy",
+    "EntityRegistryEntry",
+    "EntityRegistryEntryExtended",
+    "EntityRegistryUpdateResult",
+    "ErrorResponse",
+    "Event",
+    "EventResponse",
+    "FlowContext",
+    "FlowResult",
+    "FlowResultType",
+    "Group",
+    "History",
+    "IntegrationTypes",
+    "LogbookEntry",
+    "PingResponse",
+    "ResultResponse",
+    "Service",
+    "ServiceField",
+    "State",
+    "WebsocketClient",
+)
+
+from .asyncclient import AsyncClient
+from .asyncwebsocket import AsyncWebsocketClient
+from .client import Client
+from .models.config_entries import ConfigEntry
+from .models.config_entries import ConfigEntryChange
+from .models.config_entries import ConfigEntryDisabler
+from .models.config_entries import ConfigEntryEvent
+from .models.config_entries import ConfigEntryState
+from .models.config_entries import ConfigFlowContext
+from .models.config_entries import ConfigSubEntry
+from .models.config_entries import DisableEnableResult
+from .models.config_entries import DiscoveryKey
+from .models.config_entries import FlowContext
+from .models.config_entries import FlowResult
+from .models.config_entries import FlowResultType
+from .models.config_entries import IntegrationTypes
+from .models.domains import AsyncDomain
+from .models.domains import AsyncService
+from .models.domains import BaseDomain
+from .models.domains import BaseService
+from .models.domains import Domain
+from .models.domains import Service
+from .models.domains import ServiceField
+from .models.domains import ServiceFieldSelector
+from .models.domains import ServiceFieldSelectorObjectField
+from .models.entity import AsyncEntity
+from .models.entity import AsyncGroup
+from .models.entity import BaseEntity
+from .models.entity import BaseGroup
+from .models.entity import Entity
+from .models.entity import Group
+from .models.entity_registry import EntityCategory
+from .models.entity_registry import EntityDisabledBy
+from .models.entity_registry import EntityHiddenBy
+from .models.entity_registry import EntityRegistryEntry
+from .models.entity_registry import EntityRegistryEntryExtended
+from .models.entity_registry import EntityRegistryUpdateResult
+from .models.events import AsyncEvent
+from .models.events import BaseEvent
+from .models.events import Event
+from .models.history import History
+from .models.logbook import LogbookEntry
+from .models.states import Context
+from .models.states import State
+from .models.websocket import AuthInvalid
+from .models.websocket import AuthOk
+from .models.websocket import AuthRequired
+from .models.websocket import ErrorResponse
+from .models.websocket import EventResponse
+from .models.websocket import PingResponse
+from .models.websocket import ResultResponse
+from .websocket import WebsocketClient
+
+AsyncDomain.model_rebuild()
+AsyncEntity.model_rebuild()
+AsyncEvent.model_rebuild()
+AsyncGroup.model_rebuild()
+AsyncService.model_rebuild()
+BaseDomain.model_rebuild()
+BaseEntity.model_rebuild()
+BaseEvent.model_rebuild()
+BaseGroup.model_rebuild()
+BaseService.model_rebuild()
+Domain.model_rebuild()
+Entity.model_rebuild()
+Event.model_rebuild()
+Group.model_rebuild()
+History.model_rebuild()
+Service.model_rebuild()
+ServiceFieldSelector.model_rebuild()
+ServiceFieldSelectorObjectField.model_rebuild()
+State.model_rebuild()