sifi-bridge-py 2.0.0b4

Python bindings for the SiFi Bridge tool.

SiFi Bridge Python

SiFi Bridge Python is a convenient wrapper over SiFi Bridge CLI.

The Python wrapper opens the CLI tool in a subprocess. Thus, it is highly recommended to implement threading, since reading from standard input is a blocking operation. To use the wrapper, start by instantiating a SifiBridge object. Documentation is provided as inline doc-strings. It is recommended to then deliver the samples with some sort of higher-level server-client scheme.

Documentation

Inline documentation is provided.

Examples

Examples are available in the examples/ directory of this project.

Tests

Tests are located under tests/. They can be ran with: python -m unittest -v from the root of the project's directory.

Installing

pip install sifi_bridge_py should work for most use cases.

Versioning

The wrapper is updated for every SiFi Bridge version. Major and minor versions will always be kept in sync, while the patch version will vary for project-specific bug fixes.

Local development

pip install path/to/sifi-bridge-py/

Deployment

NOTE If you add new enums or types to sifi-bridge-py, don't forget to re-export them in src/__init__.py.

First, run the tests: python -m unittest -v. Then, to deploy to PyPI, push a tag to the main branch. The tag must respect semantic versioning format: x.y.z, or for beta versions x.y.z-bn, where n is the beta number.