Skip to main content

An automated slug field for Django.

Project description


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:

  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.


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


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


A simple example:

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:

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(' ','-'))


See the complete documentation on ReadTheDocs. It is built automatically for the latest version.


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) 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.


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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_autoslugged-2.0.0.dev0-py2.py3-none-any.whl (15.0 kB) Copy SHA256 hash SHA256 Wheel py2.py3
django-autoslugged-2.0.0.dev0.tar.gz (21.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page