Skip to main content

A small library and tool to encode/decode a python UUID object to/from a 22 characters shorter URL safe base64 string.

Project description

b64uuid


pytest


A small library and tool to encode/decode a python UUID object to/from a 22 characters shorter URL safe base64 string.

We can use it to make UUID string a little shorter.

Installation

  • Install from PyPI:

    pip install b64uuid
    
  • Install from source :

    Clone or download whole project, enter the project's root directory, then

    pip install -e .
    

    or

    python setup.py install
    

Check https://packaging.python.org/tutorials/installing-packages/ for more details.

Command Line Usage

  • Make a random short ID

    $ b64uuid
    bxntPh4PSA6-OMDfBXMLhQ
    
  • Short ID from UUID

    $ b64uuid -u 2863a16d-b6ae-45a2-9d74-98d20377d56a
    KGOhbbauRaKddJjSA3fVag
    
  • Short ID to UUID

    $ b64uuid -s KGOhbbauRaKddJjSA3fVag
    2863a16d-b6ae-45a2-9d74-98d20377d56a
    

Library Usage

  • Shorten UUID string

    >>> from uuid import uuid1
    >>> from b64uuid import B64UUID
    >>>
    >>> uid = uuid1()
    >>> str(uid)
    'cb6e319c-d793-11ea-9619-1cb72cde3f7f'
    >>> bid = B64UUID(uid)
    >>> str(bid)
    'y24xnNeTEeqWGRy3LN4_fw'
    
  • Generate a new short ID

    >>> from b64uuid import B64UUID
    >>>
    >>> B64UUID().string
    'Ft018l4aTwalxqDHMQoqTQ'
    
  • Restore UUID from short ID

    >>> from uuid import uuid1
    >>> from b64uuid import B64UUID
    >>>
    >>> uid = uuid1()
    >>> uid.hex
    '95327416d79411ea96191cb72cde3f7f'
    >>> short_id = B64UUID(uid).string
    >>> short_id
    'lTJ0FteUEeqWGRy3LN4_fw'
    >>> B64UUID(short_id).uuid.hex
    '95327416d79411ea96191cb72cde3f7f
    



CONTRIBUTING

(TODO: ...)


Changelog

v0.1

  • Date: 2020-08-06

AUTHORS

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

b64uuid-0.1.tar.gz (25.2 kB view details)

Uploaded Source

Built Distribution

b64uuid-0.1-py3-none-any.whl (16.5 kB view details)

Uploaded Python 3

File details

Details for the file b64uuid-0.1.tar.gz.

File metadata

  • Download URL: b64uuid-0.1.tar.gz
  • Upload date:
  • Size: 25.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for b64uuid-0.1.tar.gz
Algorithm Hash digest
SHA256 0f44ddfb3224b9e857320ffde2a47be10d39739f89fcae9cf945a5ec9ffa8acc
MD5 1986be8ae39d4bf99493d1da8f4aa7aa
BLAKE2b-256 8c089180a9b8fdbab11e9528e008132cdb7becaed2bd7d5d01493baecbe707ae

See more details on using hashes here.

File details

Details for the file b64uuid-0.1-py3-none-any.whl.

File metadata

  • Download URL: b64uuid-0.1-py3-none-any.whl
  • Upload date:
  • Size: 16.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for b64uuid-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c382a10f739c4eef396c5f16f834e4134905785ed58b55726b64ffe0084a8cb0
MD5 2aaaf0ebf9d2dccee1577efd1390eceb
BLAKE2b-256 5afa1bfa8187ce7d519462a3853e2453d37ca6ced50e668e996b1aebc2e8e5f5

See more details on using hashes here.

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