././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636629546.5072904 shortuuid-1.0.8/COPYING0000644000000000000000000000271400000000000012734 0ustar0000000000000000Copyright (c) 2011, Stavros Korokithakis All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Stochastic Technologies nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1636408749.717791 shortuuid-1.0.8/README.md0000644000000000000000000001144600000000000013162 0ustar0000000000000000Description =========== `shortuuid` is a simple python library that generates concise, unambiguous, URL-safe UUIDs. Often, one needs to use non-sequential IDs in places where users will see them, but the IDs must be as concise and easy to use as possible. `shortuuid` solves this problem by generating uuids using Python's built-in `uuid` module and then translating them to base57 using lowercase and uppercase letters and digits, and removing similar-looking characters such as l, 1, I, O and 0. [![image](https://travis-ci.org/skorokithakis/shortuuid.svg?branch=master)](https://travis-ci.org/skorokithakis/shortuuid) Installation ------------ To install `shortuuid` you need: - Python 3.x. If you have the dependencies, you have multiple options of installation: - With pip (preferred), do `pip install shortuuid`. - With setuptools, do `easy_install shortuuid`. - To install the source, download it from https://github.com/stochastic-technologies/shortuuid and run `python setup.py install`. Usage ----- To use `shortuuid`, just import it in your project like so: ```python >>> import shortuuid ``` You can then generate a short UUID: ```python >>> shortuuid.uuid() 'vytxeTZskVKR7C7WgdSP3d' ``` If you prefer a version 5 UUID, you can pass a name (DNS or URL) to the call and it will be used as a namespace (`uuid.NAMESPACE_DNS` or `uuid.NAMESPACE_URL`) for the resulting UUID: ```python >>> shortuuid.uuid(name="example.com") 'wpsWLdLt9nscn2jbTD3uxe' >>> shortuuid.uuid(name="") 'c8sh5y9hdSMS6zVnrvf53T' ``` You can also generate a cryptographically secure random string (using `os.urandom()` internally) with: ```python >>> shortuuid.ShortUUID().random(length=22) 'RaF56o2r58hTKT7AYS9doj' ``` To see the alphabet that is being used to generate new UUIDs: ```python >>> shortuuid.get_alphabet() '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz' ``` If you want to use your own alphabet to generate UUIDs, use `set_alphabet()`: ```python >>> shortuuid.set_alphabet("aaaaabcdefgh1230123") >>> shortuuid.uuid() '0agee20aa1hehebcagddhedddc0d2chhab3b' ``` `shortuuid` will automatically sort and remove duplicates from your alphabet to ensure consistency: ```python >>> shortuuid.get_alphabet() '0123abcdefgh' ``` If the default 22 digits are too long for you, you can get shorter IDs by just truncating the string to the desired length. The IDs won't be universally unique any longer, but the probability of a collision will still be very low. To serialize existing UUIDs, use `encode()` and `decode()`: ```python >>> import uuid >>> u = uuid.uuid4() >>> u UUID('6ca4f0f8-2508-4bac-b8f1-5d1e3da2247a') >>> s = shortuuid.encode(u) >>> s 'cu8Eo9RyrUsV4MXEiDZpLM' >>> shortuuid.decode(s) == u True >>> short = s[:7] >>> short 'cu8Eo9R' >>> h = shortuuid.decode(short) UUID('00000000-0000-0000-0000-00b8c0b9f952') >>> shortuuid.decode(shortuuid.encode(h)) == h True ``` Class-based usage ----------------- If you need to have various alphabets per-thread, you can use the `ShortUUID` class, like so: ```python >>> su = shortuuid.ShortUUID(alphabet="01345678") >>> su.uuid() '034636353306816784480643806546503818874456' >>> su.get_alphabet() '01345678' >>> su.set_alphabet("21345687654123456") >>> su.get_alphabet() '12345678' ``` Command-line usage ------------------ `shortuuid` provides a simple way to generate a short UUID in a terminal: ```bash $ python3 -m shortuuid fZpeF6gcskHbSpTgpQCkcJ ``` (Replace `python3` with `py` if you are using Windows). Django field ------------ `shortuuid` includes a Django field that generates random short UUIDs by default, for your convenience: ```python from shortuuid.django_fields import ShortUUIDField class MyModel(models.Model): # A primary key ID of length 16 and a short alphabet. id = ShortUUIDField( length=16, max_length=40, prefix="id_", alphabet="abcdefg1234", primary_key=True, ) # A short UUID of length 22 and the default alphabet. api_key = ShortUUIDField() ``` The field is the same as the `CharField`, with a `length` argument (the length of the ID), an `alphabet` argument, and the `default` argument removed. Everything else is exactly the same, e.g. `index`, `help_text`, `max_length`, etc. Compatibility note ------------------ Versions of ShortUUID prior to 1.0.0 generated UUIDs with their MSB last, i.e. reversed. This was later fixed, but if you have some UUIDs stored as a string with the old method, you need to pass `legacy=True` to `decode()` when converting your strings back to UUIDs. That option will go away in the future, so you will want to convert your UUIDs to strings using the new method. This can be done like so: ```python >>> new_uuid_str = encode(decode(old_uuid_str, legacy=True)) ``` License ------- `shortuuid` is distributed under the BSD license. ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636629653.2954972 shortuuid-1.0.8/pyproject.toml0000644000000000000000000000146600000000000014620 0ustar0000000000000000[tool.poetry] name = "shortuuid" version = "1.0.8" description = "A generator library for concise, unambiguous and URL-safe UUIDs." license = "BSD" classifiers = [ "License :: OSI Approved :: BSD License", "Programming Language :: Python", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Topic :: Software Development :: Libraries :: Python Modules" ] homepage = "https://github.com/skorokithakis/shortuuid/" authors = ["Stavros Korokithakis "] readme = "README.md" include = ["COPYING"] [tool.poetry.scripts] shortuuid = "shortuuid:cli.main" [tool.poetry.dependencies] python = ">=3.5" ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636629657.5564659 shortuuid-1.0.8/shortuuid/__init__.py0000644000000000000000000000051200000000000016032 0ustar0000000000000000from shortuuid.main import decode # noqa from shortuuid.main import encode # noqa from shortuuid.main import get_alphabet # noqa from shortuuid.main import random # noqa from shortuuid.main import set_alphabet # noqa from shortuuid.main import ShortUUID # noqa from shortuuid.main import uuid # noqa __version__ = "1.0.8" ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1636387466.319352 shortuuid-1.0.8/shortuuid/cli.py0000644000000000000000000000006700000000000015047 0ustar0000000000000000from .main import uuid def main(): print(uuid()) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636408443.4085038 shortuuid-1.0.8/shortuuid/django_fields.py0000644000000000000000000000210700000000000017065 0ustar0000000000000000from django.db import models from django.utils.translation import gettext_lazy as _ from . import ShortUUID class ShortUUIDField(models.CharField): description = _("A short UUID field.") def __init__(self, *args, **kwargs): self.length = kwargs.pop("length", 22) self.prefix = kwargs.pop("prefix", "") if "max_length" not in kwargs: # If `max_length` was not specified, set it here. kwargs["max_length"] = self.length self.alphabet = kwargs.pop("alphabet", None) kwargs["default"] = self._generate_uuid super().__init__(*args, **kwargs) def _generate_uuid(self): """Generate a short random string.""" return self.prefix + ShortUUID(alphabet=self.alphabet).random( length=self.length ) def deconstruct(self): name, path, args, kwargs = super().deconstruct() kwargs["alphabet"] = self.alphabet kwargs["length"] = self.length kwargs["prefix"] = self.prefix kwargs.pop("default", None) return name, path, args, kwargs ././@PaxHeader0000000000000000000000000000003300000000000011451 xustar000000000000000027 mtime=1636337571.636893 shortuuid-1.0.8/shortuuid/main.py0000644000000000000000000001062000000000000015220 0ustar0000000000000000"""Concise UUID generation.""" import binascii import math import os import uuid as _uu def int_to_string(number, alphabet, padding=None): """ Convert a number to a string, using the given alphabet. The output has the most significant digit first. """ output = "" alpha_len = len(alphabet) while number: number, digit = divmod(number, alpha_len) output += alphabet[digit] if padding: remainder = max(padding - len(output), 0) output = output + alphabet[0] * remainder return output[::-1] def string_to_int(string, alphabet): """ Convert a string to a number, using the given alphabet. The input is assumed to have the most significant digit first. """ number = 0 alpha_len = len(alphabet) for char in string: number = number * alpha_len + alphabet.index(char) return number class ShortUUID(object): def __init__(self, alphabet=None): if alphabet is None: alphabet = list( "23456789ABCDEFGHJKLMNPQRSTUVWXYZ" "abcdefghijkmnopqrstuvwxyz" ) self.set_alphabet(alphabet) @property def _length(self): """Return the necessary length to fit the entire UUID given the current alphabet.""" return int(math.ceil(math.log(2 ** 128, self._alpha_len))) def encode(self, uuid, pad_length=None): """ Encode a UUID into a string (LSB first) according to the alphabet. If leftmost (MSB) bits are 0, the string might be shorter. """ if not isinstance(uuid, _uu.UUID): raise ValueError("Input `uuid` must be a UUID object.") if pad_length is None: pad_length = self._length return int_to_string(uuid.int, self._alphabet, padding=pad_length) def decode(self, string, legacy=False): """ Decode a string according to the current alphabet into a UUID. Raises ValueError when encountering illegal characters or a too-long string. If string too short, fills leftmost (MSB) bits with 0. Pass `legacy=True` if your UUID was encoded with a ShortUUID version prior to 1.0.0. """ if not isinstance(string, str): raise ValueError("Input `string` must be a str.") if legacy: string = string[::-1] return _uu.UUID(int=string_to_int(string, self._alphabet)) def uuid(self, name=None, pad_length=None): """ Generate and return a UUID. If the name parameter is provided, set the namespace to the provided name and generate a UUID. """ if pad_length is None: pad_length = self._length # If no name is given, generate a random UUID. if name is None: u = _uu.uuid4() elif name.lower().startswith(("http://", "https://")): u = _uu.uuid5(_uu.NAMESPACE_URL, name) else: u = _uu.uuid5(_uu.NAMESPACE_DNS, name) return self.encode(u, pad_length) def random(self, length=None): """Generate and return a cryptographically secure short random string of `length`.""" if length is None: length = self._length random_num = int(binascii.b2a_hex(os.urandom(length)), 16) return int_to_string(random_num, self._alphabet, padding=length)[:length] def get_alphabet(self): """Return the current alphabet used for new UUIDs.""" return "".join(self._alphabet) def set_alphabet(self, alphabet): """Set the alphabet to be used for new UUIDs.""" # Turn the alphabet into a set and sort it to prevent duplicates # and ensure reproducibility. new_alphabet = list(sorted(set(alphabet))) if len(new_alphabet) > 1: self._alphabet = new_alphabet self._alpha_len = len(self._alphabet) else: raise ValueError("Alphabet with more than " "one unique symbols required.") def encoded_length(self, num_bytes=16): """Return the string length of the shortened UUID.""" factor = math.log(256) / math.log(self._alpha_len) return int(math.ceil(factor * num_bytes)) # For backwards compatibility _global_instance = ShortUUID() encode = _global_instance.encode decode = _global_instance.decode uuid = _global_instance.uuid random = _global_instance.random get_alphabet = _global_instance.get_alphabet set_alphabet = _global_instance.set_alphabet ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636337394.9561994 shortuuid-1.0.8/shortuuid/tests.py0000644000000000000000000001413100000000000015437 0ustar0000000000000000import os import string import sys import unittest from collections import defaultdict from uuid import UUID from uuid import uuid4 from shortuuid.main import decode from shortuuid.main import encode from shortuuid.main import get_alphabet from shortuuid.main import random from shortuuid.main import set_alphabet from shortuuid.main import ShortUUID from shortuuid.main import uuid sys.path.insert(0, os.path.abspath(__file__ + "/../..")) class LegacyShortUUIDTest(unittest.TestCase): def test_generation(self): self.assertTrue(20 < len(uuid()) < 24) self.assertTrue(20 < len(uuid("http://www.example.com/")) < 24) self.assertTrue(20 < len(uuid("HTTP://www.example.com/")) < 24) self.assertTrue(20 < len(uuid("example.com/")) < 24) def test_encoding(self): u = UUID("{3b1f8b40-222c-4a6e-b77e-779d5a94e21c}") self.assertEqual(encode(u), "CXc85b4rqinB7s5J52TRYb") def test_decoding(self): u = UUID("{3b1f8b40-222c-4a6e-b77e-779d5a94e21c}") self.assertEqual(decode("CXc85b4rqinB7s5J52TRYb"), u) def test_alphabet(self): backup_alphabet = get_alphabet() alphabet = "01" set_alphabet(alphabet) self.assertEqual(alphabet, get_alphabet()) set_alphabet("01010101010101") self.assertEqual(alphabet, get_alphabet()) self.assertEqual(set(uuid()), set("01")) self.assertTrue(116 < len(uuid()) < 140) u = uuid4() self.assertEqual(u, decode(encode(u))) u = uuid() self.assertEqual(u, encode(decode(u))) self.assertRaises(ValueError, set_alphabet, "1") self.assertRaises(ValueError, set_alphabet, "1111111") set_alphabet(backup_alphabet) self.assertRaises(ValueError, lambda x: ShortUUID(x), "0") def test_random(self): self.assertEqual(len(random()), 22) for i in range(1, 100): self.assertEqual(len(random(i)), i) class ClassShortUUIDTest(unittest.TestCase): def test_generation(self): su = ShortUUID() self.assertTrue(20 < len(su.uuid()) < 24) self.assertTrue(20 < len(su.uuid("http://www.example.com/")) < 24) self.assertTrue(20 < len(su.uuid("HTTP://www.example.com/")) < 24) self.assertTrue(20 < len(su.uuid("example.com/")) < 24) def test_encoding(self): su = ShortUUID() u = UUID("{3b1f8b40-222c-4a6e-b77e-779d5a94e21c}") self.assertEqual(su.encode(u), "CXc85b4rqinB7s5J52TRYb") def test_decoding(self): su = ShortUUID() u = UUID("{3b1f8b40-222c-4a6e-b77e-779d5a94e21c}") self.assertEqual(su.decode("CXc85b4rqinB7s5J52TRYb"), u) def test_random(self): su = ShortUUID() for i in range(1000): self.assertEqual(len(su.random()), 22) for i in range(1, 100): self.assertEqual(len(su.random(i)), i) def test_alphabet(self): alphabet = "01" su1 = ShortUUID(alphabet) su2 = ShortUUID() self.assertEqual(alphabet, su1.get_alphabet()) su1.set_alphabet("01010101010101") self.assertEqual(alphabet, su1.get_alphabet()) self.assertEqual(set(su1.uuid()), set("01")) self.assertTrue(116 < len(su1.uuid()) < 140) self.assertTrue(20 < len(su2.uuid()) < 24) u = uuid4() self.assertEqual(u, su1.decode(su1.encode(u))) u = su1.uuid() self.assertEqual(u, su1.encode(su1.decode(u))) self.assertRaises(ValueError, su1.set_alphabet, "1") self.assertRaises(ValueError, su1.set_alphabet, "1111111") def test_encoded_length(self): su1 = ShortUUID() self.assertEqual(su1.encoded_length(), 22) base64_alphabet = ( string.ascii_uppercase + string.ascii_lowercase + string.digits + "+/" ) su2 = ShortUUID(base64_alphabet) self.assertEqual(su2.encoded_length(), 22) binary_alphabet = "01" su3 = ShortUUID(binary_alphabet) self.assertEqual(su3.encoded_length(), 128) su4 = ShortUUID() self.assertEqual(su4.encoded_length(num_bytes=8), 11) class ShortUUIDPaddingTest(unittest.TestCase): def test_padding(self): su = ShortUUID() random_uid = uuid4() smallest_uid = UUID(int=0) encoded_random = su.encode(random_uid) encoded_small = su.encode(smallest_uid) self.assertEqual(len(encoded_random), len(encoded_small)) def test_decoding(self): su = ShortUUID() random_uid = uuid4() smallest_uid = UUID(int=0) encoded_random = su.encode(random_uid) encoded_small = su.encode(smallest_uid) self.assertEqual(su.decode(encoded_small), smallest_uid) self.assertEqual(su.decode(encoded_random), random_uid) def test_consistency(self): su = ShortUUID() num_iterations = 1000 uid_lengths = defaultdict(int) for count in range(num_iterations): random_uid = uuid4() encoded_random = su.encode(random_uid) uid_lengths[len(encoded_random)] += 1 decoded_random = su.decode(encoded_random) self.assertEqual(random_uid, decoded_random) self.assertEqual(len(uid_lengths), 1) uid_length = next(iter(uid_lengths.keys())) # Get the 1 value self.assertEqual(uid_lengths[uid_length], num_iterations) class EncodingEdgeCasesTest(unittest.TestCase): def test_decode_dict(self): su = ShortUUID() self.assertRaises(ValueError, su.encode, []) self.assertRaises(ValueError, su.encode, {}) self.assertRaises(ValueError, su.decode, (2,)) self.assertRaises(ValueError, su.encode, 42) self.assertRaises(ValueError, su.encode, 42.0) class DecodingEdgeCasesTest(unittest.TestCase): def test_decode_dict(self): su = ShortUUID() self.assertRaises(ValueError, su.decode, []) self.assertRaises(ValueError, su.decode, {}) self.assertRaises(ValueError, su.decode, (2,)) self.assertRaises(ValueError, su.decode, 42) self.assertRaises(ValueError, su.decode, 42.0) if __name__ == "__main__": unittest.main() ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636629678.2511165 shortuuid-1.0.8/setup.py0000644000000000000000000001331600000000000013413 0ustar0000000000000000# -*- coding: utf-8 -*- from setuptools import setup packages = \ ['shortuuid'] package_data = \ {'': ['*']} entry_points = \ {'console_scripts': ['shortuuid = shortuuid:cli.main']} setup_kwargs = { 'name': 'shortuuid', 'version': '1.0.8', 'description': 'A generator library for concise, unambiguous and URL-safe UUIDs.', 'long_description': 'Description\n===========\n\n`shortuuid` is a simple python library that generates concise, unambiguous, URL-safe\nUUIDs.\n\nOften, one needs to use non-sequential IDs in places where users will see them, but the\nIDs must be as concise and easy to use as possible. `shortuuid` solves this problem by\ngenerating uuids using Python\'s built-in `uuid` module and then translating them to\nbase57 using lowercase and uppercase letters and digits, and removing similar-looking\ncharacters such as l, 1, I, O and 0.\n\n[![image](https://travis-ci.org/skorokithakis/shortuuid.svg?branch=master)](https://travis-ci.org/skorokithakis/shortuuid)\n\n\nInstallation\n------------\n\nTo install `shortuuid` you need:\n\n- Python 3.x.\n\nIf you have the dependencies, you have multiple options of installation:\n\n- With pip (preferred), do `pip install shortuuid`.\n- With setuptools, do `easy_install shortuuid`.\n- To install the source, download it from\n https://github.com/stochastic-technologies/shortuuid and run `python setup.py\n install`.\n\n\nUsage\n-----\n\nTo use `shortuuid`, just import it in your project like so:\n\n```python\n>>> import shortuuid\n```\n\nYou can then generate a short UUID:\n\n```python\n>>> shortuuid.uuid()\n\'vytxeTZskVKR7C7WgdSP3d\'\n```\n\nIf you prefer a version 5 UUID, you can pass a name (DNS or URL) to the call and it will\nbe used as a namespace (`uuid.NAMESPACE_DNS` or `uuid.NAMESPACE_URL`) for the resulting\nUUID:\n\n```python\n>>> shortuuid.uuid(name="example.com")\n\'wpsWLdLt9nscn2jbTD3uxe\'\n\n>>> shortuuid.uuid(name="")\n\'c8sh5y9hdSMS6zVnrvf53T\'\n```\n\nYou can also generate a cryptographically secure random string (using `os.urandom()`\ninternally) with:\n\n```python\n>>> shortuuid.ShortUUID().random(length=22)\n\'RaF56o2r58hTKT7AYS9doj\'\n```\n\nTo see the alphabet that is being used to generate new UUIDs:\n\n```python\n>>> shortuuid.get_alphabet()\n\'23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz\'\n```\n\nIf you want to use your own alphabet to generate UUIDs, use `set_alphabet()`:\n\n```python\n>>> shortuuid.set_alphabet("aaaaabcdefgh1230123")\n>>> shortuuid.uuid()\n\'0agee20aa1hehebcagddhedddc0d2chhab3b\'\n```\n\n`shortuuid` will automatically sort and remove duplicates from your alphabet to ensure\nconsistency:\n\n```python\n>>> shortuuid.get_alphabet()\n\'0123abcdefgh\'\n```\n\nIf the default 22 digits are too long for you, you can get shorter IDs by just\ntruncating the string to the desired length. The IDs won\'t be universally unique any\nlonger, but the probability of a collision will still be very low.\n\nTo serialize existing UUIDs, use `encode()` and `decode()`:\n\n```python\n>>> import uuid\n>>> u = uuid.uuid4()\n>>> u\nUUID(\'6ca4f0f8-2508-4bac-b8f1-5d1e3da2247a\')\n\n>>> s = shortuuid.encode(u)\n>>> s\n\'cu8Eo9RyrUsV4MXEiDZpLM\'\n\n>>> shortuuid.decode(s) == u\nTrue\n\n>>> short = s[:7]\n>>> short\n\'cu8Eo9R\'\n\n>>> h = shortuuid.decode(short)\nUUID(\'00000000-0000-0000-0000-00b8c0b9f952\')\n\n>>> shortuuid.decode(shortuuid.encode(h)) == h\nTrue\n```\n\n\nClass-based usage\n-----------------\n\nIf you need to have various alphabets per-thread, you can use the `ShortUUID` class,\nlike so:\n\n```python\n>>> su = shortuuid.ShortUUID(alphabet="01345678")\n>>> su.uuid()\n\'034636353306816784480643806546503818874456\'\n\n>>> su.get_alphabet()\n\'01345678\'\n\n>>> su.set_alphabet("21345687654123456")\n>>> su.get_alphabet()\n\'12345678\'\n```\n\n\nCommand-line usage\n------------------\n\n`shortuuid` provides a simple way to generate a short UUID in a terminal:\n\n```bash\n$ python3 -m shortuuid\nfZpeF6gcskHbSpTgpQCkcJ\n```\n\n(Replace `python3` with `py` if you are using Windows).\n\n\nDjango field\n------------\n\n`shortuuid` includes a Django field that generates random short UUIDs by default, for\nyour convenience:\n\n```python\nfrom shortuuid.django_fields import ShortUUIDField\n\nclass MyModel(models.Model):\n # A primary key ID of length 16 and a short alphabet.\n id = ShortUUIDField(\n length=16,\n max_length=40,\n prefix="id_",\n alphabet="abcdefg1234",\n primary_key=True,\n )\n\n # A short UUID of length 22 and the default alphabet.\n api_key = ShortUUIDField()\n```\n\nThe field is the same as the `CharField`, with a `length` argument (the length of the\nID), an `alphabet` argument, and the `default` argument removed. Everything else is\nexactly the same, e.g. `index`, `help_text`, `max_length`, etc.\n\n\nCompatibility note\n------------------\n\nVersions of ShortUUID prior to 1.0.0 generated UUIDs with their MSB last, i.e. reversed.\nThis was later fixed, but if you have some UUIDs stored as a string with the old method,\nyou need to pass `legacy=True` to `decode()` when converting your strings back to UUIDs.\n\nThat option will go away in the future, so you will want to convert your UUIDs to\nstrings using the new method. This can be done like so:\n\n```python\n>>> new_uuid_str = encode(decode(old_uuid_str, legacy=True))\n```\n\nLicense\n-------\n\n`shortuuid` is distributed under the BSD license.\n', 'author': 'Stavros Korokithakis', 'author_email': 'hi@stavros.io', 'maintainer': None, 'maintainer_email': None, 'url': 'https://github.com/skorokithakis/shortuuid/', 'packages': packages, 'package_data': package_data, 'entry_points': entry_points, 'python_requires': '>=3.5', } setup(**setup_kwargs) ././@PaxHeader0000000000000000000000000000003400000000000011452 xustar000000000000000028 mtime=1636629678.2513208 shortuuid-1.0.8/PKG-INFO0000644000000000000000000001323000000000000012771 0ustar0000000000000000Metadata-Version: 2.1 Name: shortuuid Version: 1.0.8 Summary: A generator library for concise, unambiguous and URL-safe UUIDs. Home-page: https://github.com/skorokithakis/shortuuid/ License: BSD Author: Stavros Korokithakis Author-email: hi@stavros.io Requires-Python: >=3.5 Classifier: License :: OSI Approved :: BSD License Classifier: License :: Other/Proprietary License Classifier: Programming Language :: Python Classifier: Programming Language :: Python :: 3 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.5 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Topic :: Software Development :: Libraries :: Python Modules Description-Content-Type: text/markdown Description =========== `shortuuid` is a simple python library that generates concise, unambiguous, URL-safe UUIDs. Often, one needs to use non-sequential IDs in places where users will see them, but the IDs must be as concise and easy to use as possible. `shortuuid` solves this problem by generating uuids using Python's built-in `uuid` module and then translating them to base57 using lowercase and uppercase letters and digits, and removing similar-looking characters such as l, 1, I, O and 0. [![image](https://travis-ci.org/skorokithakis/shortuuid.svg?branch=master)](https://travis-ci.org/skorokithakis/shortuuid) Installation ------------ To install `shortuuid` you need: - Python 3.x. If you have the dependencies, you have multiple options of installation: - With pip (preferred), do `pip install shortuuid`. - With setuptools, do `easy_install shortuuid`. - To install the source, download it from https://github.com/stochastic-technologies/shortuuid and run `python setup.py install`. Usage ----- To use `shortuuid`, just import it in your project like so: ```python >>> import shortuuid ``` You can then generate a short UUID: ```python >>> shortuuid.uuid() 'vytxeTZskVKR7C7WgdSP3d' ``` If you prefer a version 5 UUID, you can pass a name (DNS or URL) to the call and it will be used as a namespace (`uuid.NAMESPACE_DNS` or `uuid.NAMESPACE_URL`) for the resulting UUID: ```python >>> shortuuid.uuid(name="example.com") 'wpsWLdLt9nscn2jbTD3uxe' >>> shortuuid.uuid(name="") 'c8sh5y9hdSMS6zVnrvf53T' ``` You can also generate a cryptographically secure random string (using `os.urandom()` internally) with: ```python >>> shortuuid.ShortUUID().random(length=22) 'RaF56o2r58hTKT7AYS9doj' ``` To see the alphabet that is being used to generate new UUIDs: ```python >>> shortuuid.get_alphabet() '23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz' ``` If you want to use your own alphabet to generate UUIDs, use `set_alphabet()`: ```python >>> shortuuid.set_alphabet("aaaaabcdefgh1230123") >>> shortuuid.uuid() '0agee20aa1hehebcagddhedddc0d2chhab3b' ``` `shortuuid` will automatically sort and remove duplicates from your alphabet to ensure consistency: ```python >>> shortuuid.get_alphabet() '0123abcdefgh' ``` If the default 22 digits are too long for you, you can get shorter IDs by just truncating the string to the desired length. The IDs won't be universally unique any longer, but the probability of a collision will still be very low. To serialize existing UUIDs, use `encode()` and `decode()`: ```python >>> import uuid >>> u = uuid.uuid4() >>> u UUID('6ca4f0f8-2508-4bac-b8f1-5d1e3da2247a') >>> s = shortuuid.encode(u) >>> s 'cu8Eo9RyrUsV4MXEiDZpLM' >>> shortuuid.decode(s) == u True >>> short = s[:7] >>> short 'cu8Eo9R' >>> h = shortuuid.decode(short) UUID('00000000-0000-0000-0000-00b8c0b9f952') >>> shortuuid.decode(shortuuid.encode(h)) == h True ``` Class-based usage ----------------- If you need to have various alphabets per-thread, you can use the `ShortUUID` class, like so: ```python >>> su = shortuuid.ShortUUID(alphabet="01345678") >>> su.uuid() '034636353306816784480643806546503818874456' >>> su.get_alphabet() '01345678' >>> su.set_alphabet("21345687654123456") >>> su.get_alphabet() '12345678' ``` Command-line usage ------------------ `shortuuid` provides a simple way to generate a short UUID in a terminal: ```bash $ python3 -m shortuuid fZpeF6gcskHbSpTgpQCkcJ ``` (Replace `python3` with `py` if you are using Windows). Django field ------------ `shortuuid` includes a Django field that generates random short UUIDs by default, for your convenience: ```python from shortuuid.django_fields import ShortUUIDField class MyModel(models.Model): # A primary key ID of length 16 and a short alphabet. id = ShortUUIDField( length=16, max_length=40, prefix="id_", alphabet="abcdefg1234", primary_key=True, ) # A short UUID of length 22 and the default alphabet. api_key = ShortUUIDField() ``` The field is the same as the `CharField`, with a `length` argument (the length of the ID), an `alphabet` argument, and the `default` argument removed. Everything else is exactly the same, e.g. `index`, `help_text`, `max_length`, etc. Compatibility note ------------------ Versions of ShortUUID prior to 1.0.0 generated UUIDs with their MSB last, i.e. reversed. This was later fixed, but if you have some UUIDs stored as a string with the old method, you need to pass `legacy=True` to `decode()` when converting your strings back to UUIDs. That option will go away in the future, so you will want to convert your UUIDs to strings using the new method. This can be done like so: ```python >>> new_uuid_str = encode(decode(old_uuid_str, legacy=True)) ``` License ------- `shortuuid` is distributed under the BSD license.