sub-byte 0.0.7__tar.gz

sub_byte-0.0.7/.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

sub_byte-0.0.7/.github/workflows/test.yml

@@ -0,0 +1,64 @@
+name: Run PyTest 
+
+description: Run the API Fuzz tests using Pytest and Hypothesis
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+
+  run_tests:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          "3.12",
+          "3.13",
+          "3.14.0-alpha.3",
+        ]
+        os: [
+          "ubuntu-24.04",
+        ]
+        include:
+
+          - os: "macos-latest"
+            python-version: "3.13"
+          - os: "windows-latest"
+            python-version: "3.13"
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install test dependencies
+      run: pip install pytest hypothesis
+
+    - name: Install code under test
+      run: pip install -e .
+
+
+    - uses: denoland/setup-deno@v2
+      with:
+        deno-version: v2.x
+
+    - name: Show files in tests dir
+      working-directory: tests
+      shell: bash
+      run: ls -A
+
+    - name: Install JS deps from npm
+      run: npm ci
+
+    - name: Run JS tests
+      run: npm run test
+
+    - name: Run Python tests (JS tested via CLI).
+      working-directory: tests
+      run: pytest

sub_byte-0.0.7/.github/workflows/type_check.yml

@@ -0,0 +1,63 @@
+name: Type check Python 
+
+description: Run Mypy and Pyright etc.
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+
+  mypy:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          3.13,
+        ]
+        os: [
+          "ubuntu-latest",
+        ]
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install code for deps
+      run: pip install -e .[mypy]
+
+    - name: Run mypy
+      run: mypy src/sub_byte
+
+  pyright:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [
+          3.13,
+        ]
+        os: [
+          "ubuntu-latest",
+        ]
+
+    runs-on: ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install code for deps
+      run: pip install -e .
+
+    - uses: jakebailey/pyright-action@v2
+      with:
+        extra-args:
+          src/sub_byte/factories.py

sub_byte-0.0.7/.gitignore

@@ -0,0 +1,167 @@
+.vscode/*
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintainted in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+number_cache.py
+*.dat
+grades_goals_forms_solutions
+*.tar.gz
+
+sols*
+*.zip
+tests/pg100.txt
+/node_modules
+
+*.tgz
+.eslintcache

sub_byte-0.0.7/.prettierignore

@@ -0,0 +1,4 @@
+# Ignore artifacts:
+build
+coverage
+.github

sub_byte-0.0.7/.prettierrc

@@ -0,0 +1 @@
+{}

sub_byte-0.0.7/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present James Parrott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sub_byte-0.0.7/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: sub-byte
+Version: 0.0.7
+Summary: Encodes and decodes sequences of unsigned integers with known widths (and sequences of symbols from finite sets). 
+Project-URL: Homepage, https://github.com/NumberzGame/sub_byte
+Project-URL: Bug Tracker, https://github.com/NumberzGame/sub_byte/issues
+Author-email: James Parrott <james.parrott@proton.me>
+License: MIT License
+        
+        Copyright (c) 2024-present James Parrott
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+License-File: LICENSE.md
+Keywords: Encoders,Serialization
+Classifier: Programming Language :: Python
+Requires-Python: >=3.12
+Requires-Dist: more-itertools
+Provides-Extra: mypy
+Requires-Dist: mypy; extra == 'mypy'
+Provides-Extra: test
+Requires-Dist: hypothesis; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Sub_Byte
+
+Bit packer and depacker.  Encodes and decodes sequences of integers with known bit-widths (and sequences of symbols equivalent to integers under some mapping).
+
+## Overview
+
+Sub Byte stores data without wasting bits, while preserving its structure, without requiring compression or decompression.  Simple bit packing is used, supporting using less than a byte of storage for <=7 bit fields, crossing byte 
+boundaries if necessary.
+
+A bit width for each symbol is required.  The bit width sequence (a simple codec) can be associated with the encoded data as meta data.  The decoder can be passed the total number of symbols to decode (e.g. whether a null byte (0b00000000), is 8 1-bit zeros, 4 2-bit zeros, 2 u4 zeros or a single u8 zero).  
+
+Alternatively, more dynamic codecs can be supported by passing null for the number of symbols to the decoder.  Axtra custom code 
+must then be written by the user, to determine when iteration ceases.  This can be used e.g. to encode the actual bit widths first (in some other fixed bit widths), to encode the number of symbols or cycles, and to implement any other codec that determines bit widths, and termination of iteration, according to the user's code.
+
+Data validation (e.g. checksums or hashes) must be done by the user, but an extra field can easily be appended to a bit width cycle.
+
+## Implementations
+
+### Python
+Calculate a cache of data in Python.
+
+```shell
+uv pip install sub_byte
+```
+
+
+### Typescript/Javascript
+Decode a cache of data in Javascript, even in browser.
+
+```shell
+npm i sub_byte
+```
+
+
+## Alternatives
+
+### Sub 4kB datasets
+This library is not needed for data storage.  Neither Sub_byte nor anything else, will reduce the disk space used.
+If the size of the un-encoded data set is less 4kB for example (or the page size of the file system on which the data will be stored, e.g. ext4, NTFS, APFS) then it is already below the minimum file size for that file system. 
+
+### A bespoke protocol using custom width integer types
+
+Up to 8 u1s (bits), up to 4 u2s, or up to 2 u3s or u4s per byte.
+Each developer must create their own implementation and tests.
+Interoperability between different private implementations is untestable.
+
+### Protocol buffers
+
+Encodes max symbol per byte. Variable byte encoding - uses continuation bits.
+
+### Zipping (data compression)
+
+- Exploits statistical distributions (e.g. "E" being more common in English text than "Q") and patterns.
+- Unstructured until the end user unzips the archive.
+
+## Changelog
+### v0.05
+Configured npm module for Typescript.
+### v0.04
+Support dynamic codecs (null/None number of elements to decode).
+
+## Development
+
+### Type checking and linting:
+#### Python
+##### MyPy
+```shell
+mypy --python-executable=path/to/venv/where/deps/installed/python.exe src/sub_byte
+```
+
+##### Pyright
+Activate venv where deps installed
+```shell
+pyright src/sub_byte/factories.py
+```
+
+#### TS
+##### Typescipt compiler
+```shell
+npm run typecheck
+```
+##### Eslint
+```shell
+npm run eslint
+```
+
+##### Prettier
+###### Check
+```shell
+npm run prettier
+```
+
+###### Auto fix
+```shell
+npm run prettier:write
+```
+
+### Publishing
+
+Bump version in package.json to x.y.z
+
+#### NPM
+```shell
+npm run prepublish
+npm pack
+```
+Double check contents of sub_byte-x.y.z.tgz
+
+```shell
+npm publish
+```
+Sign in (currently requires being the author).
+
+#### PyPi
+
+

sub_byte-0.0.7/README.md

@@ -0,0 +1,116 @@
+# Sub_Byte
+
+Bit packer and depacker.  Encodes and decodes sequences of integers with known bit-widths (and sequences of symbols equivalent to integers under some mapping).
+
+## Overview
+
+Sub Byte stores data without wasting bits, while preserving its structure, without requiring compression or decompression.  Simple bit packing is used, supporting using less than a byte of storage for <=7 bit fields, crossing byte 
+boundaries if necessary.
+
+A bit width for each symbol is required.  The bit width sequence (a simple codec) can be associated with the encoded data as meta data.  The decoder can be passed the total number of symbols to decode (e.g. whether a null byte (0b00000000), is 8 1-bit zeros, 4 2-bit zeros, 2 u4 zeros or a single u8 zero).  
+
+Alternatively, more dynamic codecs can be supported by passing null for the number of symbols to the decoder.  Axtra custom code 
+must then be written by the user, to determine when iteration ceases.  This can be used e.g. to encode the actual bit widths first (in some other fixed bit widths), to encode the number of symbols or cycles, and to implement any other codec that determines bit widths, and termination of iteration, according to the user's code.
+
+Data validation (e.g. checksums or hashes) must be done by the user, but an extra field can easily be appended to a bit width cycle.
+
+## Implementations
+
+### Python
+Calculate a cache of data in Python.
+
+```shell
+uv pip install sub_byte
+```
+
+
+### Typescript/Javascript
+Decode a cache of data in Javascript, even in browser.
+
+```shell
+npm i sub_byte
+```
+
+
+## Alternatives
+
+### Sub 4kB datasets
+This library is not needed for data storage.  Neither Sub_byte nor anything else, will reduce the disk space used.
+If the size of the un-encoded data set is less 4kB for example (or the page size of the file system on which the data will be stored, e.g. ext4, NTFS, APFS) then it is already below the minimum file size for that file system. 
+
+### A bespoke protocol using custom width integer types
+
+Up to 8 u1s (bits), up to 4 u2s, or up to 2 u3s or u4s per byte.
+Each developer must create their own implementation and tests.
+Interoperability between different private implementations is untestable.
+
+### Protocol buffers
+
+Encodes max symbol per byte. Variable byte encoding - uses continuation bits.
+
+### Zipping (data compression)
+
+- Exploits statistical distributions (e.g. "E" being more common in English text than "Q") and patterns.
+- Unstructured until the end user unzips the archive.
+
+## Changelog
+### v0.05
+Configured npm module for Typescript.
+### v0.04
+Support dynamic codecs (null/None number of elements to decode).
+
+## Development
+
+### Type checking and linting:
+#### Python
+##### MyPy
+```shell
+mypy --python-executable=path/to/venv/where/deps/installed/python.exe src/sub_byte
+```
+
+##### Pyright
+Activate venv where deps installed
+```shell
+pyright src/sub_byte/factories.py
+```
+
+#### TS
+##### Typescipt compiler
+```shell
+npm run typecheck
+```
+##### Eslint
+```shell
+npm run eslint
+```
+
+##### Prettier
+###### Check
+```shell
+npm run prettier
+```
+
+###### Auto fix
+```shell
+npm run prettier:write
+```
+
+### Publishing
+
+Bump version in package.json to x.y.z
+
+#### NPM
+```shell
+npm run prepublish
+npm pack
+```
+Double check contents of sub_byte-x.y.z.tgz
+
+```shell
+npm publish
+```
+Sign in (currently requires being the author).
+
+#### PyPi
+
+

sub_byte-0.0.7/deno.lock

@@ -0,0 +1,39 @@
+{
+  "version": "4",
+  "specifiers": {
+    "jsr:@std/assert@*": "1.0.10",
+    "jsr:@std/assert@^1.0.10": "1.0.10",
+    "jsr:@std/internal@^1.0.5": "1.0.5",
+    "jsr:@std/testing@*": "1.0.8"
+  },
+  "jsr": {
+    "@std/assert@1.0.10": {
+      "integrity": "59b5cbac5bd55459a19045d95cc7c2ff787b4f8527c0dd195078ff6f9481fbb3",
+      "dependencies": [
+        "jsr:@std/internal"
+      ]
+    },
+    "@std/internal@1.0.5": {
+      "integrity": "54a546004f769c1ac9e025abd15a76b6671ddc9687e2313b67376125650dc7ba"
+    },
+    "@std/testing@1.0.8": {
+      "integrity": "ceef535808fb7568e91b0f8263599bd29b1c5603ffb0377227f00a8ca9fe42a2",
+      "dependencies": [
+        "jsr:@std/assert@^1.0.10",
+        "jsr:@std/internal"
+      ]
+    }
+  },
+  "workspace": {
+    "packageJson": {
+      "dependencies": [
+        "npm:@eslint/js@^9.13.0",
+        "npm:eslint@^9.13.0",
+        "npm:fast-check@^3.22.0",
+        "npm:globals@^15.11.0",
+        "npm:mocha@^10.7.3",
+        "npm:prettier@3.3.3"
+      ]
+    }
+  }
+}

sub_byte-0.0.7/eslint.config.mjs

@@ -0,0 +1,12 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+
+export default [
+  { languageOptions: { globals: globals.browser, ecmaVersion: "latest" } },
+  pluginJs.configs.recommended,
+  {
+    rules: {
+      camelcase: "error",
+    },
+  },
+];