General binary file parser.

General binary file parser. - Published in JOSS (2018)

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

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
    Found 5 DOI reference(s) in README and JOSS metadata
  • Academic publication links
    Links to: joss.theoj.org, zenodo.org
  • Committers with academic emails
    2 of 5 committers (40.0%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

binary json parser yaml

Keywords from Contributors

dice-roller
Last synced: 6 months ago · JSON representation

Repository

General binary file parser.

Basic Info
  • Host: GitHub
  • Owner: jfjlaros
  • License: mit
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 280 KB
Statistics
  • Stars: 25
  • Watchers: 4
  • Forks: 5
  • Open Issues: 0
  • Releases: 2
Topics
binary json parser yaml
Created over 10 years ago · Last pushed almost 5 years ago
Metadata Files
Readme Contributing License Code of conduct

README.md

General binary file parser

image image image image image image image image image image image image image


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.

Owner

  • Name: Jeroen F.J. Laros
  • Login: jfjlaros
  • Kind: user
  • Company: @RIVM-syso @LUMC

JOSS Publication

General binary file parser.
Published
June 21, 2018
Volume 3, Issue 26, Page 766
Authors
Jeroen F.j. Laros
Leiden University Medical Center,
Editor
Daniel S. Katz ORCID
Tags
binary parser yaml json read write

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 226
  • Total Committers: 5
  • Avg Commits per committer: 45.2
  • Development Distribution Score (DDS): 0.049
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jeroen F.J. Laros j****s@f****l 215
Matthew Fernandez m****z@g****m 5
Robert Haines r****s@m****k 3
Jamie Ross j****s@e****e 2
Daniel S. Katz d****z@i****g 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 9
  • Average time to close issues: 7 days
  • Average time to close pull requests: 7 days
  • Total issue authors: 6
  • Total pull request authors: 5
  • Average comments per issue: 3.07
  • Average comments per pull request: 0.78
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • Smattr (7)
  • hainesr (2)
  • simonschllng (2)
  • KOLANICH (1)
  • druidtides (1)
  • simon-p-r (1)
Pull Request Authors
  • Smattr (3)
  • hainesr (3)
  • jfjlaros (1)
  • druidtides (1)
  • danielskatz (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 2
  • Total downloads:
    • npm 7 last-month
    • pypi 65 last-month
  • Total dependent packages: 2
    (may contain duplicates)
  • Total dependent repositories: 3
    (may contain duplicates)
  • Total versions: 28
  • Total maintainers: 1
npmjs.org: bin-parser

General binary file parser

  • Versions: 16
  • Dependent Packages: 2
  • Dependent Repositories: 1
  • Downloads: 7 Last month
Rankings
Stargazers count: 7.4%
Forks count: 7.7%
Dependent packages count: 8.8%
Dependent repos count: 10.3%
Average: 10.5%
Downloads: 18.1%
Maintainers (1)
Last synced: 6 months ago
pypi.org: bin-parser

General binary file parser

  • Versions: 12
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 65 Last month
Rankings
Dependent packages count: 10.1%
Dependent repos count: 11.6%
Average: 14.8%
Downloads: 22.7%
Maintainers (1)
Last synced: 6 months ago

Dependencies

package.json npm
  • argparse ^1.0.3
  • buffer-extend-split ^0.0.0
  • iconv-lite ^0.4.13
  • js-yaml ^3.3.1
  • python-struct ^1.0.6
requirements.txt pypi
  • pytest *
  • pyyaml *