| Name | sub-byte JSON |
| Version |
0.0.2
JSON |
| download |
| home_page | None |
| Summary | Encodes and decodes sequences of integers with known widths, and sequences of symbols equivalent to integers under some mapping. |
| upload_time | 2024-10-27 17:46:33 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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. |
| keywords |
encoders
serialization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Sub_Byte
Encodes and decodes sequences of integers with known widths (and sequences of symbols equivalent to integers under some mapping).
## Overview
Sub_byte efficiently stores data, while preserving its structure, without requiring compression or decompression. Simple bit packing, using less than a byte for <=7 bit fiels less, crossing byte
boundaries if necessary, utilising a known fixed bit width for each symbol (avoiding continuation bits). The bit width sequence and the
total number of symbols, must be associated with the encoded data as meta data.
Data validation (e.g. checksums or hashes) must be done by the user, but can be appended to a bit width cycle.
## Implementations
### Python
Calculate a cache of data in Python.
### Javascript
Decode a cache of data in Javascript, even in browser.
## Alternatives
### 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "sub-byte",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Encoders, Serialization",
"author": null,
"author_email": "James Parrott <james.parrott@proton.me>",
"download_url": "https://files.pythonhosted.org/packages/50/4c/d5416decedbf6f65d73c11e579d5e151bd318d5fe9b32945b7cd7b2e27bf/sub_byte-0.0.2.tar.gz",
"platform": null,
"description": "# Sub_Byte\n\nEncodes and decodes sequences of integers with known widths (and sequences of symbols equivalent to integers under some mapping).\n\n## Overview\n\nSub_byte efficiently stores data, while preserving its structure, without requiring compression or decompression. Simple bit packing, using less than a byte for <=7 bit fiels less, crossing byte \nboundaries if necessary, utilising a known fixed bit width for each symbol (avoiding continuation bits). The bit width sequence and the \ntotal number of symbols, must be associated with the encoded data as meta data.\nData validation (e.g. checksums or hashes) must be done by the user, but can be appended to a bit width cycle.\n\n## Implementations\n\n### Python\nCalculate a cache of data in Python.\n\n### Javascript\nDecode a cache of data in Javascript, even in browser.\n\n## Alternatives\n\n### A bespoke protocol using custom width integer types\n\nUp to 8 u1s (bits), up to 4 u2s, or up to 2 u3s or u4s per byte.\nEach developer must create their own implementation and tests.\nInteroperability between different private implementations is untestable.\n\n### Protocol buffers\n\nEncodes max symbol per byte. Variable byte encoding - uses continuation bits.\n\n### Zipping (data compression)\n\n- Exploits statistical distributions (e.g. \"E\" being more common in English text than \"Q\") and patterns.\n- Unstructured until the end user unzips the archive.\n",
"bugtrack_url": null,
"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.",
"summary": "Encodes and decodes sequences of integers with known widths, and sequences of symbols equivalent to integers under some mapping.",
"version": "0.0.2",
"project_urls": {
"Bug Tracker": "https://github.com/JamesParrott/sub_byte/issues",
"Homepage": "https://github.com/JamesParrott/sub_byte"
},
"split_keywords": [
"encoders",
" serialization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "124bf82f30e892fb70d681f7df9b34e2de0fa7bbf9c1afe9f0a7c2bfae0e73b2",
"md5": "80e59bda0fee9185bd8be65688c56415",
"sha256": "f53e5465adf92f9dc6e1d7ac261aec5c43ceb838581ca8ede3e416d1f92227a3"
},
"downloads": -1,
"filename": "sub_byte-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "80e59bda0fee9185bd8be65688c56415",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5693,
"upload_time": "2024-10-27T17:46:31",
"upload_time_iso_8601": "2024-10-27T17:46:31.975588Z",
"url": "https://files.pythonhosted.org/packages/12/4b/f82f30e892fb70d681f7df9b34e2de0fa7bbf9c1afe9f0a7c2bfae0e73b2/sub_byte-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "504cd5416decedbf6f65d73c11e579d5e151bd318d5fe9b32945b7cd7b2e27bf",
"md5": "d055b0ace7c4e9ced3fab7b8eb78bd2c",
"sha256": "9a42f5ea35ac33cd1e46df2c0d9ccf4e779c3c88f42496145b48768d5c794d70"
},
"downloads": -1,
"filename": "sub_byte-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d055b0ace7c4e9ced3fab7b8eb78bd2c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 30002,
"upload_time": "2024-10-27T17:46:33",
"upload_time_iso_8601": "2024-10-27T17:46:33.488496Z",
"url": "https://files.pythonhosted.org/packages/50/4c/d5416decedbf6f65d73c11e579d5e151bd318d5fe9b32945b7cd7b2e27bf/sub_byte-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-27 17:46:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JamesParrott",
"github_project": "sub_byte",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sub-byte"
}
