Metadata-Version: 2.4
Name: binary-file-parser
Version: 0.3.0a2
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
License-File: LICENSE
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM

# BinaryFileParser

A blazingly fast python library written in rust for serializing/deserializing python objects to/from binary files. BFP syntax is declarative and very versatile, allowing the user to specify file formats in a very readable and concise manner.

## Installation (dev)

1. Have [rust](https://www.rust-lang.org/) and [python](https://www.python.org/) installed
2. Create an empty directory and `cd` into it
3. Clone: `git clone -b bfp-rs https://github.com/Divy1211/BinaryFileParser.git`
4. Create a venv: `python -m venv venv` and activate it.
5. Install maturin `pip install maturin`
6. Do a build:
   - dev: `maturin develope`
   - release: `maturin develop --release`
7. Play

## Installation

PyPI: TODO

## Getting Started

TODO

## About the Author

If you have any questions, suggestions or feedback regarding the library, feel free to send me a message on discord!

| Author   | Discord       |
|----------|---------------|
| Alian713 | Alian713#0069 |

