Add up_rust_py package with documentation and examples by sachinkum0009 · Pull Request #1 · eclipse-uprotocol/up-rust-py

sachinkum0009 · 2026-02-18T22:45:22Z

Introduce the up_rust_py package, providing Python bindings for uProtocol. Include necessary modules, documentation, and example scripts for usage. This addition enhances the project's functionality and usability.

sophokles73

I have provided a few hints and proposals for improvement. My Python knowledge is very limited so I the review of the python code might not be as thorough as you would expect.

I do like the clear structuring and that you already thought about including proper documentation 👍

In general, the Eclipse license header is missing in all files. You may want to take a look a the up-rust repository for the format of the header and where to add it.

README.md

sophokles73 · 2026-02-26T08:11:23Z

pyproject.toml

+requires-python = ">=3.8"
+description = "Python bindings for Eclipse uProtocol Rust implementation"
+readme = "README.md"
+license = { text = "Apache-2.0" }


From what I see at https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license-and-license-files this should probably be

license = "Apache-2.0"

or am I mistaken?

Thanks, you're right. I will fix it.

sophokles73 · 2026-02-26T08:12:50Z

pyproject.toml

+description = "Python bindings for Eclipse uProtocol Rust implementation"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+authors = [


I guess it would also be good to include

license-files = "LICENSE"

to refer to the license file in the root folder?

sophokles73 · 2026-02-26T08:16:16Z

pyproject.toml

+mqtt = []   # MQTT transport (future)
+someip = [] # SOME/IP automotive protocol (future)


IMHO we should omit these until there actually is support for them ...

sophokles73 · 2026-02-26T08:17:43Z

pyproject.toml

+discovery = []     # Service discovery (udiscovery feature)
+subscription = []  # Advanced subscription management (usubscription feature)
+twin = []          # Digital twin support (utwin feature)
+cloudevents = []   # CloudEvents format support


same here, FMPOV it is totally ok to only start with what is really supported. Once you add more bindings, e.g. for the uSubscription service interface, you can add a corresponding feature extension ..

sophokles73 · 2026-02-26T08:26:07Z

docs/installation.md

+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/sachinkum0009/up-rust-py.git


I guess this should become https://github.com/eclipse-uprotocol/up-rust-py.git, right?

sophokles73 · 2026-02-26T08:26:56Z

docs/installation.md

+- Python 3.8 or higher
+- pip (Python package installer)
+
+## Install from PyPI


IMHO we should add a section recommending to use a virtual environment?

sophokles73 · 2026-02-26T08:28:24Z

docs/usage.md

+
+Here's a simple example that demonstrates publishing and receiving messages:
+
+```python


instead of pasting the code in here (where we will have a hard time keeping it in sync with the code base), we should probably simply refer to a file in the examples folder?

sophokles73 · 2026-02-26T08:30:31Z

up_rust_py/__init__.pyi

+    entity ID, and version to create unique identifiers.
+    """
+
+    def __init__(self, authority: str, entity_id: int, version: int) -> None:


what happens if I provide a version value that is out of range?

I found out that the PyO3 automatically converts Python types to Rust Types with validation.

If the value is out of range, it will return a OverflowError.

sophokles73 · 2026-02-26T08:32:04Z

up_rust_py/local_transport.pyi

+                        Will be called when messages arrive.
+
+        Raises:
+            Exception: If registration fails.


I am not too familiar with error handling in Python but Exception looks very generic to me. Isn't there a concept for having more specific errors being reported?

sachinkum0009 · 2026-03-04T19:10:07Z

… quickstart

…nippets

sachinkum0009 added 3 commits February 18, 2026 23:44

up_rust_py package added

8f83319

github repo links updated

9e4e0cc

minor changes

0680ccf

sophokles73 reviewed Feb 26, 2026

View reviewed changes

sachinkum0009 added 11 commits March 4, 2026 20:20

update repository links to point to the Eclipse uProtocol organization

f96f1a2

fix: update license format in pyproject.toml

19653da

fix: add license-files entry in pyproject.toml

a515a6f

removed 3.8 and 3.9 support to use pytest 9.0.2

5c7d072

description updated regarding what it is and use for

ee6eb36

removed the features of which bindings are not created yet

3ee928e

clean readme to include the example files instead of example code for…

b6b1a3d

… quickstart

mkdocs plugin updated to generated api docs from code

7c4c7f2

commented the features until implemented

e91fb25

update usage guide to simplify examples and remove unnecessary code s…

5af044e

…nippets

clean the code

c002aa8

		mqtt = [] # MQTT transport (future)
		someip = [] # SOME/IP automotive protocol (future)


		Here's a simple example that demonstrates publishing and receiving messages:

		```python

Conversation

sachinkum0009 commented Feb 18, 2026

Uh oh!

sophokles73 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sachinkum0009 commented Mar 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

To Do

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sachinkum0009 commented Mar 4, 2026 •

edited

Loading