Skip to main content

Readma? What's Readma?

Project description

Readma? What's Readma?

Readma is a binary stream reading library I made for fun that I decided I would extend on and release

Well, what does it do?

Well I'm glad you asked!

Readma is a little library I started to help with parsing binary files.

That's it?

Well yeah, what did you expect? Some large module I've been writing my entire life that will change the world with its amazing binary reading ability?

Cool Badge

Tests

Usage

Note, requires Python 3.8 or higher (For now at least)

Installation

pip install readma

Sample code

from readma import Readma

# Let's say this file contains in order:
# - An integer
# - An unsigned integer
# - A float
# - A string prefixed by its length with a byte
# - An unknown amount of data you just really need read
r = Readma("some_file.bin") # note: defaults to Little Endian

integer = r.read(4) # size in bytes
unsigned_integer = r.uread(4)

a_float = r.float()

length = r.read(1)
string = r.bytes(length)

important_data = r.readall()

Documentation

tba

License

Copyright (c) 2021 whamer100
This project is MIT licensed.


hey is this project name just one big ligma joke

maybe

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

readma-1.0.0a0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

readma-1.0.0a0-py3-none-any.whl (4.4 kB view details)

Uploaded Python 3

File details

Details for the file readma-1.0.0a0.tar.gz.

File metadata

  • Download URL: readma-1.0.0a0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.5

File hashes

Hashes for readma-1.0.0a0.tar.gz
Algorithm Hash digest
SHA256 a8d34b14ec1156f0e33245483cb881b2a6dd95d7b5ffc2377ac639c99bb22f45
MD5 81f3cdf5e72da7f3adb8e3a18d863dfe
BLAKE2b-256 ae3a1adba6965ad50432f4183a6638ddab9305a5201e01978c6cc861a3578682

See more details on using hashes here.

File details

Details for the file readma-1.0.0a0-py3-none-any.whl.

File metadata

  • Download URL: readma-1.0.0a0-py3-none-any.whl
  • Upload date:
  • Size: 4.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.5

File hashes

Hashes for readma-1.0.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 3ab25b2f46f184e349b21ccd2ef0f092c21d5dd6b5f10af4940b2ab53c55f3d1
MD5 0bf560e62d4641211e2bc4cf7bf1375c
BLAKE2b-256 86b5625e45e66be8cfd28f5b3c891320ab7783b24b5a342e16e5333ad625a355

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page