An automated slug field for Django.
Project description
Django-autoslug is a reusable Django library that provides an improved slug field which can automatically:
populate itself from another field,
preserve uniqueness of the value and
use custom slugify() functions for better i18n.
The field is highly configurable.
Requirements
Python 3.7+ or PyPy.
Django 3.2 or higher.
It may be possible to successfully use django-autoslug in other environments but they are not tested.
Installation
python -m pip install django-autoslugExamples
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-autoslug-1.9.9.tar.gz.
File metadata
- Download URL: django-autoslug-1.9.9.tar.gz
- Upload date:
- Size: 25.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 79f88e9433c1c88d8d3f2bec60d65ca98bffaff6c072b78aa5fd99d0e84a13dd |
|
| MD5 | a4df6b60942931296f945f15d66b976e |
|
| BLAKE2b-256 | 6f6e6f454a5287127e03214dfd2df10fbd45df87674528ff73bf1fbb3536cdb4 |
File details
Details for the file django_autoslug-1.9.9-py2.py3-none-any.whl.
File metadata
- Download URL: django_autoslug-1.9.9-py2.py3-none-any.whl
- Upload date:
- Size: 14.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 81cb018944498f27f439d439687cf902212cafbdb8c74c8ca0307543a3d82907 |
|
| MD5 | 32483b8d327399209133ef6c67dc8b62 |
|
| BLAKE2b-256 | 875c37bed8c69ad42002a37ba161245342ca15f78a43c75b025ac465d696294c |
