simpleiot 0.1.0__tar.gz

simpleiot-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+.venv/
+__pycache__/
+dist/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/

simpleiot-0.1.0/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to the `simpleiot` Python package are documented here. The
+format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+## [Unreleased]
+
+## [0.1.0]
+
+- **First release.** Connect with the shared token, read and write nodes and
+  points, create, move, and delete nodes, and subscribe to point changes.
+- **Set up nodes from a YAML file with `provision()`.** It uploads the file for
+  the server to apply, as `siot import` does, and waits until it has, raising
+  the server's error if it fails.
+- **Autonomous rover example.** A simulated rover reports its position, speed,
+  and battery to a dashboard with a live map and takes commands from it. It sets
+  up its own nodes with `provision()`. See `examples/rover`.

simpleiot-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

simpleiot-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.5
+Name: simpleiot
+Version: 0.1.0
+Summary: Python client for Simple IoT, over NATS
+Project-URL: Homepage, https://simpleiot.org
+Project-URL: Documentation, https://docs.simpleiot.org/python/
+Project-URL: Repository, https://github.com/simpleiot/simpleiot
+Project-URL: Changelog, https://github.com/simpleiot/simpleiot/blob/master/python/CHANGELOG.md
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: iot,nats,simpleiot
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.10
+Requires-Dist: nats-py>=2.6
+Description-Content-Type: text/markdown
+
+# simpleiot
+
+A Python client for [Simple IoT](https://simpleiot.org). Read and write nodes
+and points, and watch for changes, over the NATS API.
+
+The client connects with the instance's shared token (`SIOT_AUTH_TOKEN`), which
+reaches the whole tree. It suits scripts and services running alongside an
+instance you operate.
+
+![a Python process on an edge device talks to the local SIOT over NATS; the local SIOT syncs with the cloud, and people use the web UI on either instance](https://docs.simpleiot.org/python/images/deployment.svg)
+
+A typical setup runs the Python process next to SIOT on an edge device. What it
+writes reaches the cloud through sync, and a person sees it in the web UI on
+site or remotely.
+
+## Install
+
+```
+pip install simpleiot
+```
+
+Requires Python 3.10 or newer. The client is built on
+[nats-py](https://github.com/nats-io/nats.py) and uses `asyncio`.
+
+## Usage
+
+```python
+import asyncio
+import simpleiot
+from simpleiot import Point
+
+
+async def main():
+    async with await simpleiot.connect() as c:
+        root = await c.get_root()
+        print("root:", root.description)
+
+        id = await c.create_node(root.id, "variable", description="tank level")
+        await c.send_point(id, "value", 42.5)
+
+        async with await c.subscribe_node(id) as sub:
+            async for m in sub:
+                for p in m.points:
+                    print(p.type, p.value)
+
+
+asyncio.run(main())
+```
+
+`connect()` reads `SIOT_NATS_SERVER` (default `nats://localhost:4222`) and
+`SIOT_AUTH_TOKEN` from the environment, or takes them as arguments:
+
+```python
+c = await simpleiot.connect("nats://10.0.0.5:4222", token="...")
+```
+
+## Nodes and points
+
+Data in Simple IoT is a tree of **nodes**, each holding **points**. A point has
+a `type`, a `key` (`"0"` unless a node holds several of a type), a `value`, and
+a `time`. The edge from a node to its parent carries its own points, such as
+`tombstone` for a deleted node. See the
+[data reference](https://docs.simpleiot.org/docs/ref/data.html).
+
+`Point.value` sets the encoding when sending:
+
+| Value                  | Sent as               |
+| ---------------------- | --------------------- |
+| `float`, `int`, `bool` | a float point         |
+| `str`                  | a string point        |
+| `dict`, `list`         | a JSON point          |
+| `None`                 | a point with no value |
+
+Pass `data_type=DataType.INT` to send an integer as an int point. A received
+point's `value` is a `float`, `int`, or `str` by its data type; `number` and
+`text` read it as a number or string either way.
+
+## API
+
+All methods are coroutines on `Client`.
+
+- `get_root()`, `get_node(id, parent="all")`, `get_children(parent, type=...)`
+- `get_nodes(parent, id="all", type=..., include_deleted=..., depth=...)`, the
+  `nodes.<parent>.<id>` request
+- `search(below, query, limit=..., type=...)`
+- `send_points(id, points)`, `send_point(id, type, value, key="0")`
+- `send_edge_points(id, parent, points)`
+- `create_node(parent, type, points, id=..., description=..., primary=...)`
+- `delete_node(id, parent)`, `move_node(id, old_parent, new_parent)`
+- `provision(name, yaml)` uploads a node file for the server to apply, as
+  `siot import` would, and waits until it has
+- `subscribe_node(id)`, `subscribe_tree(id)`, `subscribe(subject)`: async
+  iterators of `PointsMessage`
+- `close()`
+
+A server error raises `SiotError`; a missing node raises `NotFoundError`.
+
+## Examples
+
+Each example is a short script in its own directory with a README:
+
+- [tree](https://github.com/simpleiot/simpleiot/tree/master/python/examples/tree)
+  prints the node tree
+- [send_points](https://github.com/simpleiot/simpleiot/tree/master/python/examples/send_points)
+  creates a node and writes a value to it once a second
+- [watch](https://github.com/simpleiot/simpleiot/tree/master/python/examples/watch)
+  prints every point change below a node
+- [mirror_temperature](https://github.com/simpleiot/simpleiot/tree/master/python/examples/mirror_temperature)
+  reacts to one point by writing another
+- [rover](https://github.com/simpleiot/simpleiot/tree/master/python/examples/rover)
+  drives a simulated autonomous rover from a dashboard, with a live map, status,
+  and commands
+
+Run them against a local instance:
+
+```
+SIOT_AUTH_TOKEN=... python examples/tree/tree.py
+```
+
+## Development
+
+The client lives in the
+[Simple IoT repository](https://github.com/simpleiot/simpleiot) under `python/`,
+so it changes together with the server.
+
+```
+cd python
+uv sync
+uv run pytest
+```
+
+The tests need [uv](https://docs.astral.sh/uv/). The codec tests check the
+encoder against the fixtures `data/point_fixture_test.go` writes, the same ones
+the JavaScript client is checked against. The integration tests start a scratch
+`siot` when `SIOT_BIN` names one; `siot_test_python` in `envsetup.sh` builds it
+and runs them.
+
+To publish a release, set the version in `python/src/simpleiot/__init__.py`, add
+a `python/CHANGELOG.md` entry, and push a `py-v<version>` tag. The
+`Python release` workflow builds the package and publishes it to PyPI.

simpleiot-0.1.0/README.md

@@ -0,0 +1,140 @@
+# simpleiot
+
+A Python client for [Simple IoT](https://simpleiot.org). Read and write nodes
+and points, and watch for changes, over the NATS API.
+
+The client connects with the instance's shared token (`SIOT_AUTH_TOKEN`), which
+reaches the whole tree. It suits scripts and services running alongside an
+instance you operate.
+
+![a Python process on an edge device talks to the local SIOT over NATS; the local SIOT syncs with the cloud, and people use the web UI on either instance](https://docs.simpleiot.org/python/images/deployment.svg)
+
+A typical setup runs the Python process next to SIOT on an edge device. What it
+writes reaches the cloud through sync, and a person sees it in the web UI on
+site or remotely.
+
+## Install
+
+```
+pip install simpleiot
+```
+
+Requires Python 3.10 or newer. The client is built on
+[nats-py](https://github.com/nats-io/nats.py) and uses `asyncio`.
+
+## Usage
+
+```python
+import asyncio
+import simpleiot
+from simpleiot import Point
+
+
+async def main():
+    async with await simpleiot.connect() as c:
+        root = await c.get_root()
+        print("root:", root.description)
+
+        id = await c.create_node(root.id, "variable", description="tank level")
+        await c.send_point(id, "value", 42.5)
+
+        async with await c.subscribe_node(id) as sub:
+            async for m in sub:
+                for p in m.points:
+                    print(p.type, p.value)
+
+
+asyncio.run(main())
+```
+
+`connect()` reads `SIOT_NATS_SERVER` (default `nats://localhost:4222`) and
+`SIOT_AUTH_TOKEN` from the environment, or takes them as arguments:
+
+```python
+c = await simpleiot.connect("nats://10.0.0.5:4222", token="...")
+```
+
+## Nodes and points
+
+Data in Simple IoT is a tree of **nodes**, each holding **points**. A point has
+a `type`, a `key` (`"0"` unless a node holds several of a type), a `value`, and
+a `time`. The edge from a node to its parent carries its own points, such as
+`tombstone` for a deleted node. See the
+[data reference](https://docs.simpleiot.org/docs/ref/data.html).
+
+`Point.value` sets the encoding when sending:
+
+| Value                  | Sent as               |
+| ---------------------- | --------------------- |
+| `float`, `int`, `bool` | a float point         |
+| `str`                  | a string point        |
+| `dict`, `list`         | a JSON point          |
+| `None`                 | a point with no value |
+
+Pass `data_type=DataType.INT` to send an integer as an int point. A received
+point's `value` is a `float`, `int`, or `str` by its data type; `number` and
+`text` read it as a number or string either way.
+
+## API
+
+All methods are coroutines on `Client`.
+
+- `get_root()`, `get_node(id, parent="all")`, `get_children(parent, type=...)`
+- `get_nodes(parent, id="all", type=..., include_deleted=..., depth=...)`, the
+  `nodes.<parent>.<id>` request
+- `search(below, query, limit=..., type=...)`
+- `send_points(id, points)`, `send_point(id, type, value, key="0")`
+- `send_edge_points(id, parent, points)`
+- `create_node(parent, type, points, id=..., description=..., primary=...)`
+- `delete_node(id, parent)`, `move_node(id, old_parent, new_parent)`
+- `provision(name, yaml)` uploads a node file for the server to apply, as
+  `siot import` would, and waits until it has
+- `subscribe_node(id)`, `subscribe_tree(id)`, `subscribe(subject)`: async
+  iterators of `PointsMessage`
+- `close()`
+
+A server error raises `SiotError`; a missing node raises `NotFoundError`.
+
+## Examples
+
+Each example is a short script in its own directory with a README:
+
+- [tree](https://github.com/simpleiot/simpleiot/tree/master/python/examples/tree)
+  prints the node tree
+- [send_points](https://github.com/simpleiot/simpleiot/tree/master/python/examples/send_points)
+  creates a node and writes a value to it once a second
+- [watch](https://github.com/simpleiot/simpleiot/tree/master/python/examples/watch)
+  prints every point change below a node
+- [mirror_temperature](https://github.com/simpleiot/simpleiot/tree/master/python/examples/mirror_temperature)
+  reacts to one point by writing another
+- [rover](https://github.com/simpleiot/simpleiot/tree/master/python/examples/rover)
+  drives a simulated autonomous rover from a dashboard, with a live map, status,
+  and commands
+
+Run them against a local instance:
+
+```
+SIOT_AUTH_TOKEN=... python examples/tree/tree.py
+```
+
+## Development
+
+The client lives in the
+[Simple IoT repository](https://github.com/simpleiot/simpleiot) under `python/`,
+so it changes together with the server.
+
+```
+cd python
+uv sync
+uv run pytest
+```
+
+The tests need [uv](https://docs.astral.sh/uv/). The codec tests check the
+encoder against the fixtures `data/point_fixture_test.go` writes, the same ones
+the JavaScript client is checked against. The integration tests start a scratch
+`siot` when `SIOT_BIN` names one; `siot_test_python` in `envsetup.sh` builds it
+and runs them.
+
+To publish a release, set the version in `python/src/simpleiot/__init__.py`, add
+a `python/CHANGELOG.md` entry, and push a `py-v<version>` tag. The
+`Python release` workflow builds the package and publishes it to PyPI.

simpleiot-0.1.0/examples/mirror_temperature/README.md

@@ -0,0 +1,21 @@
+# React to a point
+
+Watches the `value` point of one node, converts it from Celsius to Fahrenheit,
+and writes the result to a new node beside it. This is the shape of a small
+control script: subscribe to one point, compute, and write another. Stop it with
+Ctrl-C.
+
+```
+SIOT_AUTH_TOKEN=... python examples/mirror_temperature/mirror_temperature.py <node-id>
+```
+
+```
+writing Fahrenheit to 2wer551eezqp8a683j3bbg7kn8
+20.45 °C -> 68.81 °F
+20.94 °C -> 69.69 °F
+```
+
+Pass the ID of the node [send_points](../send_points/) writes to, or of any node
+with a `value` point. The script reads the source with `get_node()`, creates the
+target under the same parent with `create_node()`, and writes to it from a
+`subscribe_node()` loop.

simpleiot-0.1.0/examples/mirror_temperature/mirror_temperature.py

@@ -0,0 +1,38 @@
+"""Watches a node's value and writes it to another node in Fahrenheit.
+
+This is the shape of a small control script: subscribe to one point, compute,
+and write another.
+
+    SIOT_AUTH_TOKEN=... python examples/mirror_temperature/mirror_temperature.py <node-id>
+"""
+
+import asyncio
+import sys
+
+import simpleiot
+
+
+async def main(source: str):
+    async with await simpleiot.connect() as c:
+        src = await c.get_node(source)
+        target = await c.create_node(
+            src.parent, "variable", description=f"{src.description or source} (°F)"
+        )
+        print("writing Fahrenheit to", target)
+
+        async with await c.subscribe_node(source) as sub:
+            async for m in sub:
+                for p in m.points:
+                    if p.type == "value":
+                        f = p.number * 9 / 5 + 32
+                        await c.send_point(target, "value", round(f, 2))
+                        print(f"{p.number} °C -> {f:.2f} °F")
+
+
+if len(sys.argv) != 2:
+    sys.exit(__doc__)
+
+try:
+    asyncio.run(main(sys.argv[1]))
+except KeyboardInterrupt:
+    pass