com-interface 0.1.0

Generic communication interface abstraction for sending arbitrary byte packets

com-interface - Generic communication abstraction to send arbitrary byte packets

This library contains a generic communication abstraction specifically targeted towards the exchange of binary data like CCSDS packets.

The documentation contains more information.

Install

You can install this package from PyPI

Linux:

python3 -m pip install com-interface

Windows:

py -m pip install com-interface

Examples

You can find all examples inside the documentation.

Tests

If you want to run the tests, it is recommended to install pytest and coverage (optional) first:

pip install coverage pytest

Running tests regularly:

pytest .

Running tests with coverage:

coverage run -m pytest

Documentation

The documentation is built with Sphinx and new documentation should be written using the NumPy format.

Install the required dependencies first:

pip install -r docs/requirements.txt

Then the documentation can be built with

cd docs
make html

You can run the doctests with

make doctest

Formatting and Linting

Linting:

ruff check .

Formatting:

ruff format .