Metadata-Version: 1.0
Name: bin-parser
Version: 1.0.1
Summary: General binary file parser
Home-page: http://bin-parser.readthedocs.io/en/latest/
Author: Jeroen F.J. Laros
Author-email: J.F.J.Laros@lumc.nl
License: MIT License
Description: General binary file parser
        ==========================
        
        .. image:: https://img.shields.io/github/last-commit/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser/graphs/commit-activity
        .. image:: https://travis-ci.org/jfjlaros/bin-parser.svg?branch=master
           :target: https://travis-ci.org/jfjlaros/bin-parser
        .. image:: https://readthedocs.org/projects/bin-parser/badge/?version=latest
           :target: https://bin-parser.readthedocs.io/en/latest
        .. image:: https://img.shields.io/github/release-date/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser/releases
        .. image:: https://img.shields.io/github/release/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser/releases
        .. image:: https://img.shields.io/pypi/v/bin-parser.svg
           :target: https://pypi.org/project/bin-parser/
        .. image:: https://img.shields.io/npm/v/bin-parser.svg
           :target: https://www.npmjs.com/package/bin-parser
        .. image:: https://img.shields.io/github/languages/code-size/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser
        .. image:: https://img.shields.io/github/languages/count/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser
        .. image:: https://img.shields.io/github/languages/top/jfjlaros/bin-parser.svg
           :target: https://github.com/jfjlaros/bin-parser
        .. image:: https://img.shields.io/github/license/jfjlaros/bin-parser.svg
           :target: https://raw.githubusercontent.com/jfjlaros/bin-parser/master/LICENSE.md
        
        ----
        
        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_ for the latest documentation.
        
        
        .. _ReadTheDocs: https://bin-parser.readthedocs.io/en/latest/index.html
        
Platform: any
