Metadata-Version: 1.1
Name: bautils
Version: 0.0.4
Summary: Utils for the Python bitarray module
Home-page: https://gitlab.com/TC01/python-bautils
Author: Ben Rosser
Author-email: rosser.bjr@gmail.com
License: MIT
Description: python-bautils
        ==============
        
        bautils is a Python module implementing some useful helper functions for
        working with the Python
        `bitarray <https://pypi.python.org/pypi/bitarray/>`__ module.
        Specifically, bautils supports adding (and, coming soon) other basic
        arithmetic operations on bitarrays as if they were arbitrary length
        binary numbers, something the bitarray package itself doesn't seem to
        support.
        
        I opted to put these functions in a new module; none are terribly
        complicated to implement, so they're essentially just a set of
        convenient wrappers.
        
        Currently bautils just contains the following routines. More work is
        planned for the future:
        
        ``add(b1, b2)``: add two bitarrays together, returns the result.
        
        ``left(ba, n)``: shifts a bitarray left by n, preserving the original
        size.
        
        ``right(ba, n)``: shifts a bitarray right by n, preserving the original
        size.
        
        ``random(length)``: returns a random bitarray of size length.
        
        ``maxb(b1, b2)``: returns the larger bitarray.
        
        ``minb(b1, b2)``: returns the smaller bitarray.
        
        Unit tests are also a work in progress.
        
        Credits, Legal
        ==============
        
        bautils is written by Ben Rosser rosser.bjr@gmail.com, and is released
        under the MIT License (see LICENSE file).
        
Keywords: bitarray binary
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
