Metadata-Version: 1.0
Name: Flask-ShortUrl
Version: 0.1.1
Summary: Short URL generaotr for Flask
Home-page: https://github.com/lepture/flask-shorturl
Author: Hsiaoming Yang
Author-email: me@lepture.com
License: Copyright (c) 2013, Hsiaoming Yang

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 the creator 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 HOLDER 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.

Description: Flask-ShortUrl
        ==================================
        
        .. image:: https://travis-ci.org/lepture/flask-shorturl.png?branch=master
                :target: https://travis-ci.org/lepture/flask-shorturl
        .. image:: https://coveralls.io/repos/lepture/flask-shorturl/badge.png?branch=master
                :target: https://coveralls.io/r/lepture/flask-shorturl
        
        
        Short URL generator for Flask Project.
        
        
        Installation
        ------------
        
        To install Flask-Shorturl, simply::
        
            $ pip install Flask-ShortUrl
        
        Or alternatively if you don't have pip::
        
            $ easy_install Flask-ShortUrl
        
        
        Usage
        -----
        
        You can initialize the app::
        
            from flask_shorturl import ShortUrl
        
            su = ShortUrl(app)
        
            url = su.encode_url(12)
            uid = su.decode_url(url)
        
        You may also init the app later::
        
            su = ShortUrl()
            su.init_app(app)
        
        
        Configuration
        --------------
        
        Configurations for Flask project:
        
        
        ======================   =====================================================
        `SHORT_URL_ALPHABET`     The alphabet to be used by Encoder,
                                 default value: ``mn6j2c4rv8bpygw95z7hsdaetxuk3fq``
        `SHORT_URL_MIN_LENGTH`   default value: 5
        `SHORT_URL_BLOCK_SIZE`   default value: 24
        ======================   =====================================================
        
        
        Thanks
        ------
        
        UrlEncoder from by `Michael Fogleman`_.
        
        .. _`Michael Fogleman`: http://code.activestate.com/recipes/576918/
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
