{ "info": { "author": "Jochen Gerhaeusser", "author_email": "jochen_privat@gmx.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Topic :: Scientific/Engineering :: Interface Engine/Protocol Translator", "Topic :: Scientific/Engineering :: Visualization", "Topic :: Software Development", "Topic :: Software Development :: Embedded Systems", "Topic :: Software Development :: Testing" ], "description": "# KonF'00'\n\n[![status](https://img.shields.io/pypi/status/konfoo.svg)](https://pypi.org/project/konfoo)\n[![docs](https://readthedocs.org/projects/konfoo/badge/?version=latest)](https://konfoo.readthedocs.io)\n[![pypi](https://img.shields.io/pypi/v/konfoo.svg)](https://pypi.org/project/konfoo)\n[![python](https://img.shields.io/pypi/pyversions/konfoo.svg)](https://docs.python.org/3/)\n[![license](https://img.shields.io/pypi/l/konfoo.svg)](https://github.com/JoeVirtual/KonFoo/blob/master/LICENSE)\n[![downloads](https://img.shields.io/pypi/dm/konfoo.svg)](https://pypistats.org/packages/konfoo)\n[![binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/joevirtual/konfoo/master?labpath=notebooks)\n\n**KonFoo** is a Python Package for creating byte stream mappers in a declarative\nway with as little code as necessary to help fighting the confusion with the\nfoo of the all well-known memory dumps or hexadecimal views of binary data.\n\nIt comes with sensible defaults out of the box.\n\nIt aims to make the process of reading, de-serializing, viewing, serializing\nand writing binary data from and back to a data provider as easy as possible.\n\n**KonFoo** in points:\n\n* declarative way to describe the mapping of binary data to Python types\n* declarative classes to read, deserialize, view, serialize and write binary\n data from and back to a data source\n* easy adjustable byte stream provider bridge to any kind of data source\n* nesting of classes\n* adaptable classes on the fly while reading/de-serializing binary data\n* easy syntax for accessing nested fields\n* view the mapped binary data as a JSON string\n* list the mapped binary data as a flat list or dictionary\n* write the mapped binary data to a `.json` file\n* write the mapped binary data to a `.csv` file\n* save the mapped binary data to an `.ini` file\n* load the mapped binary data from an `.ini` file\n* easy creatable nested metadata dictionaries of the members of a byte stream\n mapper\n* metadata converter to the `flare.json` format to visualise the mapper with\n [d3.js](https://d3js.org).\n\n## Table of Contents\n[Back to top]: #table-of-contents\n\n1. [Project Status](#project-status)\n2. [Project Structure](#project-structure)\n3. [Getting Started](#getting-started)\n\t- [Dependencies](#dependencies)\n\t- [Installation](#installation)\n\t- [Usage](#usage)\n4. [Development](#development)\n\t- [Getting the Source](#getting-the-source)\n\t- [Building a Distribution](#building-a-distribution)\n\t- [Building the Documentation](#building-the-documentation)\n5. [Release Process](#release-process)\n\t- [Versioning](#versioning)\n6. [Documentation](#documentation)\n7. [License](#license)\n8. [Authors](#authors)\n\n## Project Status\n\nThis [project] is stable and active. Feedback is always welcomed!\n\n**[Back to top](#table-of-contents)**\n\n## Project Structure\n\nThe [project] is organized in sub-folders.\n\n- `assets/`: Project assets\n- `binder/`: Binder configuration\n- `docs/`: [Sphinx] documentation\n- `notebooks/`: [Jupyter] notebooks\n- `src/konfoo/`: Package sources\n\n**[Back to top](#table-of-contents)**\n\n## Getting Started\n\n### Dependencies\n\nThe `KonFoo` package requires at least [Python] 3.6, otherwise no other packages\nare required.\n\n### Installation\n\nTo install the package from [PyPi] using [pip]\n\n```shell\n> pip install konfoo\n```\n\n**[Back to top](#table-of-contents)**\n\n### Usage\n\nRead the documentation on \"[Read The Docs]\".\n\n**[Back to top](#table-of-contents)**\n\n## Development\n\n### Getting the Source\n\nThis [project] is hosted on [github].\nYou can clone the [project] directly using this command:\n\n```shell\n> git clone https://github.com/JoeVirtual/KonFoo.git\n```\n\n### Building a Distribution\n\nTo build local a distribution of this [project], use this command:\n\n```shell\n> make build\n```\n\nThe generated the distribution artifacts can be found in the `./dist` folder\nof the cloned [project] on your machine.\n\n### Building the Documentation\n\nBuilding the documentation requires [Sphinx], the [Furo] theme, and the\n[Sphinx] extension [sphinx-copybutton].\n\n```shell\n> pip install sphinx\n> pip install furo\n> pip install sphinx-copybutton\n```\n\nTo build local the documentation of this [project], use this command:\n\n```shell\n> make docs\n```\n\nThe generated HTML documentation artifact can be found in the\n`./docs/_build/html` folder of the cloned [project] on your machine.\n\n**[Back to top](#table-of-contents)**\n\n## Release Process\n\n### Versioning\n\nThis project uses [Semantic Versioning].\nFor a list of available versions, see the [repository tag list].\n\n**[Back to top](#table-of-contents)**\n\n## Documentation\n\nThe documentation for the latest repository build is hosted on the\n[GitHub Pages] of the [project].\n\nThe documentations of the [project] **releases** are hosted on [Read The Docs].\n\n**[Back to top](#table-of-contents)**\n\n## Contributing\n\nIf you are interested to contribute code or documentation to the [project],\nplease take a look at the [contributing guidelines](CONTRIBUTING.md) for details\non our development process.\n\n**[Back to top](#table-of-contents)**\n\n## License\n\nThe [project] is licensed under the revised [3-Clause BSD License].\n\nSee [LICENSE](LICENSE).\n\n**[Back to top](#table-of-contents)**\n\n## Authors\n\n* Jochen Gerhaeusser\n\nSee also the list of [contributors] who participated in this [project].\n\n**[Back to top](#table-of-contents)**\n\n[Semantic Versioning]: https://semver.org\n[3-Clause BSD License]: https://opensource.org/licenses/BSD-3-Clause\n[Python]: https://www.python.org\n[PyPi]: https://pypi.org\n[pip]: https://pip.pypa.io\n[Sphinx]: https://pypi.org/project/sphinx\n[Furo]: https://pypi.org/project/furo\n[sphinx-copybutton]: https://pypi.org/project/sphinx-copybutton\n[Jupyter]: https://jupyter.org\n[github]: https://github.com\n[project]: https://github.com/JoeVirtual/KonFoo\n[repository tag list]: https://github.com/JoeVirtual/KonFoo/releases\n[contributors]: https://github.com/JoeVirtual/KonFoo/graphs/contributors\n[GitHub Pages]: https://joevirtual.github.io/KonFoo/\n[Read The Docs]: https://konfoo.readthedocs.io\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/JoeVirtual/KonFoo/zipball/master#egg=konfoo-dev", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/JoeVirtual/KonFoo/", "keywords": "binary data,deserialize,serialize,parse,decode,encode,unpack,pack", "license": "BSD-3-Clause", "maintainer": "", "maintainer_email": "", "name": "KonFoo", "package_url": "https://pypi.org/project/KonFoo/", "platform": "any", "project_url": "https://pypi.org/project/KonFoo/", "project_urls": { "Documentation": "https://konfoo.readthedocs.io", "Download": "https://github.com/JoeVirtual/KonFoo/zipball/master#egg=konfoo-dev", "Homepage": "https://github.com/JoeVirtual/KonFoo/", "Issue Tracker": "https://github.com/JoeVirtual/KonFoo/issues/", "Source Code": "https://github.com/JoeVirtual/KonFoo" }, "release_url": "https://pypi.org/project/KonFoo/2.1.0/", "requires_dist": null, "requires_python": ">=3.6", "summary": "A declarative byte stream mapping engine.", "version": "2.1.0", "yanked": false, "yanked_reason": null }, "last_serial": 12706729, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "c386abeb85aebec949fa47b711349fe8", "sha256": "2b94666936c82aecd1c86bd9286099faf0bcbdfbd3982e5599e8d4c97de177eb" }, "downloads": -1, "filename": "KonFoo-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "c386abeb85aebec949fa47b711349fe8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 51133, "upload_time": "2019-01-02T07:11:38", "upload_time_iso_8601": "2019-01-02T07:11:38.950573Z", "url": "https://files.pythonhosted.org/packages/2e/5e/046f739205bb1402a9665cff9efd63945f3e349435087653e18f02ebfc32/KonFoo-1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a1ad16d4ead9841abc3aa1db871911e0", "sha256": "2082e5c66801c0348d06b77af8415b2b80fbd97971f5dceab5a00556df499b4e" }, "downloads": -1, "filename": "KonFoo-1.0.tar.gz", "has_sig": false, "md5_digest": "a1ad16d4ead9841abc3aa1db871911e0", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 91525, "upload_time": "2019-01-02T07:11:41", "upload_time_iso_8601": "2019-01-02T07:11:41.067852Z", "url": "https://files.pythonhosted.org/packages/f7/7e/6e0189a2f3943a16714e06c5d589441cc4dcf662de3854015d374734458d/KonFoo-1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.1": [ { "comment_text": "", "digests": { "md5": "3bca8775a8cb23112475b10a0278837d", "sha256": "6731aa8dfeed2e5fd5b24668fa6067fb7e0b3c937b5621764db8a0e6f7ce8eb5" }, "downloads": -1, "filename": "KonFoo-1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "3bca8775a8cb23112475b10a0278837d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 51797, "upload_time": "2019-10-27T06:18:46", "upload_time_iso_8601": "2019-10-27T06:18:46.698521Z", "url": "https://files.pythonhosted.org/packages/e6/07/34e0c9db2a069ce77e98947cb450736f5da513955079a8a807eb6a4086a3/KonFoo-1.1-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "fc8ac460bfdf99078227a0939abef9d9", "sha256": "665fca3d96234fd5b0136f71597b4ad6cf3af6465610669401da3a2e5db467bf" }, "downloads": -1, "filename": "KonFoo-1.1.tar.gz", "has_sig": false, "md5_digest": "fc8ac460bfdf99078227a0939abef9d9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 92574, "upload_time": "2019-10-27T06:18:48", "upload_time_iso_8601": "2019-10-27T06:18:48.700855Z", "url": "https://files.pythonhosted.org/packages/74/ae/b232a83c0a8aba8f0188d7ce34de55189697c1c381e799cc8cc0a77fcc66/KonFoo-1.1.tar.gz", "yanked": false, "yanked_reason": null } ], "2.0": [ { "comment_text": "", "digests": { "md5": "ee4de802a4822704e2efd70b870969c3", "sha256": "f36e05f5cd952550ca852e9722dc2041c3afffe4b32814d51c4e2bf24c6af23c" }, "downloads": -1, "filename": "KonFoo-2.0-py3-none-any.whl", "has_sig": false, "md5_digest": "ee4de802a4822704e2efd70b870969c3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 51277, "upload_time": "2020-08-02T06:04:19", "upload_time_iso_8601": "2020-08-02T06:04:19.575817Z", "url": "https://files.pythonhosted.org/packages/b3/0c/d088034bc41e822df854e65b96f9d9076dd86d627345e09456924e2d3a8d/KonFoo-2.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "a701bbd4a6e4c72ef1941172612b068d", "sha256": "3744c8a336c79a0fb8f18ecc9e77d20f00d75e1a169fda3169429cfa026cf4f7" }, "downloads": -1, "filename": "KonFoo-2.0.tar.gz", "has_sig": false, "md5_digest": "a701bbd4a6e4c72ef1941172612b068d", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 94701, "upload_time": "2020-08-02T06:04:21", "upload_time_iso_8601": "2020-08-02T06:04:21.451668Z", "url": "https://files.pythonhosted.org/packages/05/6b/8638d305b2f87faf94c259dd1e1aa4d248bd3ad383e0a8b96c27b36b1f8e/KonFoo-2.0.tar.gz", "yanked": false, "yanked_reason": null } ], "2.1.0": [ { "comment_text": "", "digests": { "md5": "e10d7c9f2d5bcd5bfc2aac4a1fd532cb", "sha256": "5c69186088e8867725a316a0d679b5777b83c02e997fa809ea00001acdf76f21" }, "downloads": -1, "filename": "KonFoo-2.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e10d7c9f2d5bcd5bfc2aac4a1fd532cb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 51815, "upload_time": "2022-01-27T06:04:02", "upload_time_iso_8601": "2022-01-27T06:04:02.511241Z", "url": "https://files.pythonhosted.org/packages/c4/f5/b11ba8c50537ac8c78e055a10c3dab257f86c71b69ba2228eaaa030d936f/KonFoo-2.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "f8c3679dae353343846fa6b124184d36", "sha256": "d8756047cfc05845c692d86a5fe8971a84bcd1dc4e3cc54f5017ce1399879d36" }, "downloads": -1, "filename": "KonFoo-2.1.0.tar.gz", "has_sig": false, "md5_digest": "f8c3679dae353343846fa6b124184d36", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 137172, "upload_time": "2022-01-27T06:04:04", "upload_time_iso_8601": "2022-01-27T06:04:04.123742Z", "url": "https://files.pythonhosted.org/packages/94/14/4ff7db4d724fb43c674ee8036ec71b0f05022701fa1617952e207c28c626/KonFoo-2.1.0.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e10d7c9f2d5bcd5bfc2aac4a1fd532cb", "sha256": "5c69186088e8867725a316a0d679b5777b83c02e997fa809ea00001acdf76f21" }, "downloads": -1, "filename": "KonFoo-2.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "e10d7c9f2d5bcd5bfc2aac4a1fd532cb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 51815, "upload_time": "2022-01-27T06:04:02", "upload_time_iso_8601": "2022-01-27T06:04:02.511241Z", "url": "https://files.pythonhosted.org/packages/c4/f5/b11ba8c50537ac8c78e055a10c3dab257f86c71b69ba2228eaaa030d936f/KonFoo-2.1.0-py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "f8c3679dae353343846fa6b124184d36", "sha256": "d8756047cfc05845c692d86a5fe8971a84bcd1dc4e3cc54f5017ce1399879d36" }, "downloads": -1, "filename": "KonFoo-2.1.0.tar.gz", "has_sig": false, "md5_digest": "f8c3679dae353343846fa6b124184d36", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6", "size": 137172, "upload_time": "2022-01-27T06:04:04", "upload_time_iso_8601": "2022-01-27T06:04:04.123742Z", "url": "https://files.pythonhosted.org/packages/94/14/4ff7db4d724fb43c674ee8036ec71b0f05022701fa1617952e207c28c626/KonFoo-2.1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }