Skip to main content

ci Documentation Status PyPI version

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 .

Metadata

Release files for com-interface 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for com-interface 0.2.0
File Size Uploaded
com_interface-0.2.0.tar.gz 21.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for com-interface 0.2.0
File Interpreter ABI Platform
com_interface-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 38.3 kB

Release files / com_interface-0.2.0.tar.gz

Download URL com_interface-0.2.0.tar.gz
Size 21.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7b439ec0ce0cdb0588b517e13d204f404a84d6e7542a6a28ceb912a3e97e6194
BLAKE2b-256 checksum
How to use checksums
72d56b86ce56fdc8d70de854889c88c28580e0ba44ccb14d08b940f6c173502f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / com_interface-0.2.0-py3-none-any.whl

Download URL com_interface-0.2.0-py3-none-any.whl
Size 16.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
adca0e9b1f4fbd06c076575c16dba4c5573eb2fd28f7dc5c71a278579920e435
BLAKE2b-256 checksum
How to use checksums
5a7fdcfa8b783671d25c22e9c47da836f6c30508ee01b62ffecdf83b5ef93e68
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page