Merge pull request #9 from graphras-com/refactor/rename-to-haclient-src-layout

refactor: rename ha_client to haclient with src/ layout

Author: Faerkeren

.github/workflows/ci.yml

@@ -67,7 +67,7 @@ jobs:
     with:
       python-versions: ${{ vars.CI_PYTHON_TEST_VERSIONS || '["3.11","3.12"]' }}
       install-spec: ${{ vars.CI_PYTHON_INSTALL_SPEC || '.[dev]' }}
-      coverage-target: ${{ vars.CI_PYTHON_COVERAGE_TARGET || 'ha_client' }}
+      coverage-target: ${{ vars.CI_PYTHON_COVERAGE_TARGET || 'haclient' }}
       coverage-threshold: ${{ fromJSON(vars.CI_PYTHON_COVERAGE_THRESHOLD || '95') }}
 
   # ── Security ──────────────────────────────────────────────────────

AGENTS.md

@@ -27,11 +27,11 @@ Every change MUST include **all** of the following:
 
 - [ ] **Tests** — new or updated tests covering the change with **≥ 95% coverage** for affected modules. Verify with:
   ```bash
-  pytest --cov=ha_client --cov-report=term-missing --cov-fail-under=95
+  pytest --cov=haclient --cov-report=term-missing --cov-fail-under=95
   ```
 - [ ] **Documentation** — update relevant files in `docs/` to reflect the change (new features get a new or updated doc page).
 - [ ] **README.md** — update the project README if the change affects public API, installation, usage examples, or feature list.
-- [ ] **Lint & type-check pass** — `ruff check .` and `mypy ha_client/` must be clean.
+- [ ] **Lint & type-check pass** — `ruff check .` and `mypy src/haclient/` must be clean.
 
 ## Setup
 
@@ -49,10 +49,10 @@ Python 3.11+ required (`.python-version` pins 3.11).
 ruff check .
 
 # Type-check (strict mode)
-mypy ha_client/
+mypy src/haclient/
 
 # Tests with coverage (target ≥95%)
-pytest --cov=ha_client --cov-report=term-missing --cov-fail-under=95
+pytest --cov=haclient --cov-report=term-missing --cov-fail-under=95
 
 # Single test file
 pytest tests/test_client.py
@@ -61,17 +61,17 @@ pytest tests/test_client.py
 pytest tests/test_client.py::test_name -x
 ```
 
-Run order: `ruff check .` → `mypy ha_client/` → `pytest`
+Run order: `ruff check .` → `mypy src/haclient/` → `pytest`
 
 ## Architecture
 
-- `ha_client/client.py` — `HAClient`, the main async facade (REST + WebSocket)
-- `ha_client/websocket.py` — low-level WS with auth, keepalive, auto-reconnect
-- `ha_client/rest.py` — REST API client
-- `ha_client/registry.py` — entity registry (state tracking)
-- `ha_client/entity.py` — base `Entity` with state-change dispatch
-- `ha_client/sync.py` — `SyncHAClient`, blocking wrapper running event loop in background thread
-- `ha_client/domains/` — domain entity classes (`MediaPlayer`, `Light`, `Switch`, `Climate`, `Cover`, `Sensor`, `BinarySensor`)
+- `src/haclient/client.py` — `HAClient`, the main async facade (REST + WebSocket)
+- `src/haclient/websocket.py` — low-level WS with auth, keepalive, auto-reconnect
+- `src/haclient/rest.py` — REST API client
+- `src/haclient/registry.py` — entity registry (state tracking)
+- `src/haclient/entity.py` — base `Entity` with state-change dispatch
+- `src/haclient/sync.py` — `SyncHAClient`, blocking wrapper running event loop in background thread
+- `src/haclient/domains/` — domain entity classes (`MediaPlayer`, `Light`, `Switch`, `Climate`, `Cover`, `Sensor`, `BinarySensor`)
 
 ## Testing
 
@@ -83,5 +83,5 @@ Run order: `ruff check .` → `mypy ha_client/` → `pytest`
 
 - Ruff line length: 100
 - Ruff rules: E, W, F, I (isort), B (bugbear, B008 ignored), UP, C4, SIM
-- mypy strict mode on `ha_client/`; tests are exempt from `disallow_untyped_defs`
+- mypy strict mode on `src/haclient/`; tests are exempt from `disallow_untyped_defs`
 - Build backend: hatchling

README.md

@@ -1,4 +1,4 @@
-# ha-client
+# HaClient
 
 An async-first, high-level Python client for [Home Assistant](https://www.home-assistant.io/).
 It talks to a Home Assistant instance over both the WebSocket API (for live
@@ -31,7 +31,7 @@ async with HAClient("http://homeassistant.local:8123", token=TOKEN) as ha:
 ## Installation
 
 ```bash
-pip install ha-client
+pip install haclient
 ```
 
 From source (with dev extras):
@@ -44,7 +44,7 @@ uv pip install -e ".[dev]"
 
 ```python
 import asyncio
-from ha_client import HAClient
+from haclient import HAClient
 
 
 async def main() -> None:
@@ -171,7 +171,7 @@ recursively descends into expandable nodes and returns a flat list of
 ### Synchronous wrapper
 
 ```python
-from ha_client import SyncHAClient
+from haclient import SyncHAClient
 
 with SyncHAClient("http://homeassistant.local:8123", token=TOKEN) as ha:
     player = ha.media_player("livingroom")
@@ -203,7 +203,7 @@ re-established transparently.
 ## Project layout
 
 ```
-ha_client/
+src/haclient/
   __init__.py
   client.py          # HAClient (high-level facade)
   websocket.py       # WebSocketClient (low-level WS + reconnect)
@@ -233,16 +233,16 @@ source .venv/bin/activate
 uv pip install -e ".[dev]"
 
 # Run the full test suite with coverage (target: ≥ 90 %).
-pytest --cov=ha_client --cov-report=term-missing
+pytest --cov=haclient --cov-report=term-missing
 
 # Lint and type-check.
 ruff check .
-mypy ha_client/
+mypy src/haclient/
 ```
 
 ## Acknowledgements
 
-ha-client is built on top of excellent open-source software. See
+HaClient is built on top of excellent open-source software. See
 [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for the full list of
 third-party dependencies and their licenses.
 

THIRD_PARTY_NOTICES.md

@@ -1,6 +1,6 @@
 # Third-Party Notices
 
-ha-client uses the following third-party libraries. Each is listed with its
+HaClient uses the following third-party libraries. Each is listed with its
 license type and project URL.
 
 ## Runtime Dependencies

docs/README.md

@@ -1,6 +1,6 @@
 # HAClient Documentation
 
-API reference for `ha_client` — an async-first Python client for Home Assistant.
+API reference for `haclient` — an async-first Python client for Home Assistant.
 
 ## Core Library
 

docs/base.md

@@ -1,6 +1,6 @@
 # Base Library
 
-## `ha_client.client.HAClient`
+## `haclient.client.HAClient`
 
 High-level orchestrator combining REST and WebSocket clients.
 
@@ -61,7 +61,7 @@ async with HAClient(url, token) as client:
 
 ---
 
-## `ha_client.sync.SyncHAClient`
+## `haclient.sync.SyncHAClient`
 
 Blocking wrapper around `HAClient`. Runs a dedicated event loop in a background thread.
 
@@ -89,7 +89,7 @@ with SyncHAClient(url, token) as client:
 
 ---
 
-## `ha_client.rest.RestClient`
+## `haclient.rest.RestClient`
 
 HTTP REST API client.
 
@@ -118,7 +118,7 @@ RestClient(
 
 ---
 
-## `ha_client.websocket.WebSocketClient`
+## `haclient.websocket.WebSocketClient`
 
 WebSocket API client with auto-reconnect.
 
@@ -163,7 +163,7 @@ EventHandler = Callable[[dict[str, Any]], Awaitable[None] | None]
 
 ---
 
-## `ha_client.entity.Entity`
+## `haclient.entity.Entity`
 
 Base class for all domain entities.
 
@@ -215,7 +215,7 @@ ValueChangeHandler = Callable[[Any, Any], Any]
 
 ---
 
-## `ha_client.registry.EntityRegistry`
+## `haclient.registry.EntityRegistry`
 
 Entity store with lookup and domain filtering.
 
@@ -235,7 +235,7 @@ Supports `__contains__`, `__iter__`, `__len__`.
 
 ---
 
-## `ha_client.exceptions`
+## `haclient.exceptions`
 
 | Exception | Base | Description |
 |---|---|---|

docs/binary_sensor.md

@@ -1,8 +1,8 @@
 # Binary Sensor
 
-`ha_client.domains.binary_sensor.BinarySensor` — domain: `"binary_sensor"`
+`haclient.domains.binary_sensor.BinarySensor` — domain: `"binary_sensor"`
 
-Inherits from [`Entity`](base.md#ha_cliententityentity). Read-only.
+Inherits from [`Entity`](base.md#hacliententityentity). Read-only.
 
 ## Properties
 

docs/climate.md

@@ -1,8 +1,8 @@
 # Climate
 
-`ha_client.domains.climate.Climate` — domain: `"climate"`
+`haclient.domains.climate.Climate` — domain: `"climate"`
 
-Inherits from [`Entity`](base.md#ha_cliententityentity).
+Inherits from [`Entity`](base.md#hacliententityentity).
 
 ## Properties
 

docs/cover.md

@@ -1,8 +1,8 @@
 # Cover
 
-`ha_client.domains.cover.Cover` — domain: `"cover"`
+`haclient.domains.cover.Cover` — domain: `"cover"`
 
-Inherits from [`Entity`](base.md#ha_cliententityentity).
+Inherits from [`Entity`](base.md#hacliententityentity).
 
 ## Properties
 

docs/light.md

@@ -1,8 +1,8 @@
 # Light
 
-`ha_client.domains.light.Light` — domain: `"light"`
+`haclient.domains.light.Light` — domain: `"light"`
 
-Inherits from [`Entity`](base.md#ha_cliententityentity).
+Inherits from [`Entity`](base.md#hacliententityentity).
 
 ## Properties