Metadata-Version: 1.1
Name: django-urlbrevity
Version: 0.1.0
Summary: UNKNOWN
Home-page: UNKNOWN
Author: Keryn Knight
Author-email: python-package@kerynknight.com
License: BSD License
Description: ===========
        URL Brevity
        ===========
        
        Another short-URL generator, based on `Hashids`_ and a reduced alphabet.
        
        .. image:: https://travis-ci.org/kezabelle/django-urlbrevity.svg?branch=master
            :target: https://travis-ci.org/kezabelle/django-urlbrevity
        
        
        Why a reduced alphabet?
        -----------------------
        
        Because if you're going to bother with a short URL, it needs to be readable
        and easily audible, without constantly double-checking you've not misread or
        misheard.
        
        Why `Hashids`_
        --------------
        
        Because assuming your model primary keys are integers, it's a dirt simple way
        of encoding a tuple in a reasonably small space. One could also just use
        ``django.utils.http.int_to_base36`` of course.
        
        Usage
        -----
        
        in your settings module::
        
            INSTALLED_APPS = (
                # ...
                'urlbrevity',
                # ...
            )
        
        in your root urlconf::
        
            from django.conf.urls import patterns, url, include
            import urlbrevity
        
            urlpatterns = patterns("",
                # ...
                url(r'redirect/', include(urlbrevity.redirects)),
                # Or if you don't want to redirect ...
                url(r'no_redirect/', include(urlbrevity.no_redirects)),
                # ...
            )
        
        .. note:: You obviously don't have to use `redirect` and `no_redirect` as the
                  url prefixes, and you should only use one or the other, really.
        
        in your templates::
        
            {% load urlbrevity %}
            <a href="{% url 'urlbrevity:short' my_model_instance|hashid %}">...</a>
            or ...
            <a href="{{ my_model_instance|short_url }}">
        
        in your python::
        
            import urlbrevity
            obj = MyModel.objects.get(pk='...')
            encoded = urlbrevity.encode_model_instance(obj=obj)
            value = encoded.hash
            url = reverse('urlbrevity:short', kwargs={'encoded_value': value})
            # or ...
            url2 = urlbrevity.short_url(obj)
        
            # to re-inflate ...
            obj_again = urlbrevity.decode_model_instance(value)
        
        
        
        Why internal redirects?
        -----------------------
        
        Because mobile is an important space, and even on 3G+ connections, redirects
        are another round-trip that may fail or be slow. Easier to just render the
        intended output if possible.
        
        .. note:: You can use 301 (permanent) redirects if you prefer, by including
                  ``urlbrevity.redirects`` instead of ``urlbrevity.no_redirects``, you
                  can also stitch together your own stuff based on the existing
                  views and named URLconfs.
        
        
        .. _Hashids: http://hashids.org/python/
        
        
        ----
        
        License
        -------
        
        ``django-urlbrevity`` is available under the terms of the
        Simplified BSD License (alternatively known as the FreeBSD License, or
        the 2-clause License)::
        
            Copyright (c) 2014, Keryn Knight
            All rights reserved.
        
            Redistribution and use in source and binary forms, with or without
            modification, are permitted provided that the following conditions are met:
        
            1. Redistributions of source code must retain the above copyright notice, this
               list of conditions and the following disclaimer.
            2. 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.
        
            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.
        
            The views and conclusions contained in the software and documentation are those
            of the authors and should not be interpreted as representing official policies,
            either expressed or implied, of the FreeBSD Project.
        
Keywords: django shortURLs
Platform: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Natural Language :: English
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: License :: OSI Approved :: BSD License
