pycyphal2 2.0.0.dev0__tar.gz

pycyphal2-2.0.0.dev0/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Pavel Kirienko and OpenCyphal team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

pycyphal2-2.0.0.dev0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: pycyphal2
+Version: 2.0.0.dev0
+Summary: Pure-Python implementation of Cyphal -- a simple and robust real-time publish/subscribe stack that runs anywhere.
+Author-email: Pavel Kirienko and OpenCyphal team <pavel@opencyphal.org>
+License: MIT
+Project-URL: Homepage, https://opencyphal.org
+Project-URL: Repository, https://github.com/OpenCyphal/pycyphal
+Keywords: cyphal,opencyphal,uavcan,pub-sub,publish-subscribe,data-bus,ethernet,can-bus,vehicular,onboard-networking,avionics,communication-protocol,broker
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Object Brokering
+Classifier: Topic :: System :: Distributed Computing
+Classifier: Topic :: System :: Networking
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: udp
+Requires-Dist: ifaddr~=0.2.0; extra == "udp"
+Provides-Extra: pythoncan
+Requires-Dist: python-can~=4.0; extra == "pythoncan"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="https://opencyphal.org/favicon-192.png" width="60px">
+
+<h1>Cyphal in Python</h1>
+
+_pub/sub without steroids_
+
+[![Website](https://img.shields.io/badge/website-opencyphal.org-black?color=1700b3)](https://opencyphal.org/)
+[![Forum](https://img.shields.io/discourse/https/forum.opencyphal.org/users.svg?logo=discourse&color=1700b3)](https://forum.opencyphal.org)
+[![Docs](https://img.shields.io/badge/Docs-rtfm-black?color=ff00aa&logo=readthedocs)](https://opencyphal.github.io/pycyphal)
+
+</div>
+
+-----
+
+Python implementation of the [Cyphal](https://opencyphal.org) stack that runs on GNU/Linux, Windows, and macOS.
+
+Install as follows.
+Optional features inside the brackets can be removed if not needed; see `pyproject.toml` for the full list:
+
+```
+pip install pycyphal2[udp,pythoncan]
+```
+
+📚 **Read the docs** at <https://opencyphal.github.io/pycyphal>.
+
+💡 **Runnable examples** at `examples/`.

pycyphal2-2.0.0.dev0/README.md

@@ -0,0 +1,28 @@
+<div align="center">
+
+<img src="https://opencyphal.org/favicon-192.png" width="60px">
+
+<h1>Cyphal in Python</h1>
+
+_pub/sub without steroids_
+
+[![Website](https://img.shields.io/badge/website-opencyphal.org-black?color=1700b3)](https://opencyphal.org/)
+[![Forum](https://img.shields.io/discourse/https/forum.opencyphal.org/users.svg?logo=discourse&color=1700b3)](https://forum.opencyphal.org)
+[![Docs](https://img.shields.io/badge/Docs-rtfm-black?color=ff00aa&logo=readthedocs)](https://opencyphal.github.io/pycyphal)
+
+</div>
+
+-----
+
+Python implementation of the [Cyphal](https://opencyphal.org) stack that runs on GNU/Linux, Windows, and macOS.
+
+Install as follows.
+Optional features inside the brackets can be removed if not needed; see `pyproject.toml` for the full list:
+
+```
+pip install pycyphal2[udp,pythoncan]
+```
+
+📚 **Read the docs** at <https://opencyphal.github.io/pycyphal>.
+
+💡 **Runnable examples** at `examples/`.

pycyphal2-2.0.0.dev0/pyproject.toml

@@ -0,0 +1,120 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pycyphal2"
+dynamic = ["version"]
+requires-python = ">=3.11"
+dependencies = []  # The core must be dependency-free by design. Transports may add dependencies.
+authors = [
+    { name = "Pavel Kirienko and OpenCyphal team", email = "pavel@opencyphal.org" },
+]
+description = "Pure-Python implementation of Cyphal -- a simple and robust real-time publish/subscribe stack that runs anywhere."
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { text = "MIT" }
+keywords = [
+    "cyphal",
+    "opencyphal",
+    "uavcan",
+    "pub-sub",
+    "publish-subscribe",
+    "data-bus",
+    "ethernet",
+    "can-bus",
+    "vehicular",
+    "onboard-networking",
+    "avionics",
+    "communication-protocol",
+    "broker",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Embedded Systems",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Object Brokering",
+    "Topic :: System :: Distributed Computing",
+    "Topic :: System :: Networking",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+[project.urls]
+Homepage = "https://opencyphal.org"
+Repository = "https://github.com/OpenCyphal/pycyphal"
+
+[tool.setuptools.dynamic]
+version = { attr = "pycyphal2.__version__" }
+
+[project.optional-dependencies]
+udp = ["ifaddr~=0.2.0"]
+pythoncan = ["python-can~=4.0"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+pycyphal2 = ["py.typed"]
+
+[tool.mypy]
+strict = true
+mypy_path = "src"
+warn_unused_ignores = false
+implicit_reexport = false
+
+[[tool.mypy.overrides]]
+module = ["tests.*"]
+disallow_untyped_defs = false
+check_untyped_defs = true
+
+[tool.coverage.run]
+branch = true
+source_pkgs = ["pycyphal2"]
+
+[tool.coverage.report]
+show_missing = true
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.",
+    "if TYPE_CHECKING:",
+    "raise NotImplementedError",
+    "@(abc\\.)?abstractmethod",
+]
+
+[tool.coverage.html]
+directory = "htmlcov"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+preview = true
+
+[tool.ruff.lint]
+# Only the checks the project needs right now; others disabled to avoid false positives.
+select = [
+    "F401",    # unused imports
+    "F811",    # redefinition of unused name
+    "F841",    # local variable assigned but never used
+    "ARG001",  # unused function argument
+    "ARG002",  # unused method argument
+    "ARG005",  # unused lambda argument
+    "PLR6301", # method could be a function or static method
+    "SLF001",  # private member accessed from outside its class/module
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Tests may access internals for white-box testing; allow SLF001 there.
+"tests/*" = ["SLF001", "ARG", "PLR6301"]
+
+[tool.black]
+line-length = 120
+target-version = ['py312']
+include = '''
+((src|tests|examples)/.*\.pyi?$)
+'''

pycyphal2-2.0.0.dev0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pycyphal2-2.0.0.dev0/src/pycyphal2/__init__.py

@@ -0,0 +1,89 @@
+"""
+`Cyphal <https://opencyphal.org>`_ in Python —
+decentralized real-time pub/sub with tunable reliability, service discovery, and zero configuration.
+Works anywhere, `even baremetal MCUs <https://github.com/OpenCyphal-Garage/cy>`_.
+
+Supports various transports such as Ethernet (UDP) and CAN FD with optional redundancy.
+Set up a transport, make a node, publish and subscribe:
+
+```python
+from pycyphal2 import Node, Instant
+from pycyphal2.udp import UDPTransport
+
+async def main():
+    node = Node.new(UDPTransport.new(), "my_node")
+
+    pub = node.advertise("sensor/temperature")
+    await pub(Instant.now() + 1.0, b"21.5")
+
+    sub = node.subscribe("sensor/temperature")
+    async for arrival in sub:
+        print(arrival.message)
+```
+
+All public symbols live at the top level — just `import pycyphal2`.
+Transport modules (`pycyphal2.udp`, `pycyphal2.can`) are imported separately
+so that only the needed dependencies are pulled in.
+
+The source repository contains a collection of runnable examples.
+
+Environment variables control name remapping similar to ROS:
+
+- `CYPHAL_NAMESPACE` — default namespace prepended to relative topic names.
+- `CYPHAL_REMAP` — topic name remappings (`from=to` pairs, whitespace-separated).
+
+Publication is best-effort by default. Pass ``reliable=True`` when publishing to retry delivery until
+acknowledged by every known subscriber or until the deadline; if the remote side does not acknowledge in time,
+:class:`DeliveryError` is raised.
+
+```python
+await pub(Instant.now() + 1.0, b"payload", reliable=True)
+```
+
+Subscriptions normally yield messages as soon as they arrive. Set ``reordering_window`` [seconds] on
+:meth:`Node.subscribe` to allow delaying out-of-order messages to reconstruct the original publication order.
+This is useful for sensor feeds and state estimators.
+
+```python
+sub = node.subscribe("sensor/temperature", reordering_window=0.1)
+```
+
+RPC is layered directly on top of pub/sub. Use :meth:`Publisher.request` to publish a message that expects
+responses, and use :attr:`Arrival.breadcrumb` on the subscriber side to send a unicast reply back to the requester.
+One request may yield responses from multiple subscribers.
+
+```python
+stream = await pub.request(Instant.now() + 1.0, 0.5, b"read")
+async for response in stream:
+    print(response.message)
+```
+
+Streaming is just repeated replying on the same breadcrumb. The requester consumes such replies through
+:class:`ResponseStream`; each responder numbers its own responses from zero upward.
+
+```python
+await arrival.breadcrumb(Instant.now() + 1.0, b"chunk-1", reliable=True)
+await arrival.breadcrumb(Instant.now() + 1.0, b"chunk-2", reliable=True)
+```
+
+Cyphal does not define a serialization format. Previous versions used to define the DSDL format but it has been
+extracted into an independent project, and Cyphal was made serialization-agnostic in v1.1+.
+"""
+
+from __future__ import annotations
+
+from ._api import *
+from ._transport import Transport as Transport
+from ._transport import TransportArrival as TransportArrival
+from ._transport import SubjectWriter as SubjectWriter
+
+__version__ = "2.0.0.dev0"
+
+# pdoc needs __all__ to display re-exported members.
+__all__ = [
+    _k
+    for _k, _v in vars().items()
+    if not _k.startswith("_")
+    and _k not in {"annotations", "TYPE_CHECKING"}
+    and (getattr(_v, "__module__", None) or "").startswith(__name__)
+]