The python API for Eclipse Zenoh Flow
Project description
Python Zenoh Flow API
Zenoh Flow provides a Zenoh-based dataflow programming framework for computations that span from the cloud to the device.
:warning: This software is still in alpha status and should not be used in production. Breaking changes are likely to happen and the API is not stable.
Requirements
- Rust: see the installation page
- a matching version of libpython. On linux systems, it's typically packaged separately as ``libpython3.x-dev
or
python3.x-dev`. - Python >= 3.7
- pip >= 22
- virtualenv
How to build
Create and activate a python virtual environment:
$ python3 -m virtualenv venv
$ source venv/bin/activate
Build the Python Wheel within a Python virtual environment.
$ python3 -m venv venv
$ source venv/bin/activate
(venv) $ git clone https://github.com/atolab/zenoh-flow-python
(venv) $ cd zenoh-flow-python/zenoh-flow-python
(venv) $ pip3 install -r requirements-dev.txt
(venv) $ maturin build --release
Deactivate the venv and install the python bindings.
(venv) deactivate
$ pip3 install ./target/wheels/<there should only be one .whl file here>
Build the wrappers
Build the Python wrappers.
:warning: Python Wrappers SHOULD NOT be built within a Python virtual environment
$ cargo build --release -p py-op -p py-sink -p py-source
Build the docs
Once you have installed the Python binding you can also generate the documentation.
$ cd docs
$ pip3 install sphinx_rtd_theme sphinx -y
$ make html
The docs will be available under _build/html/index.html
.
Run an example
Clone, build and install Zenoh Flow, and then use the provided py-pipeline.yml
example to run it.
:bulb: Note that you actually only need to update the paths in py-pipeline.yml
file.
$ zfctl launch py-pipeline.yml
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2baa2ccebdaa57c50392f5f270f0fcd71397234415d1f8d9ad0e7b6eb6a99c78 |
|
MD5 | f4530a1354c61eb90e767f20943f45f9 |
|
BLAKE2b-256 | 70bebdc30926611dc7fba29858033081d918c476b6c84963d7e46ed3c0d62b65 |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a995997eaed602129b16996c8e3d09464c8af9fbb5f9d9d00d078d2d4aaefcc6 |
|
MD5 | 8bd819309aaddb149c364e553782a6fb |
|
BLAKE2b-256 | 9bd670b33f8943740a06205aebe01df75120fc02bb0c9214b76b1809888e5986 |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8a6abc4c740e72f476f5ad3c029aa97247e672d31802fce90a730c488e155c5 |
|
MD5 | dfe1f54a0fc05915e37af85b1e09ce8f |
|
BLAKE2b-256 | 21b5202007cae2eaa5baaa93d32a1552f2b202ac0b60ebe011cd2ab506552034 |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 103716ad24735665c0aaf3f9cafe475cea2280c64d505a74391692cbff14cbb8 |
|
MD5 | e0858bf21cb974c5bbbe61a7c2591367 |
|
BLAKE2b-256 | a2da73852be11eb9c91095308c5ddaaa078b3c278bde56ea0209ba768bd0b23d |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-manylinux_2_12_i686.manylinux2010_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f743781e532432492c8369d975b957cfbc719be32ceed3f433ca56e4b6566dd |
|
MD5 | 9c45c53657ed9a7885b000709d63339e |
|
BLAKE2b-256 | 0022983a2535983dfc3ff2bec88f920a20352d2067aac9a1527d092d5416cdd5 |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67106accb09d8bd6cc4b62bda84d016f01ad755edcf60a80e3841091564746b9 |
|
MD5 | da9baa35fb95f777bcbd0c691bdffd35 |
|
BLAKE2b-256 | a79dd17d269af696a57ddc0ee17ef1298db7ed92c88d33d922a12336a4121acb |
Hashes for eclipse_zenoh_flow-0.4.0_alpha.2-cp37-abi3-macosx_10_7_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 39dce5445b7f47e95d39af7f0f9a7a169c022c0a49c58a23a51f3f30de80007e |
|
MD5 | e52efc0c233060490911aaf32a0ada51 |
|
BLAKE2b-256 | 60743be2648db6f8809473b5070f0b8d9a01203e179634abcb821f6a8e70bb11 |