Skip to main content

Python module for base62 encoding

Project description

base62

Build Status Coveralls PyPI

A Python module for base62 encoding. Ported from PHP code that I wrote in mid-2000, which can be found here.

Rationale

When writing a web application, often times we would like to keep the URLs short.

http://localhost/post/V1Biicwt

This certainly gives a more concise look than the following.

http://localhost/post/109237591284123

This was the original motivation to write this module, but there shall be much more broader potential use cases of this module. The main advantage of base62 is that it is URL-safe (as opposed to base64) due to the lack of special characters such as ‘/’ or ‘=’. Another key aspect is that the alphabetical orders of the original (unencoded) data is preserved when encoded. In other words, encoded data can be sorted without being decoded at all.

Installation

base62 can be installed via pypi. Unfortunately, the package name base62 on pypi had already been occupied by someone else, so we had to go by pybase62.

pip install pybase62

Alternatively, you may clone the code to manually install it.

git clone https://github.com/suminb/base62
cd base62 && python setup.py install

Usage

The following section describes a basic usage of base62.

>>> import base62

>>> base62.encode(34441886726)
'base62'

>>> base62.decode('base62')
34441886726

From version 0.2.0, base62 supports bytes array encoding as well.

>>> base62.encodebytes(b'\0')
0

>>> base62.encodebytes(b'\xff\xff')
H31

>>> base62.decodebytes('0')
b''

>>> base62.decodebytes('1')
b'\x01'

Tests

You may run some test cases to ensure all functionalities are operational.

py.test -v

If pytest is not installed, you may want to run the following commands:

pip install -r tests/requirements.txt

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

pybase62-0.3.3.tar.gz (3.0 kB view details)

Uploaded Source

File details

Details for the file pybase62-0.3.3.tar.gz.

File metadata

  • Download URL: pybase62-0.3.3.tar.gz
  • Upload date:
  • Size: 3.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.7

File hashes

Hashes for pybase62-0.3.3.tar.gz
Algorithm Hash digest
SHA256 223a486286a5ebc7d708065b55cfc46051c6b97abbe00487b752b9f988dfbcc8
MD5 112d19ae1feff8778291b281b0cf1af5
BLAKE2b-256 0c00eeb43b10396db548917ce231e96ba060839cc8ee039307a3fdbff6a9a2de

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page