burst-link-protocol 1.0.0__cp312-abi3-musllinux_1_2_i686.whl → 1.0.2__cp312-abi3-musllinux_1_2_i686.whl

{burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.2.dist-info}/METADATA

@@ -1,8 +1,9 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: burst-link-protocol
-Version: 1.0.0
+Version: 1.0.2
 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>
+License-File: LICENSE
 Project-URL: Repository, https://github.com/Florioo/burst-link-protocol
 Requires-Python: <4.0,>=3.10
 Requires-Dist: cobs<2.0.0,>=1.2.1
@@ -11,30 +12,44 @@ 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
+Provides-Extra: dev
 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.
+# BURST link protocol 
+Binary Utility for Reliable Stream Transfer (BURST) is a cross-platform library that provides a robust link layer protocol for transmitting binary data over streams (e.g. UART). It ensures data integrity by applying a 16-bit checksum and utilizes COBS (Consistent Overhead Byte Stuffing) encoding to format packets efficiently.
+
+
+## Features
+* Multi-language Support: Seamless integration with Python, C, and C++ projects.
+* Reliable Transmission: 16-bit checksum ensures error detection.
+* Efficient Encoding: Uses COBS encoding to convert data into a stream-friendly format.
+
+## Design
+The following diagram illustrates the data flow within the BURST protocol:
 
-This projects is written so it can be used both in python, c and c++ based project
+![design](docs/design.svg "design")
 
-# Installation instuctions
+# Installation
 
-## As an user
+## Prebuilt Wheels
 
-Simple installation
+Prebuilt wheels are available for Windows, Linux and MacOS, they can be installed using pip:
 ```sh
-pip install -e .
+pip install burst-link-protocol
 ```
 
-## As a developer
+## From Source
+Note: You need a valid C++ compiler and Python 3.7+ installed on your system.
+
+Basic installation
+```sh
+pip install -e .
+```
 
 Fast build
 ```sh
@@ -55,36 +70,10 @@ They are generated automatically buy can also be generated
 python -m nanobind.stubgen -m nanobind_example_ext
 ```
 
-# Publishing instructions
-
-```
-
-```
-
-# Test
+### Test
 
 ```sh
-pytest
+pytest test
 ```
 
-# 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-1.0.2.dist-info/RECORD

@@ -0,0 +1,8 @@
+burst_interface_c.abi3.so,sha256=4UviRuGVCnaDlJaGH1c_56mtEA6B8zHuHk4zcr6qjyA,2564436
+burst_interface_c.pyi,sha256=x_agiw2iVgDi2qJOOwEpWXVsV14K6GtJgcMqOBqjASQ,193
+burst_link_protocol/main.py,sha256=Pu67bwI7Szk1Y_AdrFVRTBCvl0o45uhFJTd8b0KQl_E,1170
+burst_link_protocol/__init__.py,sha256=cyEhIzfFlNOtubh_JjZg6bGSGn_sPq8daTi4cYBKnxc,132
+burst_link_protocol-1.0.2.dist-info/WHEEL,sha256=Er0vA2Y60NhrF6MDXiDuEAw0l-fX7Wa1UHShS-ydbP4,114
+burst_link_protocol-1.0.2.dist-info/RECORD,,
+burst_link_protocol-1.0.2.dist-info/METADATA,sha256=Pv-4urUGPWE0Wrju9Y3iYZ34Lfqc11BgGnTg-saiDms,2355
+burst_link_protocol-1.0.2.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725

{burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.2.dist-info}/WHEEL

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

burst_link_protocol-1.0.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-burst_interface_c.abi3.so,sha256=wfT-Vt_5XStoWK-kBqXqYPEb-zPrnL5RsPu_t7ITNBg,2564436
-burst_interface_c.pyi,sha256=x_agiw2iVgDi2qJOOwEpWXVsV14K6GtJgcMqOBqjASQ,193
-burst_link_protocol/__init__.py,sha256=cyEhIzfFlNOtubh_JjZg6bGSGn_sPq8daTi4cYBKnxc,132
-burst_link_protocol/main.py,sha256=Pu67bwI7Szk1Y_AdrFVRTBCvl0o45uhFJTd8b0KQl_E,1170
-burst_link_protocol-1.0.0.dist-info/WHEEL,sha256=4MIf4s0n1kvbqx0cJHkyWZ-1jktvjlQncoHZq8W7_wk,114
-burst_link_protocol-1.0.0.dist-info/METADATA,sha256=yP1FK2zuzGkH-WUjhksOpLnivdA3f818CeTkk6UlomI,2178
-burst_link_protocol-1.0.0.dist-info/RECORD,,
-burst_link_protocol-1.0.0.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725