===========================================
Binary data structures (un-)Packing library
===========================================
.. badges
|PyPI Status| |GHA Status| |Documentation Status|
.. |PyPI Status| image:: https://img.shields.io/pypi/v/bpack.svg
:target: https://pypi.org/project/bpack
:alt: PyPI Status
.. |GHA Status| image:: https://github.com/avalentino/bpack/actions/workflows/ci.yml/badge.svg
:target: https://github.com/avalentino/bpack/actions
:alt: GitHub Actions Status
.. |Documentation Status| image:: https://readthedocs.org/projects/bpack/badge/?version=latest
:target: https://bpack.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. description
The *bpack* Python package provides tools to describe and encode/decode
binary data.
Binary data are assumed to be organized in *records*, each composed by a
sequence of fields. Fields are characterized by a known size, offset
(w.r.t. the beginning of the record) and datatype.
The package provides classes and functions that can be used to:
* describe binary data structures in a declarative way (structures can
be specified up to the bit level)
* automatically generate encoders/decoders for a specified data descriptor
Encoders/decoders (*backends*) rely on well known Python packages like:
* |struct| (form the standard library)
* bitstruct_ (optional)
* numpy_ (optional)
* bitarray_ (optional) - partial implementation
.. _struct: https://docs.python.org/3/library/struct.html
.. _bitstruct: https://github.com/eerimoq/bitstruct
.. _numpy: https://numpy.org
.. _bitarray: https://github.com/ilanschnell/bitarray
.. local-definitions
.. |struct| replace:: struct_
License
-------
:Copyright: 2020-2024, Antonio Valentino <antonio.valentino@tiscali.it>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": null,
"name": "bpack",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "binary, struct, descriptor, declarative, bit, unpack, pack",
"author": null,
"author_email": "Antonio Valentino <antonio.valentino@tiscali.it>",
"download_url": "https://files.pythonhosted.org/packages/a8/83/1a525e498c195f4f5075808836713a4d710eff8bda10ed4c214292f55a2b/bpack-1.2.0.tar.gz",
"platform": null,
"description": "===========================================\nBinary data structures (un-)Packing library\n===========================================\n\n.. badges\n\n|PyPI Status| |GHA Status| |Documentation Status|\n\n.. |PyPI Status| image:: https://img.shields.io/pypi/v/bpack.svg\n :target: https://pypi.org/project/bpack\n :alt: PyPI Status\n.. |GHA Status| image:: https://github.com/avalentino/bpack/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/avalentino/bpack/actions\n :alt: GitHub Actions Status\n.. |Documentation Status| image:: https://readthedocs.org/projects/bpack/badge/?version=latest\n :target: https://bpack.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. description\n\nThe *bpack* Python package provides tools to describe and encode/decode\nbinary data.\n\nBinary data are assumed to be organized in *records*, each composed by a\nsequence of fields. Fields are characterized by a known size, offset\n(w.r.t. the beginning of the record) and datatype.\n\nThe package provides classes and functions that can be used to:\n\n* describe binary data structures in a declarative way (structures can\n be specified up to the bit level)\n* automatically generate encoders/decoders for a specified data descriptor\n\nEncoders/decoders (*backends*) rely on well known Python packages like:\n\n* |struct| (form the standard library)\n* bitstruct_ (optional)\n* numpy_ (optional)\n* bitarray_ (optional) - partial implementation\n\n\n.. _struct: https://docs.python.org/3/library/struct.html\n.. _bitstruct: https://github.com/eerimoq/bitstruct\n.. _numpy: https://numpy.org\n.. _bitarray: https://github.com/ilanschnell/bitarray\n\n.. local-definitions\n\n.. |struct| replace:: struct_\n\n\nLicense\n-------\n\n:Copyright: 2020-2024, Antonio Valentino <antonio.valentino@tiscali.it>\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n https://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Binary data structures (un-)packing library",
"version": "1.2.0",
"project_urls": {
"Changelog": "https://github.com/avalentino/bpack/blob/main/docs/release_notes.rst",
"Documentation": "https://bpack.readthedocs.io",
"Homepage": "https://github.com/avalentino/bpack",
"Issues": "https://github.com/avalentino/bpack/issues",
"Repository": "https://github.com/avalentino/bpack.git"
},
"split_keywords": [
"binary",
" struct",
" descriptor",
" declarative",
" bit",
" unpack",
" pack"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "073af4d058b0c5462c7a1d0a7d288dd2f44ea5afd096fcfae59e6479889a27f6",
"md5": "d4dacf7f9d9387a7db2a2d9cd770e945",
"sha256": "8972b5578b23c6b9bf59292bb244b586b5da91a7f2050385f90fdf709ae5f35b"
},
"downloads": -1,
"filename": "bpack-1.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d4dacf7f9d9387a7db2a2d9cd770e945",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 57209,
"upload_time": "2024-11-26T07:32:08",
"upload_time_iso_8601": "2024-11-26T07:32:08.329452Z",
"url": "https://files.pythonhosted.org/packages/07/3a/f4d058b0c5462c7a1d0a7d288dd2f44ea5afd096fcfae59e6479889a27f6/bpack-1.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a8831a525e498c195f4f5075808836713a4d710eff8bda10ed4c214292f55a2b",
"md5": "987e3e0c305d51f946efb06367b9449c",
"sha256": "21aea88fed8956a33721e9fc60f51a1529f57fb65e20d2b687b20fb2fd803015"
},
"downloads": -1,
"filename": "bpack-1.2.0.tar.gz",
"has_sig": false,
"md5_digest": "987e3e0c305d51f946efb06367b9449c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 72084,
"upload_time": "2024-11-26T07:32:10",
"upload_time_iso_8601": "2024-11-26T07:32:10.398615Z",
"url": "https://files.pythonhosted.org/packages/a8/83/1a525e498c195f4f5075808836713a4d710eff8bda10ed4c214292f55a2b/bpack-1.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 07:32:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "avalentino",
"github_project": "bpack",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "bpack"
}
JSON
