Skip to main content

This library allows you to shorten a uuid

Project description

uuid_shortener

Build Status

uuid_shortener is a library for shortening UUIDs into an alphanumerical format suitable for usage in URLs.

The alphanumerical format is Flicker base 58 encoding.

Module usage

The UuidShortener object can be created with/without a prefix.

Example 1: without prefix
from uuid_shortener import UuidShortener
from uuid import uuid4

if __name__ == "__main__":
    print('******** Without prefix')

    shortener = UuidShortener()
    uuid_4 = uuid4()

    short_uuid = shortener.shorten(uuid_4)
    unshortened_uuid = shortener.unshorten(short_uuid)

    print('Uuid to shorten: {}'.format(str(uuid_4)))
    print('shortened uuid: {}'.format(short_uuid))
    print('unshortened uuid(original uuid): {}'.format(str(shortener.unshorten(short_uuid)), str(uuid_4)))
Output 1:
******** Without prefix
Uuid to shorten: 177d1b53-77d5-42b2-8b8f-8d86579deb52
shortened uuid: 3Ueemi554rN46ioLFw3dZG
unshortened uuid(original uuid): 177d1b53-77d5-42b2-8b8f-8d86579deb52

Example 2: with prefix
from uuid_shortener import UuidShortener
from uuid import uuid4

if __name__ == "__main__":
    print('******** With prefix')

    shortener = UuidShortener('meow')  # ;)
    uuid_4 = uuid4()

    short_uuid = shortener.shorten(uuid_4)
    unshortened_uuid = shortener.unshorten(short_uuid)

    print('Uuid to shorten: {}'.format(str(uuid_4)))
    print('shortened uuid: {}'.format(short_uuid))
    print('unshortened uuid (original uuid): {}'.format(str(shortener.unshorten(short_uuid)), str(uuid_4)))
Output 2:
******** With prefix
Uuid to shorten: 2bea23d4-2b96-485d-8788-0c606ab93319
shortened uuid: meow-6qwbaCZnHtxJsj4uJTKJSV
unshortened uuid (original uuid): 2bea23d4-2b96-485d-8788-0c606ab93319

License

MIT

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

uuid-shortener-py-0.0.1.tar.gz (3.0 kB view hashes)

Uploaded Source

Built Distribution

uuid_shortener_py-0.0.1-py3-none-any.whl (3.7 kB view hashes)

Uploaded Python 3

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