Skip to main content

An automated slug field for Django.

Project description

https://img.shields.io/coveralls/neithere/django-autoslug.svg https://img.shields.io/travis/neithere/django-autoslug.svg https://img.shields.io/pypi/format/django-autoslug.svg https://img.shields.io/pypi/status/django-autoslug.svg https://img.shields.io/pypi/v/django-autoslug.svg https://img.shields.io/pypi/pyversions/django-autoslug.svg https://img.shields.io/pypi/dd/django-autoslug.svg 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.

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

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-iplweb-1.9.4.dev0.tar.gz (20.6 kB view details)

Uploaded Source

Built Distribution

django_autoslug_iplweb-1.9.4.dev0-py2.py3-none-any.whl (14.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-autoslug-iplweb-1.9.4.dev0.tar.gz.

File metadata

File hashes

Hashes for django-autoslug-iplweb-1.9.4.dev0.tar.gz
Algorithm Hash digest
SHA256 c5a278681bd49bfd1a75f95efa396b99ec81b6eddfc8d45b9231d265d70a3b39
MD5 5415ad7dc8fe49b7fe5deaba35c87a1f
BLAKE2b-256 a28c8227cf3ef6e76681cc3d0c372142b72772a061ed9784b1d49976706de30b

See more details on using hashes here.

File details

Details for the file django_autoslug_iplweb-1.9.4.dev0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_autoslug_iplweb-1.9.4.dev0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8cce63a74f6da8151b9cb424c3878fefa20136d5a87f211644d3fcea59c42d0a
MD5 4518a31d2f4fcfc7c5bedcb0db6e9390
BLAKE2b-256 3c3d5ba5aa1afc97801a1ddd3a52d2a00541e615677c35ea7a3eed952a40be50

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