base32-lib 1.0.0

Usage

import base32_lib as base32

# Generate
## Generate a random identifier
base32.generate()
# -> 'abcd1234'

# Generate a random identifier with bells and whistle
base32.generate(length=10, split_every=5, checksum=True)
# -> '3sbk2-5j060'

# Encode a pre-existing number
base32.encode(1234, split_every=3, checksum=True) == "16j-82"

# Decode an identifier
base32.decode("16j-82", checksum=True) == 1234

base32.decode("16i-82", checksum=True)
# raises ValueError

Features

• Generation, encoding and decoding of base32 strings

• Douglas Crockford base32 encoding

• URL-safe strings with no problematic special characters

• Decoding of any-case strings

• Configurable length strings

• Randomness through cryptographically secure random number generator

• Optional ISO-7064 checksum

• Optional hyphenation

Installation

The base32-lib package is on PyPI so all you need is:

pip install base32-lib

Development

pipenv run pip install -e .[docs,tests]

pipenv run ./run-tests.sh

Changes

Version 1.0.0 (2019-10-XX)

• First public release.