hashberg-io / bases

A Python library for general Base-N encodings.

bases: A Python library for Base-N encodings

Bases provides a customisable, parametric implementation of several common styles of Base-N encoding, covering all cases appearing in the multibase specification (except for proquints).

Install

You can install the latest release from PyPI as follows:

$ pip install --upgrade bases

Usage

We suggest you import bases as follows:

>>> import bases

Below are some basic usage examples, to get you started: for detailed documentation, see https://bases.readthedocs.io/

Base encoding objects

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

Encoding

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

Decoding

>>> s = 'IZRL5O2C4CZA====' >>> base32.decode(s) b'FbxbexbbBxe0xb2' >>> list(base32.decode(s)) [70, 98, 190, 187, 66, 224, 178]

Case/padding variations

>>> b = bytes([70, 98, 190, 187, 66, 224, 178]) >>> base32.encode(b) 'IZRL5O2C4CZA====' >>> base32lower = base32.lower() >>> base32lower FixcharBaseEncoding( StringAlphabet('abcdefghijklmnopqrstuvwxyz234567', case_sensitive=False), pad_char='=', padding='include') >>> base32lower.encode(b) 'izrl5o2c4cza====' >>> base32nopad = base32.nopad() >>> base32nopad.encode(b) 'IZRL5O2C4CZA'

Case sensitivity variations

>>> s = 'IZRL5O2C4CZA====' >>> base32lower.decode(s) b'FbxbexbbBxe0xb2' >>> base32lower_casesensitive = base32lower.with_case_sensitivity(True) >>> base32lower_casesensitive.decode(s) bases.encoding.errors.NonAlphabeticCharError: Invalid character 'I' encountered for alphabet StringAlphabet('abcdefghijklmnopqrstuvwxyz234567').

Custom base encodings

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

API

For the full API documentation, see https://bases.readthedocs.io/

Contributing

Please see CONTRIBUTING.md.

License

MIT © Hashberg Ltd.