Metadata-Version: 2.0
Name: django-autoslugged
Version: 2.0.0.dev0
Summary: An automated slug field for Django.
Home-page: https://github.com/mbourqui/django-autoslugged/
Author: Marc Bourqui
Author-email: pypi.kemar@bourqui.org
License: GNU Lesser General Public License (LGPL), Version 3
Download-URL: https://github.com/mbourqui/django-autoslugged/releases/tag/v2.0.0-dev0
Keywords: django field slug auto unique transliteration i18n
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Framework :: Django :: 2.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Text Processing :: General
Requires: python (>= 2.7)
Requires: django (>= 1.7.10)
Provides-Extra: cyrillic
Requires-Dist: pytils (>=0.2); extra == 'cyrillic'
Provides-Extra: translitcodec
Requires-Dist: translitcodec (>=0.3); extra == 'translitcodec'

django-autoslugged
==================

|Python| |Django| |PyPI| |image| |Build Status| |Coverage Status|

|Docs stable| |Docs latest|

Django-autoslugged is a reusable Django library that provides an
improved slug field which can automatically:

a) populate itself from another field,
b) preserve uniqueness of the value and
c) use custom slugify() functions for better i18n.

The field is highly configurable.

Requirements
============

-  `Python <https://www.python.org/>`__ >= 2.7 or PyPy
-  `Django <https://www.djangoproject.com/>`__ >= 1.8

It may be possible to successfully use django-autoslugged in other
environments but they are not tested.

    **note**

    PyPy3 is not officially supported only because there were some
    problems with permissions and \_\_pycache\_\_ on CI unrelated to
    django-autoslugged itself.

Examples
========

A simple example:

.. code:: python

    from django.db.models import CharField, Model
    from autoslugged import AutoSlugField

    class Article(Model):
        title = CharField(max_length=200)
        slug = AutoSlugField(populate_from='title')

More complex example:

.. code:: python

    from django.db.models import CharField, DateField, ForeignKey, Model
    from django.contrib.auth.models import User
    from autoslugged import AutoSlugField

    class Article(Model):
        title = CharField(max_length=200)
        pub_date = DateField(auto_now_add=True)
        author = ForeignKey(User)
        slug = AutoSlugField(populate_from=lambda instance: instance.title,
                             unique_with=['author__name', 'pub_date__month'],
                             slugify=lambda value: value.replace(' ','-'))

Documentation
=============

See the `complete
documentation <http://django-autoslug.readthedocs.org>`__ on
ReadTheDocs. It is built automatically for the latest version.

Community
=========

This application was initially created by Andy Mikhailenko and then
improved by other developers. They are listed in AUTHORS.rst.

Please feel free to file issues and/or submit patches.

See CONTRIBUTING.rst for hints related to the preferred workflow.

Since the original project
(`django-autoslug <https://github.com/neithere/django-autoslug>`__) was
not maintained anymore but I was using it in several projects, I forked
it and renamed it in order to publish a new release on PyPI.

Licensing
=========

Django-autoslugged is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 3 of the
License, or (at your option) any later version.

Django-autoslugged is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program; see the file COPYING.LESSER. If not, see `GNU
licenses <http://gnu.org/licenses/>`__.

.. |Python| image:: https://img.shields.io/badge/Python-2.7,3.4,3.5,3.6-blue.svg?style=flat-square
   :target: /
.. |Django| image:: https://img.shields.io/badge/Django-1.8,1.9,1.10,1.11,2.0-blue.svg?style=flat-square
   :target: /
.. |PyPI| image:: https://img.shields.io/pypi/v/django-autoslugged.svg?style=flat-square
   :target: https://pypi.org/project/django-autoslugged
.. |image| image:: https://img.shields.io/pypi/status/django-autoslugged.svg
   :target: https://pypi.org/project/django-autoslugged
.. |Build Status| image:: https://travis-ci.org/mbourqui/django-autoslugged.svg?branch=master
   :target: https://travis-ci.org/mbourqui/django-autoslugged
.. |Coverage Status| image:: https://coveralls.io/repos/github/mbourqui/django-autoslugged/badge.svg?branch=master
   :target: https://coveralls.io/github/mbourqui/django-autoslugged?branch=master
.. |Docs stable| image:: https://readthedocs.org/projects/django-autoslug/badge/?version=stable%0A%20:target:%20http://django-autoslug.readthedocs.org/en/stable/
.. |Docs latest| image:: https://readthedocs.org/projects/django-autoslug/badge/?version=latest%0A%20:target:%20http://django-autoslug.readthedocs.org/en/latest/


