Skip to main content

z-base-32: human-oriented base-32 encoding

Project description

z-base-32

ci

The z-base-32 is a human-oriented base-32 encoding.

Rust

Crate

Installation

cargo add z-base-32

API

The library exposes two functions with the following signatures and an error type:

pub fn encode(input: &[u8]) -> String;

pub fn decode(input: &str) -> Result<Vec<u8>, DecodeError>;

pub struct DecodeError;

Example

use zbase32::{encode, decode};

fn main() {
    assert_eq!(encode(b"foo"), "c3zs6".to_string());
    assert_eq!(Ok(b"foo"), decode("c3zs6".to_string()));
    assert_eq!(decode(&encode(b"foo")).unwrap(), b"foo")
}

CLI

This project also provides a CLI utility with a similar interface to the well-known base64 command.

Installation

To install z-base-32 CLI you can build it from source or download prebuild binary from releases.

cargo install --features cli z-base-32

Example

$ zbase32 -h
z-base-32: human-oriented base-32 encoding

Usage: zbase32 [OPTIONS] [FILE]

Arguments:
  [FILE]  File to encode or decode

Options:
  -d, --decode       Decode data
  -w, --wrap <WRAP>  Wrap encoded lines after COLS character [default: 76]
  -h, --help         Print help
  -V, --version      Print version

Python

Installation

The z-base-32 package is published at PyPI. Install it using the following command:

pip install z-base-32

Building

This crate can be compiled with the feature flag python in which case it produces Python bindings. To build Python wheels use maturin:

maturin build

API

def encode(input: bytes) -> str:

def decode(input: str) -> bytes:

class DecodeError(Exception):

Example

import zbase32

assert zbase32.encode(b'foo') == 'c3zs6'

assert zbase32.decode('c3zs6') == b'foo'


try:
    zbase32.decode('invalid@char')
except zbase32.DecodeError as e:
    print(e)

References

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

z_base_32-0.1.4.tar.gz (14.0 kB view hashes)

Uploaded Source

Built Distributions

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.3 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.3 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.4 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded PyPy manylinux: glibc 2.5+ i686

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.3 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.3 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.3 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded PyPy manylinux: glibc 2.5+ i686

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.1 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.4 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.1 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-pp38-pypy38_pp73-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded PyPy manylinux: glibc 2.5+ i686

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (987.8 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (996.4 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (976.2 kB view hashes)

Uploaded PyPy manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-pp37-pypy37_pp73-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded PyPy manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.5 kB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.6 kB view hashes)

Uploaded CPython 3.13 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp312-none-win_amd64.whl (106.6 kB view hashes)

Uploaded CPython 3.12 Windows x86-64

z_base_32-0.1.4-cp312-none-win32.whl (104.0 kB view hashes)

Uploaded CPython 3.12 Windows x86

z_base_32-0.1.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.4 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.5 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.6 kB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.12 manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp312-cp312-macosx_11_0_arm64.whl (217.2 kB view hashes)

Uploaded CPython 3.12 macOS 11.0+ ARM64

z_base_32-0.1.4-cp312-cp312-macosx_10_12_x86_64.whl (220.8 kB view hashes)

Uploaded CPython 3.12 macOS 10.12+ x86-64

z_base_32-0.1.4-cp311-none-win_amd64.whl (106.0 kB view hashes)

Uploaded CPython 3.11 Windows x86-64

z_base_32-0.1.4-cp311-none-win32.whl (104.1 kB view hashes)

Uploaded CPython 3.11 Windows x86

z_base_32-0.1.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.6 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.9 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.8 kB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.11 manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp311-cp311-macosx_11_0_arm64.whl (217.1 kB view hashes)

Uploaded CPython 3.11 macOS 11.0+ ARM64

z_base_32-0.1.4-cp311-cp311-macosx_10_12_x86_64.whl (221.1 kB view hashes)

Uploaded CPython 3.11 macOS 10.12+ x86-64

z_base_32-0.1.4-cp310-none-win_amd64.whl (106.0 kB view hashes)

Uploaded CPython 3.10 Windows x86-64

z_base_32-0.1.4-cp310-none-win32.whl (104.1 kB view hashes)

Uploaded CPython 3.10 Windows x86

z_base_32-0.1.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.6 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.9 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.7 kB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.10 manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp310-cp310-macosx_11_0_arm64.whl (217.1 kB view hashes)

Uploaded CPython 3.10 macOS 11.0+ ARM64

z_base_32-0.1.4-cp310-cp310-macosx_10_12_x86_64.whl (221.1 kB view hashes)

Uploaded CPython 3.10 macOS 10.12+ x86-64

z_base_32-0.1.4-cp39-none-win_amd64.whl (106.0 kB view hashes)

Uploaded CPython 3.9 Windows x86-64

z_base_32-0.1.4-cp39-none-win32.whl (104.1 kB view hashes)

Uploaded CPython 3.9 Windows x86

z_base_32-0.1.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (984.6 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.7 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.8 kB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.9 manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp38-none-win_amd64.whl (105.9 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

z_base_32-0.1.4-cp38-none-win32.whl (104.1 kB view hashes)

Uploaded CPython 3.8 Windows x86

z_base_32-0.1.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (983.9 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.4 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.4 kB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.8 manylinux: glibc 2.5+ i686

z_base_32-0.1.4-cp37-none-win_amd64.whl (105.8 kB view hashes)

Uploaded CPython 3.7 Windows x86-64

z_base_32-0.1.4-cp37-none-win32.whl (104.0 kB view hashes)

Uploaded CPython 3.7 Windows x86

z_base_32-0.1.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (983.7 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ x86-64

z_base_32-0.1.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl (1.1 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ s390x

z_base_32-0.1.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl (1.1 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ppc64le

z_base_32-0.1.4-cp37-cp37m-manylinux_2_17_armv7l.manylinux2014_armv7l.whl (993.3 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ARMv7l

z_base_32-0.1.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (973.2 kB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.17+ ARM64

z_base_32-0.1.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.whl (1.0 MB view hashes)

Uploaded CPython 3.7m manylinux: glibc 2.5+ i686

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