Skip to main content

An automated slug field for Django.

Project description

Django-autoslug is a reusable Django application 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.

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 complete HTML documentation for details. Sometimes it may get slightly outdated. You can always have the latest snapsnot by building it from the source (using Sphinx).

Community

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

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

See CONTRIBUTING 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.

Project details


Download files

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

Source Distribution

django-autoslug-1.6.0.tar.gz (9.8 kB view details)

Uploaded Source

File details

Details for the file django-autoslug-1.6.0.tar.gz.

File metadata

File hashes

Hashes for django-autoslug-1.6.0.tar.gz
Algorithm Hash digest
SHA256 8fb028d80879598bbcd629e9f4c1c01c8c76caf2d8e6f9b1d02d7e50372b82a6
MD5 2457dc89460a4af27305087f1d44f6b6
BLAKE2b-256 365875ef6ece84e2e71cb3fa4705415792bcb8ef11e530107f80442b27aba3fa

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page