Fluvio client uses pdoc to generate the client API documentation.
pip install fluvio
This will get the wheel for the os/architecture of the installation system if available, otherwise it will try to build from source. If building from source, you will need the rust compiler and maybe some operating system sources.
from fluvio import Fluvio
fluvio = Fluvio.connect()
producer = fluvio.topic_producer('my-topic')
producer.send_string("FOOBAR")
producer.flush()
from fluvio import (Fluvio, Offset)
fluvio = Fluvio.connect()
consumer = fluvio.partition_consumer('my-topic', 0)
stream = consumer.stream(Offset.beginning())
for i in stream:
print(i.value_string())
This project uses PyO3 to wrap the fluvio crate.
setuptools-rust bundles it into a python package. For cross platform builds, cibuildwheel is used.
Running the tests locally require having already setup a fluvio locally or on fluvio cloud.
Add python unit tests in the tests
directory using the built in python
unittest
framework
You should probably stick to using make integration-tests
which will create the virtual
environment and install the
package in the site-packages in the venv directory. This makes sure that the
package is also packaged correctly.
If you'd like more rapid testing, once you've got the virtual environment
activated, python setup.py test
will compile the rust as a static library and
put it as fluvio/fluvio_python.cpython-39-x86_64-linux-gnu.so
. This filename
is dependent on the host OS and python version.
FLUVIO_CLOUD_TEST_PASSWORD` to your fork's secrets.
When submitting a PR, CI checks a few things: