Skip to content
Python implementation for generating Tiny URL- and URLs.
Branch: master
Clone or download
Alir3z4 Release 1.2.2 (#16)
* Update ChangeLog.rst

* bump version number to latest

* Add more badges

* Add more tox env

* Add more python versions to travis

* Update tox.ini

* Add pypy

* Update .travis.yml

* Update tox.ini

* Update tox.ini

* Update tox.ini

* Update
Latest commit fffbdbe May 31, 2016
Type Name Latest commit message Commit time
Failed to load latest commit information.
requirements Add needed requirements and tox configuration. Jan 11, 2014
short_url Release 1.2.2 (#16) May 31, 2016
tests Add test for checking test data Jan 26, 2014
AUTHORS Add Friedrich Paetzke Jan 11, 2014


Short URL Generator

travis-cli tests status for short_url PyPI Version PyPI Status PyPI License PyPI Format PyPI Py_versions PyPI Implementation PyPI Egg

Python implementation for generating Tiny URL- and URLs.

A bit-shuffling approach is used to avoid generating consecutive, predictable URLs. However, the algorithm is deterministic and will guarantee that no collisions will occur.

The URL alphabet is fully customizable and may contain any number of characters. By default, digits and lower-case letters are used, with some removed to avoid confusion between characters like o, O and 0. The default alphabet is shuffled and has a prime number of characters to further improve the results of the algorithm.

The block size specifies how many bits will be shuffled. The lower BLOCK_SIZE bits are reversed. Any bits higher than BLOCK_SIZE will remain as is. BLOCK_SIZE of 0 will leave all bits unaffected and the algorithm will simply be converting your integer to a different base.

The intended use is that incrementing, consecutive integers will be used as keys to generate the short URLs. For example, when creating a new URL, the unique integer ID assigned by a database could be used to generate the URL by using this module. Or a simple counter may be used. As long as the same integer is not used twice, the same short URL will not be generated twice.

The module supports both encoding and decoding of URLs. The min_length parameter allows you to pad the URL if you want it to be a specific length.

Sample Usage:

>>> import short_url
>>> url = short_url.encode_url(12)
>>> print url
>>> key = short_url.decode_url(url)
>>> print key

Use the functions in the top-level of the module to use the default encoder. Otherwise, you may create your own UrlEncoder object and use its encode_url and decode_url methods.


short_url is also available at pypi:

Give a try to your finger:

$ pip install short_url

And done ;)


short_url is tested on both python2 and python3, to run the tests:

$ tox

Author Michael Fogleman
Maintainer Alireza Savand
License MIT
You can’t perform that action at this time.