Skip to content
AutoSlugField for Django. Supports (but not does not require) unidecode/pytils for transliteration. Old issue tracker is at Bitbucket: https://bitbucket.org/neithere/django-autoslug/issues
Python Shell
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autoslug Release django-autoslug 1.9.6 Jul 30, 2019
docs Now really fix that bug! (And bump version.) Oct 12, 2015
requirements Handle timezones for datetime fields Jul 30, 2019
.gitignore Added manager_name feature Oct 15, 2015
.hgignore Add tox. Support Python 3.3. Drop support for Python 2.4. Drop previo… Jul 1, 2013
.hgtags Added tag 1.7.0 for changeset 4c3ca8be0408 Jul 1, 2013
.travis.yml Limit before_deploy & deploy stages to Python 3.7 Jul 28, 2019
AUTHORS.rst Handle timezones for datetime fields Jul 30, 2019
CHANGELOG.rst Release django-autoslug 1.9.6 Jul 30, 2019
CONTRIBUTING.rst Add `pyproject.toml` file and AutoPub support Jul 28, 2019
COPYING.LESSER Rename package autoslugfield to autoslug. Update distutils and licens… May 15, 2009
MANIFEST.in Add license to sdist and wheels (#56) Jul 28, 2019
README.rst Fix Travis badge links in README Jan 29, 2019
_version_helper.py ...still trying to fix RTFD... Oct 11, 2015
pyproject.toml Release django-autoslug 1.9.6 Jul 30, 2019
run_tests.py Skip failing tests (1 exfail, some PyPy-related) Oct 11, 2015
runcover.sh Add a simple script to view test coverage Oct 11, 2015
setup.cfg
setup.py Update URLs and maintainer info in setup.py Jan 29, 2019
tox.ini Add Python 3.6 & 3.7 to Tox test environment list Jan 29, 2019

README.rst

django-autoslug

https://readthedocs.org/projects/django-autoslug/badge/?version=stable https://readthedocs.org/projects/django-autoslug/badge/?version=latest

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

  1. populate itself from another field,
  2. preserve uniqueness of the value and
  3. use custom slugify() functions for better i18n.

The field is highly configurable.

Requirements

Python 2.7, 3.5+, or PyPy.

Django 1.7.10 or higher.

It may be possible to successfully use django-autoslug 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-autoslug itself.

Examples

A simple example:

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

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

More complex example:

from django.db.models import CharField, DateField, ForeignKey, Model
from django.contrib.auth.models import User
from autoslug 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 on ReadTheDocs. It is built automatically for the latest version.

Community

This application is maintained by Justin Mayer. It 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.

Licensing

Django-autoslug 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-autoslug 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.

You can’t perform that action at this time.