matter-python-client 0.4.1__py3-none-any.whl

matter_python_client-0.4.1.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.4
+Name: matter-python-client
+Version: 0.4.1
+Summary: Python Client for the OHF Matter Server
+Author-email: Open Home Foundation <hello@openhomefoundation.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/matter-js/matterjs-server
+Project-URL: Source, https://github.com/matter-js/matterjs-server/tree/main/python_client
+Project-URL: Bug Tracker, https://github.com/matter-js/matterjs-server/issues
+Project-URL: Changelog, https://github.com/matter-js/matterjs-server/blob/main/CHANGELOG.md
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Home Automation
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: aiohttp
+Requires-Dist: orjson
+Requires-Dist: home-assistant-chip-clusters==2025.7.0
+Provides-Extra: test
+Requires-Dist: pytest>=9.0; extra == "test"
+Requires-Dist: pytest-asyncio>=0.24; extra == "test"
+Requires-Dist: pytest-aiohttp>=1.0; extra == "test"
+
+# Python Client for the OHF Matter Server
+
+A PyPI package (`matter-python-client`) providing Python bindings for the [OHF Matter Server](https://github.com/matter-js/matterjs-server). This is a drop-in replacement for the client portion of [`python-matter-server`](https://github.com/matter-js/python-matter-server), with custom cluster definitions updated to match the Matter.js server.
+
+## Origin
+
+The client and common modules were copied from [`python-matter-server` v8.1.2](https://github.com/matter-js/python-matter-server) and modified:
+
+- **Source**: `matter_server/client/` and `matter_server/common/` from python-matter-server
+- **Modified**: `matter_server/common/custom_clusters.py` — updated to match the JS server's cluster definitions
+- **Excluded**: `matter_server/server/` (the JS server replaces it), `common/helpers/logger.py` (depends on `coloredlogs`, a server-only dependency)
+
+### Custom Cluster Changes
+
+| Cluster | Change |
+|---------|--------|
+| EveCluster | +8 attributes (getConfig, setConfig, loggingMetadata, loggingData, lastEventTime, statusFault, childLock, rloc16), wattAccumulatedControlPoint type fixed |
+| HeimanCluster | Attribute IDs shortened to match JS server |
+| NeoCluster | Types changed from float32 to uint |
+| Polling | Removed (JS server handles polling natively) |
+
+## Package
+
+- **PyPI name**: `matter-python-client`
+- **Python module**: `matter_server` (same import path as `python-matter-server`)
+- **Python**: >= 3.12
+- **Dependencies**: `aiohttp`, `orjson`, `home-assistant-chip-clusters`
+
+## npm Scripts (from monorepo root)
+
+```bash
+# First-time setup: create venv and install with test dependencies
+npm run python:install
+
+# Run unit + mock server tests (fast, ~1s)
+npm run python:test
+
+# Run full integration tests against real Matter.js server + test device (~40s)
+npm run python:test-integration
+
+# Run all Python tests
+npm run python:test-all
+
+# Build the PyPI package (.tar.gz + .whl)
+npm run python:build
+```
+
+## Usage
+
+The package provides the same `matter_server.client` API as `python-matter-server`:
+
+```python
+import aiohttp
+from matter_server.client import MatterClient
+
+async with aiohttp.ClientSession() as session:
+    client = MatterClient("ws://localhost:5580/ws", session)
+    await client.connect()
+
+    init_ready = asyncio.Event()
+    listen_task = asyncio.create_task(client.start_listening(init_ready))
+    await init_ready.wait()
+
+    nodes = client.get_nodes()
+```
+
+To use this package instead of `python-matter-server` in the Home Assistant Matter integration, change `manifest.json`:
+
+```diff
+- "requirements": ["python-matter-server==8.1.2"],
++ "requirements": ["matter-python-client==1.0.0"],
+```
+
+## Testing
+
+The test suite has three layers:
+
+- **Import smoke tests** (8 tests) — verify all HA integration imports resolve
+- **Mock server tests** (4 tests) — Python client against JS MockMatterServer subprocess
+- **Integration tests** (63 tests) — Python client against real Matter.js server + test device, mirroring the JS `IntegrationTest.ts`

matter_python_client-0.4.1.dist-info/RECORD

@@ -0,0 +1,22 @@
+matter_server/__init__.py,sha256=lJ6xyVLSMGtiHvq36VPSDb75ksxfNKYmKEEE-ZwJdhQ,47
+matter_server/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+matter_server/client/__init__.py,sha256=pZzjJp-7C5BmYGZJjIo5SpyjGLU0FcqBa2nJ558y-Is,97
+matter_server/client/client.py,sha256=6zcVKB0UkxFl3mYeK66GN6gBVq8tciIDQkLZB2piYwk,30438
+matter_server/client/connection.py,sha256=ye7jbDHpHuBXfJPnBiO8tsQN0A4SiyOh98V4H-2D8cc,6180
+matter_server/client/exceptions.py,sha256=741JkGMBQFJYZ70zX80B-Dn_NtgHffb6jDHC83tCL2U,1901
+matter_server/client/models/__init__.py,sha256=pT16UC2evZVw2trjun2xJZpaOR55ky7i_8znlA3Mreo,63
+matter_server/client/models/device_types.py,sha256=vwsCU0OJuAnOycqWGbn-l6eBY4yOsiS3B9FDgFrzlgk,23341
+matter_server/client/models/node.py,sha256=MF4YwWWG7bGIJeh9COBTYc9PoqHbHkFPP1hFS6D7KqU,15420
+matter_server/common/__init__.py,sha256=y4EeCH05sUYifS2b624oweA6omnY5k-rLNHHv4t4p7Q,50
+matter_server/common/const.py,sha256=hTu0siAgpQvAz6oYavTGuqgkXaQH2glQxUQuGyPnn1o,256
+matter_server/common/custom_clusters.py,sha256=wT8xYa1zSKeGBTI15j9mG_ch8w-e7ktGECzmhdJdPgE,48276
+matter_server/common/errors.py,sha256=ryZQXg3cS8g0aBt-6r1y0q4LO7D-gl-GZFRlv0IIuNo,2154
+matter_server/common/models.py,sha256=nuhvQoE0T5Qj6kgqtbSDoOvnH-_Uv4tFqIK0UPJchbU,7689
+matter_server/common/helpers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+matter_server/common/helpers/api.py,sha256=ePJjzR0KhdWrXtfiXJGOZbq__DUVcv1zR5xC9no9w-o,2039
+matter_server/common/helpers/json.py,sha256=6JZb9gS6z9oMHB9gUQ0DrMYF_wdyC6QpyW4jHm7lE3w,1306
+matter_server/common/helpers/util.py,sha256=QQ4-rvJNi6mJN4WVSnQSjiigFy8DEyZtAuZOWYpv1yc,12883
+matter_python_client-0.4.1.dist-info/METADATA,sha256=yQh_89kQo3vFtcjVp7pm7NWDCPAMT7VBys7DnjdXOI4,4152
+matter_python_client-0.4.1.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+matter_python_client-0.4.1.dist-info/top_level.txt,sha256=RnN_dXPV-BJticdofUc0tEiC3yaXXPKKCIy5ApS7nn8,14
+matter_python_client-0.4.1.dist-info/RECORD,,

matter_python_client-0.4.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

matter_python_client-0.4.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+matter_server

matter_server/__init__.py

@@ -0,0 +1 @@
+"""Python Client for the OHF Matter Server."""

matter_server/client/__init__.py

@@ -0,0 +1,5 @@
+"""Client for the MatterServer."""
+
+from .client import MatterClient
+
+__all__ = ["MatterClient"]