Metadata-Version: 2.1
Name: uuid-shortener-py
Version: 1.1.0
Summary: Shorten a uuid into a URL friendly format.
Home-page: https://github.com/El-Sam/uuid_shortener
Author: Samira El Aabidi
Author-email: sam.elaabidi@gmail.com
License: UNKNOWN
Description: # uuid_shortener
        
        [![Build Status](https://travis-ci.com/El-Sam/uuid_shortener.svg?branch=master)](https://travis-ci.com/El-Sam/uuid_shortener)
        [![PyPI supported versions](https://img.shields.io/pypi/pyversions/uuid-shortener-py.svg)](https://pypi.python.org/pypi/uuid-shortener-py)
        [![PyPI version](https://badge.fury.io/py/uuid-shortener-py.svg)](https://badge.fury.io/py/uuid-shortener-py)
        
        **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.
        
        ## Installation
        
        from [Pypi](https://pypi.org/project/uuid-shortener-py/):
        
        ` pip install uuid-shortener-py `
        
        ## Module usage
        
        The `UuidShortener` object can be created with/without a prefix.
        
        ##### Example 1: without prefix
        
        ```python
        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(f'Uuid to shorten: {uuid_4}')
            print(f'shortened uuid: {short_uuid}')
            print(f'unshortened uuid(original uuid): {shortener.unshorten(short_uuid)}')
        
        ```
        
        ##### 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
        
        ```python
        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(f'Uuid to shorten: {uuid_4}')
            print(f'shortened uuid: {short_uuid}')
            print(f'unshortened uuid (original uuid): {shortener.unshorten(short_uuid)}')
        ```
        
        ##### 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
        ```
        
        ##### As an easy, one-way generator
        
        ```python
        from uuid_shortener import ShortUuidGenerator
        from uuid import uuid4
        
        if __name__ == "__main__":
            print('******** Generator')
        
            uuid_gen = ShortUuidGenerator(prefix='meow', uuid=uuid4)
        
            print('Shortened uuid 1: {}'.format( uuid_gen() ))
            print('Shortened uuid 2: {}'.format( uuid_gen() ))
        ```
        
        ##### Output 3:
        
        ```
        ******** Generator
        Shortened uuid 1: meow-9ubC52uXU1MM9PcrUMaNNc
        Shortened uuid 2: meow-wqTnxvHfWzrPvREcVi5RAf
        ```
        
        ## License
        
        [MIT](./LICENSE)
        
Keywords: Python,UUID,UUID Shortener,Hex base,Short URL
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
