bases: a Python library for general Base-N encodings.

Table of Contents

• Install
• Usage
• API
• Contributing
• License

Install

You can install this package with pip:

pip install bases

Usage

The core functionality of the library is performed by the encode and decode methods of base encodings, instances of BaseEncoding (or, more precisely, of its concrete subclasses).

Common encodings are associated to pre-defined constants:

>>> from bases import base32
>>> base32
FixcharBaseEncoding(
    StringAlphabet('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567',
                   case_sensitive=False),
    pad_char='=', padding='include')

The encode method can be used to encode bytestrings into strings:

>>> b = bytes([70, 98, 190, 187, 66, 224, 178])
>>> base32.encode(b)
'IZRL5O2C4CZA===='

The decode method can be used to decode strings into bytestrings:

>>> s = 'IZRL5O2C4CZA===='
>>> base32.decode(s)
b'Fb\xbe\xbbB\xe0\xb2'
>>> list(base32.decode(s))
[70, 98, 190, 187, 66, 224, 178]

The get(name), has(name), make(...) and table(prefix="") functions provide an interface for the programmatic management of encodings. The get(name) function can be used to obtain an existing encoding by name:

>>> import bases
>>> bases.get("base32")
FixcharBaseEncoding(
    StringAlphabet('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567',
                   case_sensitive=False),
    pad_char='=', padding='include')

The make(...) function can be used to create a new encoding from a given alphabet, encoding kind and options:

>>> bases.make("0123", kind="zeropad-enc", block_nchars=4, name="base4")
ZeropadBaseEncoding(StringAlphabet('0123'), block_nchars=4)

The optional keyword argument name can be used to register with the library for future retrieval. The has(name) function can be used to check whether an encoding exists by a given name:

>>> bases.has("base4")
True

The table(prefix="") function can be used to iterate through the existing encoding, optionally filtering by name prefix:

>>> dict(bases.table(prefix="base32"))
{'base32':      FixcharBaseEncoding(
                    StringAlphabet('ABCDEFGHIJKLMNOPQRSTUVWXYZ234567',
                                   case_sensitive=False),
                    pad_char='=', padding='include'),
 'base32hex':   FixcharBaseEncoding(
                    StringAlphabet('0123456789ABCDEFGHIJKLMNOPQRSTUV',
                                   case_sensitive=False),
                    pad_char='=', padding='include'),
 'base32z':     FixcharBaseEncoding(
                    StringAlphabet('ybndrfg8ejkmcpqxot1uwisza345h769',
                                   case_sensitive=False))
}

For further information, please refer to the API documentation.

API

The API documentation for this package is automatically generated by pdoc.

Contributing

Please see the contributing file.

License

MIT © Hashberg Ltd.