pypz-io-sniffer 0.10.0

A small tool that is capable to sniff and visualize the control messages between Operators.

Description

This package contains the experimental implementation of the IO Sniffer. The Sniffer allows you to visualize the control plane of the IO ports of the operators, so you can have a better understanding, what happens during the execution of your pipeline.

Check the documentation for more details.

Install

The python artifact is hosted on https://pypi.org/, so you can install it via pip:

pip install pypz-io-sniffer

If you want to work on it locally, then you should install in editable mode:

pip install -e ./sniffer

Test

Before you run the tests, you need to install the subproject in editable mode. To run the tests locally, you need to execute the following command:

python -m unittest discover .\sniffer\test\ -p "*.py"

Build

Before you build, you will need to install the "build" package:

pip install build

Optionally, you might want to set a version for local testing. Using setuptools-scm, you can pretend a version via setting the following environment variable:

# Powershell
$env:SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYPZ_IO_SNIFFER="v1.2.3"

# Linux
export SETUPTOOLS_SCM_PRETEND_VERSION_FOR_PYPZ_IO_SNIFFER="v1.2.3"

Then from the subproject's root, you will need to execute the following command:

python -m build

It will create the source distribution and the wheel file in the "dist" folder.