Skip to main content

Github top language Codacy grade Repository size Issues License Commit activity Last commit PyPI Downloads PyPI Version

BinaryIOTools

Project Icon

Does boilerplate things like reading the next uint32 from a file or binary stream

Create a new IO object and initialize/ set data

Example

f = open(fileName, 'rb')
data = f.read()
f.close()
io = IO(data)
width = io.u32
height = io.u32

The example above reads a file in binary and sets the variables width and height as the first two unsigned integer 32s

For a file starting with the bytes:

00 00 00 C8 00 01 90

The values for width and height would be 200, 400

Documentation

See the DOCS for a full list of functions

LGPLv3?

This code is slightly modified from https://github.com/TheHeadlessSourceMan/gimpFormats/blob/master/binaryIO.py (https://github.com/TheHeadlessSourceMan/gimpFormats binaryIO.py) which is under LGPLv3

Install With PIP

pip install binaryiotools

Head to https://pypi.org/project/binaryiotools/ for more info

Language information

Built for

This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.

Install Python on Windows

Chocolatey

choco install python

Download

To install Python, go to https://www.python.org/ and download the latest version.

Install Python on Linux

Apt

sudo apt install python3.8

How to run

With VSCode

  1. Open the .py file in vscode
  2. Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
  3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)

From the Terminal

./[file].py

How to update, build and publish

  1. Ensure you have installed the following dependencies Linux
    wget dephell.org/install | python3.8
    wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
    
    Windows
    (wget dephell.org/install -UseBasicParsing).Content | python
    (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
    
  2. Use poetry for the heavy lifting and dephell to generate requirements
    poetry update
    dephell deps convert
    
  3. Build/ Publish
    poetry build
    poetry publish
    
    or
    poetry publish --build
    

Download

Clone

Using The Command Line

  1. Press the Clone or download button in the top right
  2. Copy the URL (link)
  3. Open the command line and change directory to where you wish to clone to
  4. Type 'git clone' followed by URL in step 2
$ git clone https://github.com/FHPythonUtils/BinaryIOTools

More information can be found at https://help.github.com/en/articles/cloning-a-repository

Using GitHub Desktop

  1. Press the Clone or download button in the top right
  2. Click open in desktop
  3. Choose the path for where you want and click Clone

More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop

Download Zip File

  1. Download this GitHub repository
  2. Extract the zip archive
  3. Copy/ move to the desired location

Community Files

Licence

LGPLv3 License (See the LICENSE for more information.)

Changelog

See the Changelog for more information.

Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.

Contributing

Contributions are welcome, please see the Contributing Guidelines for more information.

Security

Thank you for improving the security of the project, please see the Security Policy for more information.

Metadata

Release files for binaryiotools 2020.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for binaryiotools 2020.1
File Size Uploaded Provenance Actions
binaryiotools-2020.1.tar.gz 11.4 kB Without provenance Details for binaryiotools-2020.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for binaryiotools 2020.1
File Interpreter ABI Platform Actions
binaryiotools-2020.1-py3-none-any.whl Python 3 none any Details for binaryiotools-2020.1-py3-none-any.whl

Total release size: 22.0 kB

Release files / binaryiotools-2020.1.tar.gz

Download URL binaryiotools-2020.1.tar.gz
Size 11.4 kB
Tags Source
SHA-256 checksum
How to use checksums
85b7b9de1f4d652e3fc59ecc43988e8f88fe6be40e701a1d653db7360bbe34ab
BLAKE2b-256 checksum
How to use checksums
3110a1e8983466afa2c04546e2f434976a29b6ece2213e04859baa829a1a6da8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.8.2 Windows/10

Release files / binaryiotools-2020.1-py3-none-any.whl

Download URL binaryiotools-2020.1-py3-none-any.whl
Size 10.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a2cac6819fb7757d4be392a60d29eda802db177d90ec8437ff7acb24654744c2
BLAKE2b-256 checksum
How to use checksums
7d47ddc354122ddf2101bc5f47813b7659d42a94fca647233b6fe477ebd1ba44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.0.5 CPython/3.8.2 Windows/10

Security for binaryiotools 2020.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page