From 516022eaf655023ac38d2b6fc4fd99660be2c277 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Fri, 28 Mar 2025 12:56:11 +0100 Subject: [PATCH 1/2] document how to enable compilation feature in README --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8d92b6bf..0a9c8b9c 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This repository provides a Python binding based on the main [Zenoh implementatio ## How to install it The Eclipse zenoh-python library is available on [Pypi.org](https://pypi.org/project/eclipse-zenoh/). -Install the latest available version using `pip`: +Install the latest available version using `pip` in a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/): ```bash pip install eclipse-zenoh @@ -46,6 +46,13 @@ zenoh-python has been tested with Python 3.8, 3.9, 3.10, 3.11 and 3.12 It relies on the [zenoh](https://github.com/eclipse-zenoh/zenoh/tree/main/zenoh) Rust API which require the full `std` library. See the list in [Rust Platform Support](https://doc.rust-lang.org/nightly/rustc/platform-support.html). +### Enable zenoh features + +To enable some compilation features of the Rust library that are disabled by default, for example `shared-memory`, execute the following command: +```bash +pip install eclipse-zenoh --no-binary :all: --config-settings build-args="--features=zenoh/shared-memory" +``` + ------------------------------- ## How to build it From 2a9ab4cc2160f8839f1aab2024834fe4c1c563a7 Mon Sep 17 00:00:00 2001 From: Joseph Perez Date: Fri, 28 Mar 2025 13:00:20 +0100 Subject: [PATCH 2/2] fix lint --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0a9c8b9c..baa26a9b 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ It relies on the [zenoh](https://github.com/eclipse-zenoh/zenoh/tree/main/zenoh) ### Enable zenoh features To enable some compilation features of the Rust library that are disabled by default, for example `shared-memory`, execute the following command: + ```bash pip install eclipse-zenoh --no-binary :all: --config-settings build-args="--features=zenoh/shared-memory" ```