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 the AUTHORS file.

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

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.3.3.tar.gz (8.0 kB view details)

Uploaded Source

Built Distribution

django-autoslug-1.3.3.linux-x86_64.tar.gz (11.6 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for django-autoslug-1.3.3.tar.gz
Algorithm Hash digest
SHA256 7d618ad0838407d760bedf40c794db01cedfa2774767867534e514790de10fb8
MD5 5be5669120c0a42555052f81ad6f2c97
BLAKE2b-256 81128dce40261c32cf623e0f89badfcb0eeaa2ccaefe446c4d07481bcf32d106

See more details on using hashes here.

File details

Details for the file django-autoslug-1.3.3.linux-x86_64.tar.gz.

File metadata

File hashes

Hashes for django-autoslug-1.3.3.linux-x86_64.tar.gz
Algorithm Hash digest
SHA256 3cf5ab094183e1faf2e7260aa520d88f22fa327a81112372fbf25935d63c268b
MD5 13a1b16966313b809b3215864c5a8269
BLAKE2b-256 113605c4736641b1fe04c48cb06a01c8d7e789abe14d7bd569f8379d5c5fc6ad

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