Metadata-Version: 1.1
Name: django-slugger
Version: 1.1.1
Summary: Automatic slug field for Django.
Home-page: https://gitlab.com/dspechnikov/django-slugger/
Author: Dmitry Pechnikov
Author-email: dspechnikov@gmail.com
License: MIT
Description: django-slugger
        ==============
        
        .. image:: https://gitlab.com/dspechnikov/django-slugger/badges/master/pipeline.svg
            :alt: build status
            :target: https://gitlab.com/dspechnikov/django-slugger/commits/master
        
        .. image:: https://gitlab.com/dspechnikov/django-slugger/badges/master/coverage.svg
            :alt: code coverage
            :target: https://gitlab.com/dspechnikov/django-slugger/commits/master
        
        .. image:: https://img.shields.io/pypi/v/django-slugger.svg
            :alt: pypi version
            :target: https://pypi.python.org/pypi/django-slugger
        
        .. image:: https://img.shields.io/pypi/l/django-slugger.svg
            :alt: license
            :target: https://opensource.org/licenses/MIT
        
        .. image:: https://img.shields.io/pypi/pyversions/django-slugger.svg
            :alt: python versions
            :target: https://www.python.org/
        
        .. image:: https://img.shields.io/badge/django-1.11,%202.0-blue.svg
            :alt: django versions
            :target: https://www.djangoproject.com/
        
        Automatic slug field for your Django models.
        
        Features
        --------
        
        * One query to rule them all. No database spam on model save.
        * Supports all standard "unique_for" field attributes like *unique_for_date*.
        * Supports model meta *unique_together*.
        * Supports custom "slugify" functions.
        
        How it works
        ------------
        
        django-slugger provides ``AutoSlugField`` which value is automatically
        generated if it is not filled manually. If the field has any "uniqueness"
        constraint (``unique=True``, for example), numerical suffix will be used if
        necessary to prevent constraint violation.
        
        If generated slug exceeds field ``max_length``, slug value will be cut to
        fit in. This does not apply to suffixed slugs. Increase ``max_length``
        attribute value or use `custom slug template`_ if you need more space to
        ensure slug uniqueness.
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install django-slugger
        
        Usage
        -----
        
        .. code-block:: python
        
            from slugger import AutoSlugField
        
            class AutoSlugModel(models.Model):
                title = models.CharField(max_length=255)
                slug = AutoSlugField(populate_from='title')
        
        Custom slug template
        ++++++++++++++++++++
        
        By default, django-slugger will use Django slugify_ function
        (combined with unidecode_ to handle non-ASCII characters). To use your own function,
        specify it in ``slugify`` argument.
        
        .. code-block:: python
        
            def custom_slugify(value):
                return 'custom-%s' % value
        
            class CustomAutoSlugModel(models.Model):
                title = models.CharField(max_length=255)
                slug = AutoSlugField(populate_from='title', slugify=custom_slugify)
        
        .. note::
        
            ``slugify`` argument must be top-level named function.
        
        .. _slugify: https://docs.djangoproject.com/en/2.0/ref/utils/#django.utils.text.slugify
        .. _unidecode: https://pypi.python.org/pypi/Unidecode
        
Keywords: django field slug auto
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
