Skip to main content

No project description provided

Project description

# [![wick](.media/logo.svg)](

# wick

[![Python 3.6](]()

wick is a Python command line tool that generates file I/O source code for working with binary data.

## Installation

$ pip install wick

## Usage

$ wick common.h --language=python

## What _exactly_ does it do?

Let's walk through a concrete example.

Say we have binary data that is a sequence of records that are represented by a string name and an integer id. We can write a simple C struct representation of this data.

// record.h

// Simple Record
struct Record {
// Record name
char name[64];

// Record id.
unsigned char id;

Then we run `wick` on the file:

$ wick record.h --language=python

Which will then emit:

import struct

class Record:
"""Simple Record

name: Record name

id: Record id.

format = '<64sB'
size = struct.calcsize(format)

slots = (

def __init__(self,
id): = name = id

def write(cls, file, record):
record_data = struct.pack(cls.format,,


def read(cls, file):
record_data =
record_struct = struct.unpack(cls.format, record_data)

return Record(*record_struct)

Then we can import this code into Python and _do work_.

### Read Data
with open(path, 'rb') as file:
rec =

### Write Data
with open(path, 'wb') as file:
rec = Record(b'name', 0)
Record.write(file, rec)

### Unpack Lots of Data
import struct

# Assuming the file only contains Record data
with open(path, 'rb') as file:
recs = [Record(*chunk) for chunk in struct.iter_unpack(Record.format,]

## Contributing
Have a bug fix or a new feature you'd like to see in wick? Send it our way! Please make sure you create an issue that addresses your fix/feature so we can discuss the contribution.

1. Fork this repo!
2. Create your feature branch: `git checkout -b features/add-javascript-code-generator`
3. Commit your changes: `git commit -m 'Implemented Javascript code generator'`
4. Push the branch: `git push origin add-javascript-code-generator`
5. Submit a pull request.
6. Create an [issue](

## License

See the [license](./LICENSE) document for the full text.

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

wick-0.6.1.tar.gz (15.2 kB view hashes)

Uploaded Source

Supported by

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