burst-link-protocol 0.1.1__cp312-abi3-win32.whl

burst_interface_c.pyi

@@ -0,0 +1,8 @@
+
+
+class BurstInterfaceC:
+    def __init__(self) -> None: ...
+
+    def decode(self, data: bytes, fail_on_crc_error: bool = False) -> list: ...
+
+    def encode(self, packets: list) -> bytes: ...

burst_link_protocol/__init__.py

@@ -0,0 +1,4 @@
+from burst_interface_c import  BurstInterfaceC
+from .main import BurstInterfacePy
+
+__all__ = ["BurstInterfaceC", "BurstInterfacePy"]

burst_link_protocol/main.py

@@ -0,0 +1,41 @@
+from cobs import cobs
+from crc import Calculator,Crc16
+
+crc = Calculator(Crc16.IBM_3740)
+
+class BurstInterfacePy:
+    buffer = b""
+
+    def __init__(self):
+        pass
+
+    @staticmethod
+    def crc16( data: bytes) -> bytes:
+        return crc.checksum(data).to_bytes(2, "big")
+    
+
+    @staticmethod
+    def encode_packet(packet: bytes) -> bytes:
+        packet_with_crc = packet + BurstInterfacePy.crc16(packet)
+        return cobs.encode(packet_with_crc) + b"\x00"
+
+    @staticmethod
+    def decode_packet(packet: bytes) -> bytes:
+        # decode and check crc
+        decoded = cobs.decode(packet)
+
+        if BurstInterfacePy.crc16(decoded[:-2]) != decoded[-2:]:
+            raise ValueError("CRC mismatch")
+
+        return decoded[:-2]
+
+    def encode(self, packets: list[bytes]) -> bytes:
+        return b"".join([self.encode_packet(packet) for packet in packets])
+
+    def decode(self, steam: bytes) -> list[bytes]:
+        self.buffer += steam
+        separated_packets = self.buffer.split(b"\x00")
+        # Add last packet to buffer
+        self.buffer = separated_packets.pop()
+        return [self.decode_packet(packet) for packet in separated_packets]
+

burst_link_protocol-0.1.1.dist-info/METADATA

@@ -0,0 +1,89 @@
+Metadata-Version: 2.1
+Name: burst-link-protocol
+Version: 0.1.1
+Summary: Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream.
+Author-Email: Floris vernieuwe <floris@vernieuwe.eu>
+Requires-Python: <4.0,>=3.10
+Requires-Dist: cobs<2.0.0,>=1.2.1
+Requires-Dist: numpy<3.0.0,>=2.2.3
+Requires-Dist: crc<8.0.0,>=7.1.0
+Requires-Dist: pytest<9.0.0,>=8.3.4
+Requires-Dist: pytest-cov<7.0.0,>=6.0.0
+Requires-Dist: pytest-benchmark<6.0.0,>=5.1.0
+Requires-Dist: scikit-build-core[pyproject]<0.11.0,>=0.10.7; extra == "dev"
+Requires-Dist: nanobind<3.0.0,>=2.5.0; extra == "dev"
+Requires-Dist: pytest<9.0.0,>=8.3.4; extra == "dev"
+Requires-Dist: pytest-cov<7.0.0,>=6.0.0; extra == "dev"
+Requires-Dist: pytest-benchmark<6.0.0,>=5.1.0; extra == "dev"
+Provides-Extra: dev
+Description-Content-Type: text/markdown
+
+# BURST interface 
+Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams, a packet format.
+It combines a 16 bit checksum and cobs encoding to convert packets into a format that can be sent over a stream.
+
+This projects is written so it can be used both in python, c and c++ based project
+
+# Installation instuctions
+
+## As an user
+
+Simple installation
+```sh
+pip install -e .
+```
+
+## As a developer
+
+Fast build
+```sh
+pip install --no-build-isolation -ve .
+```
+
+Auto rebuild on run
+```sh
+pip install --no-build-isolation -Ceditable.rebuild=true -ve .
+```
+
+
+### Python Stub files generation
+
+They are generated automatically buy can also be generated 
+
+```
+python -m nanobind.stubgen -m nanobind_example_ext
+```
+
+# Publishing instructions
+
+```
+
+```
+
+# Test
+
+```sh
+pytest
+```
+
+# BURST protocol
+TODO
+* STAGE 1
+    * Convert cpp to c files [OK]
+    * Formalise naming [OK]
+    * Add c encode functions [OK]
+    * Test c encode functions [OK]
+    * Update README 
+    * Improve poetry.toml   [OK]
+
+
+* STAGE 2
+    * Add CI/CD on github to compile x86
+       * Fix dependencies once compilation succeeds
+    * Publish on pypi
+* STAGE 3
+    * Add a way to get C test coverage
+
+
+
+

burst_link_protocol-0.1.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+burst_interface_c.pyd,sha256=XyoL6XO019bPpu62mS01OTE2cfGnBsd__Q_CHPzo-no,351232
+burst_interface_c.pyi,sha256=XeNtZqvqT2bwCE7Le_DeKOiGPn83dw5WSZteHMzLo0A,201
+burst_link_protocol/__init__.py,sha256=KISkm1e-VcDx29uyFp-4M76cox3LBfcPCOrrv9gv1QM,135
+burst_link_protocol/main.py,sha256=Eicgf3yp8DxnI5SspCKD7jm5C4tNZWKKBoYdCfGrUis,1211
+burst_link_protocol-0.1.1.dist-info/METADATA,sha256=2R1FyQ8xU5QFI6PDIHE9yu-JV-kkl8TaMf_4RMf7xpE,2106
+burst_link_protocol-0.1.1.dist-info/WHEEL,sha256=PSf5v5Sqi9g580_jBIo7BVvLhbCJLtxUm2z36OA4YZQ,101
+burst_link_protocol-0.1.1.dist-info/RECORD,,

burst_link_protocol-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: scikit-build-core 0.10.7
+Root-Is-Purelib: false
+Tag: cp312-abi3-win32
+