https://github.com/jfjlaros/bin-parser

General binary file parser.
https://github.com/jfjlaros/bin-parser

binary json parser yaml

Last synced: 2 months ago
JSON representation

General binary file parser.

• Host: GitHub
• URL: https://github.com/jfjlaros/bin-parser
• Owner: jfjlaros
• License: mit
• Created: 2015-06-28T11:17:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2021-03-10T15:34:38.000Z (almost 4 years ago)
• Last Synced: 2024-10-13T02:49:04.761Z (3 months ago)
• Topics: binary, json, parser, yaml
• Language: Python
• Homepage:
• Size: 280 KB
• Stars: 25
• Watchers: 5
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
General binary file parser

==========================

[![image](https://img.shields.io/github/last-commit/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser/graphs/commit-activity)

[![image](https://github.com/jfjlaros/bin-parser/actions/workflows/python-package.yml/badge.svg)](https://github.com/jfjlaros/bin-parser/actions/workflows/python-package.yml)

[![image](https://readthedocs.org/projects/bin-parser/badge/?version=latest)](https://bin-parser.readthedocs.io/en/latest)

[![image](https://img.shields.io/github/release-date/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser/releases)

[![image](https://img.shields.io/github/release/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser/releases)

[![image](https://img.shields.io/pypi/v/bin-parser.svg)](https://pypi.org/project/bin-parser/)

[![image](https://img.shields.io/npm/v/bin-parser.svg)](https://www.npmjs.com/package/bin-parser)

[![image](https://img.shields.io/github/languages/code-size/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser)

[![image](https://img.shields.io/github/languages/count/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser)

[![image](https://img.shields.io/github/languages/top/jfjlaros/bin-parser.svg)](https://github.com/jfjlaros/bin-parser)

[![image](https://img.shields.io/github/license/jfjlaros/bin-parser.svg)](https://raw.githubusercontent.com/jfjlaros/bin-parser/master/LICENSE.md)

[![image](https://zenodo.org/badge/DOI/10.5281/zenodo.1295625.svg)](https://zenodo.org/record/1295625)

[![image](http://joss.theoj.org/papers/10.21105/joss.00766/status.svg)](https://doi.org/10.21105/joss.00766)

------------------------------------------------------------------------

This library provides general binary file parsing by interpreting

documentation of a file structure and data types. By default, it

supports basic data types like big-endian and little-endian integers,

floats and doubles, variable length (delimited) strings, maps and bit

fields (flags) and it can iterate over sub structures. Other data types

are easily added.

The file structure and the types are stored in nested dictionaries. The

structure is separated from the types, this way multiple file formats

using the same types (within one project for example) can be easily

supported without much duplication.

The design of the library is such that all operations can be reversed.

This means that fully functional binary editing is possible using this

implementation; first use the reader to convert a binary file to a

serialised dictionary representation, this representation is easily

edited using a text editor, and then use the writer to convert back to

binary.

This idea is implemented in two languages; Python and JavaScript. All

main development is done in Python. We chose YAML as our preferred

serialised dictionary format, but other serialisation formats (JSON for

example) can be used too.

Please see

[ReadTheDocs](https://bin-parser.readthedocs.io/en/latest/index.html)

for the latest documentation.