burst-link-protocol 1.0.0__cp312-abi3-macosx_10_14_x86_64.whl → 1.0.1__cp312-abi3-macosx_10_14_x86_64.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. burst_interface_c.abi3.so +0 -0
  2. {burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.1.dist-info}/METADATA +26 -38
  3. burst_link_protocol-1.0.1.dist-info/RECORD +8 -0
  4. burst_link_protocol-1.0.0.dist-info/RECORD +0 -8
  5. {burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.1.dist-info}/WHEEL +0 -0
  6. {burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.1.dist-info}/licenses/LICENSE +0 -0
burst_interface_c.abi3.so CHANGED
Binary file
{burst_link_protocol-1.0.0.dist-info → burst_link_protocol-1.0.1.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: burst-link-protocol
3
- Version: 1.0.0
3
+ Version: 1.0.1
4
4
  Summary: Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream.
5
5
  Author-Email: Floris vernieuwe <floris@vernieuwe.eu>
6
6
  Project-URL: Repository, https://github.com/Florioo/burst-link-protocol
@@ -19,22 +19,36 @@ Requires-Dist: pytest-benchmark<6.0.0,>=5.1.0; extra == "dev"
19
19
  Provides-Extra: dev
20
20
  Description-Content-Type: text/markdown
21
21
 
22
- # BURST interface
23
- Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams, a packet format.
24
- It combines a 16 bit checksum and cobs encoding to convert packets into a format that can be sent over a stream.
22
+ # BURST link protocol
23
+ 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.
25
24
 
26
- This projects is written so it can be used both in python, c and c++ based project
27
25
 
28
- # Installation instuctions
26
+ ## Features
27
+ * Multi-language Support: Seamless integration with Python, C, and C++ projects.
28
+ * Reliable Transmission: 16-bit checksum ensures error detection.
29
+ * Efficient Encoding: Uses COBS encoding to convert data into a stream-friendly format.
29
30
 
30
- ## As an user
31
+ ## Design
32
+ The following diagram illustrates the data flow within the BURST protocol:
31
33
 
32
- Simple installation
34
+ ![design](docs/design.svg "design")
35
+
36
+ # Installation
37
+
38
+ ## Prebuilt Wheels
39
+
40
+ Prebuilt wheels are available for Windows, Linux and MacOS, they can be installed using pip:
33
41
  ```sh
34
- pip install -e .
42
+ pip install burst-link-protocol
35
43
  ```
36
44
 
37
- ## As a developer
45
+ ## From Source
46
+ Note: You need a valid C++ compiler and Python 3.7+ installed on your system.
47
+
48
+ Basic installation
49
+ ```sh
50
+ pip install -e .
51
+ ```
38
52
 
39
53
  Fast build
40
54
  ```sh
@@ -55,36 +69,10 @@ They are generated automatically buy can also be generated
55
69
  python -m nanobind.stubgen -m nanobind_example_ext
56
70
  ```
57
71
 
58
- # Publishing instructions
59
-
60
- ```
61
-
62
- ```
63
-
64
- # Test
72
+ ### Test
65
73
 
66
74
  ```sh
67
- pytest
75
+ pytest test
68
76
  ```
69
77
 
70
- # BURST protocol
71
- TODO
72
- * STAGE 1
73
- * Convert cpp to c files [OK]
74
- * Formalise naming [OK]
75
- * Add c encode functions [OK]
76
- * Test c encode functions [OK]
77
- * Update README
78
- * Improve poetry.toml [OK]
79
-
80
-
81
- * STAGE 2
82
- * Add CI/CD on github to compile x86
83
- * Fix dependencies once compilation succeeds
84
- * Publish on pypi
85
- * STAGE 3
86
- * Add a way to get C test coverage
87
-
88
-
89
-
90
78
 
burst_link_protocol-1.0.1.dist-info/RECORD ADDED
@@ -0,0 +1,8 @@
1
+ burst_interface_c.abi3.so,sha256=svslZeCqW68LWZvJOY3OpOENJEVThjC2m4N-Xb2qmEE,771200
2
+ burst_interface_c.pyi,sha256=x_agiw2iVgDi2qJOOwEpWXVsV14K6GtJgcMqOBqjASQ,193
3
+ burst_link_protocol/__init__.py,sha256=cyEhIzfFlNOtubh_JjZg6bGSGn_sPq8daTi4cYBKnxc,132
4
+ burst_link_protocol/main.py,sha256=Pu67bwI7Szk1Y_AdrFVRTBCvl0o45uhFJTd8b0KQl_E,1170
5
+ burst_link_protocol-1.0.1.dist-info/RECORD,,
6
+ burst_link_protocol-1.0.1.dist-info/WHEEL,sha256=t9SjSYdxExXtT9EBcFuZ_BY73rfpAkRyal9AWq_BA3I,115
7
+ burst_link_protocol-1.0.1.dist-info/METADATA,sha256=AWEzJHTFME_H6P0tjKzVe3KmILNfZ67BBFOmp9Af9sA,2333
8
+ burst_link_protocol-1.0.1.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725
burst_link_protocol-1.0.0.dist-info/RECORD DELETED
@@ -1,8 +0,0 @@
1
- burst_interface_c.abi3.so,sha256=Jpf2nTHCqgU27XHg8dxYmk4AFhX2GZUg-0wsMlhhL_w,771200
2
- burst_interface_c.pyi,sha256=x_agiw2iVgDi2qJOOwEpWXVsV14K6GtJgcMqOBqjASQ,193
3
- burst_link_protocol/__init__.py,sha256=cyEhIzfFlNOtubh_JjZg6bGSGn_sPq8daTi4cYBKnxc,132
4
- burst_link_protocol/main.py,sha256=Pu67bwI7Szk1Y_AdrFVRTBCvl0o45uhFJTd8b0KQl_E,1170
5
- burst_link_protocol-1.0.0.dist-info/RECORD,,
6
- burst_link_protocol-1.0.0.dist-info/WHEEL,sha256=t9SjSYdxExXtT9EBcFuZ_BY73rfpAkRyal9AWq_BA3I,115
7
- burst_link_protocol-1.0.0.dist-info/METADATA,sha256=yP1FK2zuzGkH-WUjhksOpLnivdA3f818CeTkk6UlomI,2178
8
- burst_link_protocol-1.0.0.dist-info/licenses/LICENSE,sha256=x290DRUhub7ZynoErVJsMQSTxiYhsTQdYjtDFzZTOzA,16725