burst-link-protocol 0.1.0__tar.gz → 0.1.1__tar.gz

{burst_link_protocol-0.1.0 → burst_link_protocol-0.1.1}/.github/workflows/pip.yml

@@ -2,10 +2,10 @@ name: Pip
 
 on:
   workflow_dispatch:
-  pull_request:
-  push:
-    branches:
-      - master
+  # pull_request:
+  # push:
+  #   branches:
+  #     - master
 
 jobs:
   build:

{burst_link_protocol-0.1.0 → burst_link_protocol-0.1.1}/.github/workflows/wheel.yml

@@ -2,10 +2,10 @@ name: Wheels
 
 on:
   workflow_dispatch:
-  pull_request:
-  push:
-    branches:
-     - master
+  # pull_request:
+  # push:
+  #   branches:
+  #    - master
   release:
     types:
       - published
@@ -37,9 +37,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest
-        # , macos-13, macos-14, windows-latest
-        ]
+        os: [ubuntu-latest, macos-13, macos-14, windows-latest]
 
     steps:
     - uses: actions/checkout@v4
@@ -49,8 +47,8 @@ jobs:
     - uses: pypa/cibuildwheel@v2.22
     # only build 3.12
       env:
-        # CIBW_BUILD: "cp312-*"
-        CIBW_BUILD: "cp312-manylinux_x86_64"
+        CIBW_BUILD: "cp312-*"
+        # CIBW_BUILD: "cp312-manylinux_x86_64"
 
     - name: Verify clean directory
       run: git diff --exit-code
@@ -66,10 +64,9 @@ jobs:
     name: Upload if release
     needs: [build_wheels, build_sdist]
     runs-on: ubuntu-latest
-    # if: github.event_name == 'release' && github.event.action == 'published'
     permissions:
       id-token: write
-    environment: pypi_release
+    # environment: pypi_release
 
     steps:
     - uses: actions/setup-python@v5

burst_link_protocol-0.1.1/PKG-INFO

@@ -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.0 → burst_link_protocol-0.1.1}/pyproject.toml

@@ -1,12 +1,12 @@
 [project]
 name = "burst-link-protocol"
-version = "0.1.0"  # Choose one version reference here
+version = "0.1.1"  # Choose one version reference here
 description = "Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream."
 requires-python = ">=3.10,<4.0"
 authors = [
   { name = "Floris vernieuwe", email = "floris@vernieuwe.eu" }
 ]
-
+readme = "README.md"
 dependencies = [
   "cobs>=1.2.1,<2.0.0",
   "numpy>=2.2.3,<3.0.0",

burst_link_protocol-0.1.0/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.1
-Name: burst-link-protocol
-Version: 0.1.0
-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