motorcortex-python 1.0.0rc1__py3-none-any.whl

motorcortex_python-1.0.0rc1.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: motorcortex-python
+Version: 1.0.0rc1
+Summary: Python bindings for Motorcortex Engine
+Home-page: https://www.motorcortex.io
+Author: Alexey Zakharov
+Author-email: alexey.zakharov@vectioneer.com
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pynng<2,>=0.9.0
+Requires-Dist: protobuf>=3.20
+
+# motorcortex-python
+
+[![pipeline status](https://git.vectioneer.com/pub/motorcortex-python/badges/master/pipeline.svg)](https://git.vectioneer.com/pub/motorcortex-python/-/commits/master)
+[![coverage report](https://git.vectioneer.com/pub/motorcortex-python/badges/master/coverage.svg?job=coverage)](https://git.vectioneer.com/pub/motorcortex-python/-/commits/master)
+[![PyPI version](https://img.shields.io/pypi/v/motorcortex-python.svg)](https://pypi.org/project/motorcortex-python/)
+[![Python versions](https://img.shields.io/pypi/pyversions/motorcortex-python.svg)](https://pypi.org/project/motorcortex-python/)
+[![License: MIT](https://img.shields.io/pypi/l/motorcortex-python.svg)](LICENSE)
+
+Python bindings for the [Motorcortex](https://www.motorcortex.io) real-time control engine. Connect to a Motorcortex server, read and write parameters, and stream live telemetry over a single TLS-secured websocket.
+
+## Installation
+
+```bash
+pip install motorcortex-python
+```
+
+Requires Python ≥ 3.10. Runtime dependencies (`pynng`, `protobuf`) are installed automatically.
+
+## Quick start
+
+Recommended — `Session` context manager (close is automatic, even on exceptions):
+
+```python
+import motorcortex
+
+with motorcortex.Session(
+    "wss://192.168.2.100",
+    certificate="mcx.cert.crt",
+    login="admin", password="admin",
+    timeout_ms=1000,
+) as s:
+    # Read a single parameter
+    reply = s.req.getParameter("root/Control/dummyDouble").get()
+    print(reply.value)
+
+    # Write a parameter
+    s.req.setParameter("root/Control/dummyDouble", 3.14).get()
+
+    # Subscribe to a streamed update (every 10th cycle)
+    subscription = s.sub.subscribe(
+        ["root/Control/dummyDouble"], "myGroup", frq_divider=10,
+    )
+    subscription.get()
+    subscription.notify(lambda result: print(result[0].value))
+```
+
+Explicit-objects form — the original API, still supported:
+
+```python
+types = motorcortex.MessageTypes()
+tree = motorcortex.ParameterTree()
+
+req, sub = motorcortex.connect(
+    "wss://192.168.2.100", types, tree,
+    certificate="mcx.cert.crt",
+    login="admin", password="admin",
+)
+try:
+    reply = req.getParameter("root/Control/dummyDouble").get()
+    print(reply.value)
+finally:
+    sub.close()
+    req.close()
+```
+
+The URL grammar accepts IPv4, hostnames, and IPv6 literals both with and without explicit ports — e.g. `wss://host`, `wss://host:5568:5567`, `wss://[::1]`, `wss://[fe80::1]:5568:5567`.
+
+## Documentation
+
+- **[API reference — `docs/_index.md`](docs/_index.md)** — flat, method-by-method reference for every public class and function. Regenerated from the docstrings via `pydoc-markdown`.
+- **[`ARCHITECTURE.md`](ARCHITECTURE.md)** — internals tour: module layout, connection lifecycle, subscribe frame format, parameter-tree cache, threading model, error contract, type conventions.
+- **[`examples/README.md`](examples/README.md)** — runnable scripts (`quickstart.py`, `error_handling.py`) that demonstrate the canonical usage patterns.
+- **[`CHANGELOG.md`](CHANGELOG.md)** — version history.
+
+## Repository layout
+
+```
+motorcortex/            Python package
+test/
+  unit/                 Offline unit tests (no server)
+  integration/          Live tests against the vendored test_server
+  server/               Vendored C++ test_server (CMake project)
+docs/                   pydoc-markdown + stub generation scripts
+benchmark/              Throughput scripts (not part of the test suite)
+sandbox/                Ad-hoc repro scripts
+```
+
+## Testing
+
+Unit tests run offline and require only the package itself:
+
+```bash
+pip install -e .
+pip install "coverage[toml]>=7.4"
+python -m unittest discover -s test/unit -t .
+```
+
+Integration tests spawn the vendored `test_server`. Build it once, then run the suite:
+
+```bash
+cmake -S test/server -B test/server/build -DCMAKE_BUILD_TYPE=Release
+cmake --build test/server/build
+
+python -m unittest discover -s test/integration -t .
+```
+
+Coverage (line + branch). `pyproject.toml` sets `parallel = true`, so each
+`coverage run` writes a per-process data shard; use `coverage combine` to
+merge them before `coverage report`:
+
+```bash
+coverage erase
+coverage run -m unittest discover -s test/unit -t .
+coverage run -m unittest discover -s test/integration -t .
+coverage combine
+coverage report
+```
+
+See [`test/README.md`](test/README.md) for the full testing walkthrough.
+
+## Regenerating the API reference
+
+[`docs/_index.md`](docs/_index.md) is committed and should be refreshed
+before each release so the rendered reference matches the code at
+the tag. The regen is two commands — `pydoc-markdown` first, then
+`format_api.sh` to wrap `>>>` examples as fenced Python blocks and
+prepend the front matter:
+
+```bash
+pip install pydoc-markdown
+cd docs
+pydoc-markdown pydoc-markdown.yml > _index.md
+./format_api.sh
+```
+
+The hook-based one-shot version was dropped — it races with the
+shell redirect and silently loses output. See `docs/readme.md` and
+the comment in `docs/pydoc-markdown.yml` for the full rationale.
+
+## Release process
+
+See [`PIPHOWTO.md`](PIPHOWTO.md) for PyPI release steps and [`CHANGELOG.md`](CHANGELOG.md) for version history.
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).

motorcortex_python-1.0.0rc1.dist-info/RECORD

@@ -0,0 +1,28 @@
+motorcortex/__init__.py,sha256=wzoArp3S1h7iRcfGnRbvteR5x-HuVMwBwy7JGBnrsKQ,11965
+motorcortex/_connection_state.py,sha256=0jos75PAyMsN3ew6HRoRDbLY-lGCzDit-SiUR7ZvnlA,2203
+motorcortex/_request_builders.py,sha256=bMZAP1ko6jju1wXs5p6TCp4D93wbvSgpKRf3gvW9_Bg,5245
+motorcortex/_request_utils.py,sha256=npW68Mr8YJk6jGek3CDIAZoFGFULQwaIRhlnNW0aDeA,12115
+motorcortex/_subscribe_dispatch.py,sha256=mPXSqo44RgGryLZabj5xmBd7riW154kA8fnCEQ3Mjho,2942
+motorcortex/exceptions.py,sha256=9xFscRC2yEO2AxesxJ15p6DimDVRIdOeCdj4gF0gahs,2239
+motorcortex/init_threads.py,sha256=rT0VRhdwQfI0ziTi_jeEaLxTzCtkgVo71gmQIeQyuv8,3343
+motorcortex/message_types.py,sha256=FA9jcrHS8lf_KxMi4qF5-bTDvZoGRoZ4paPS8oCF35k,15643
+motorcortex/motorcortex_hash.json,sha256=727K4JXwdtqzkIPtlq7ROSVOKLEsy1za3D7IjlLqFpA,3572
+motorcortex/motorcortex_pb2.py,sha256=bMRS3TcCJMbBGYqGKnmTiQZaTmpbiJv0iYU3EF8s29Q,12790
+motorcortex/motorcortex_pb2.pyi,sha256=8mxofEtlFESwybu9eeo_i5iMw35eNqsmr2DjHU9pg1k,70451
+motorcortex/nng_url.py,sha256=LXmeu_Z1Hn0_YkF4QqLN2SiEvG2_AvKlsYK1Cox_1RQ,1386
+motorcortex/parameter_tree.py,sha256=i9nyo40okT8Y8WfPF2M9FZmCo59oXWuu3PXxmfexFtU,2696
+motorcortex/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+motorcortex/reply.py,sha256=GMTaDQ_jeu32H5Zl4LA2Smw_PzNuho2cLuzY-1vvJQ0,3889
+motorcortex/request.py,sha256=r16i1CZOl8qVvSrVNqMocdsOQCjiKw21XfKtN6PqMc0,26253
+motorcortex/session.py,sha256=d5V3q5S5cATJ4Dm9W-lZo388o98ccX48B1fAjgQZ-5U,7038
+motorcortex/setup_logger.py,sha256=ynWC2xMPC5lw_ubU1AL7lbuxm4VK2xqkLRNisAv_fZM,195
+motorcortex/state_callback_handler.py,sha256=Vr9XZ5vN7-CKJdvbJlFkenwH6JfhuInkM1RQvRnlhPY,3069
+motorcortex/subscribe.py,sha256=A0lFkkFTqEh8vSdGvr1JBq25gjo-xh4Ai_kcoW4aPIA,15715
+motorcortex/subscription.py,sha256=n_7OKE_u-Sz0T49S54RuYXlJ2uzXPFzxeXIGg91lfLM,15406
+motorcortex/timespec.py,sha256=bZ-CD2EY0ALoWmJyluThxkiqfVCiGZqPPHRlKSvq7Fs,4573
+motorcortex/version.py,sha256=Zf80zUin_WQ77tGbDMBKvURmGcFKDgnESRwu7q6VXQk,25
+motorcortex_python-1.0.0rc1.dist-info/LICENSE,sha256=m5IaPTxipQwDCpY_YUD927y5QnUzqKGLVUY8E2KxDMk,1165
+motorcortex_python-1.0.0rc1.dist-info/METADATA,sha256=0ZhiD0dkeKZjWLEnncxOk2PRfLDx9t8Lbp8gbJabrW4,6144
+motorcortex_python-1.0.0rc1.dist-info/WHEEL,sha256=hPN0AlP2dZM_3ZJZWP4WooepkmU9wzjGgCLCeFjkHLA,92
+motorcortex_python-1.0.0rc1.dist-info/top_level.txt,sha256=2Glsldo3S13fGB0ub_vogd7y-RQYYNXDjnm-qESmjBY,12
+motorcortex_python-1.0.0rc1.dist-info/RECORD,,

motorcortex_python-1.0.0rc1.dist-info/WHEEL

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

motorcortex_python-1.0.0rc1.dist-info/top_level.txt

@@ -0,0 +1 @@
+motorcortex