django-slugify-processor

Custom slug processors for Django's slugify().

Why

Django's slugifier is intentionally generic. That means terms such as C++ and C# both collapse to c, which can produce duplicate or unhelpful slugs. django-slugify-processor lets a project run its own small processors before Django performs the final slugification step.

With no SLUGIFY_PROCESSORS setting, the package behaves like Django's slugify().

Install

$ python -m pip install django-slugify-processor

$ uv add django-slugify-processor

Configure

Create a processor that accepts a string and returns a string:

def slugify_programming_languages(value: str) -> str:
    return value.replace("C++", "Cpp").replace("C#", "CSharp")

Register the processor's import string in Django settings:

SLUGIFY_PROCESSORS = [
    "myapp.slugify_processors.slugify_programming_languages",
]

Processors run in list order. The result then passes through Django's own slugify(), including its allow_unicode handling.

Use

Use the Python helper anywhere you would use Django's slugifier:

from django_slugify_processor.text import slugify

slugify("C++ Programming")  # "cpp-programming"

Load the template filter in a template that needs the same pipeline:

{% load slugify_processor %}
{{ "C++ Programming"|slugify }}

For projects that want every template to use this filter, install it as a template builtin:

TEMPLATES = [
    {
        "BACKEND": "django.template.backends.django.DjangoTemplates",
        "OPTIONS": {
            "builtins": [
                "django_slugify_processor.templatetags.slugify_processor",
            ],
        },
    },
]

Model-field packages usually accept a slugify callback. For django-extensions:

from django.db import models
from django_extensions.db.fields import AutoSlugField
from django_slugify_processor.text import slugify


class Article(models.Model):
    title = models.CharField(max_length=255)
    slug = AutoSlugField(populate_from="title", slugify_function=slugify)

For django-autoslug, pass the same function to its slugify option.

Links

• Documentation: https://django-slugify-processor.git-pull.com
• API reference: https://django-slugify-processor.git-pull.com/api.html
• Changelog: https://django-slugify-processor.git-pull.com/history.html
• Source: https://github.com/tony/django-slugify-processor
• Issues: https://github.com/tony/django-slugify-processor/issues
• PyPI: https://pypi.org/project/django-slugify-processor/

Development

$ git clone https://github.com/tony/django-slugify-processor.git

$ cd django-slugify-processor

$ uv sync --all-extras --dev

$ just test