Skip to main content

django-slug-preview

An advanced slug field offering live URL previews.

This is inspired by the “Permalink” preview that WordPress offers. While not looking as fancy yet, this is a good start for Django projects. Improvements are welcome!

https://github.com/edoburu/django-slug-preview/raw/master/docs/images/slugpreview1.png

Installation

First install the module, preferably in a virtual environment. It can be installed from PyPI:

pip install django-slug-preview

Or the current folder can be installed for development:

pip install -e .

Add slug_preview to your INSTALLED_APPS:

INSTALLED_APPS += (
    'slug_preview',
)

Usage

  • Use slug_preview.models.SlugPreviewField in your models instead of the standard models.SlugField.

  • Add slug_preview.forms.SlugPreviewFormMixin in your forms.

For example:

from django.db import models
from slug_preview.models import SlugPreviewField

class MyModel(models.Model):
    slug = SlugPreviewField(_("Slug"))

In the admin you can use the SlugPreviewModelForm shortcut:

from django.contrib import admin
from django import forms
from slug_preview.forms import SlugPreviewModelForm

@admin.register(MyModel)
class MyModelAdmin(admin.ModelAdmin):
    form = SlugPreviewModelForm

In custom forms, use SlugPreviewFormMixin directly:

from django import forms
from slug_preview.forms import SlugPreviewFormMixin
from .models import MyModel

class MyModelForm(SlugPreviewFormMixin, forms.ModelForm):
    class Meta:
        model = MyModel

Special model URLS

When a model has a custom URL layout (not just /{slug}/), you can add a get_absolute_url_format() method in the model. For example:

from django.db import models
from slug_preview.models import SlugPreviewField

class Page(models.Model):
    parent = models.ForeignKey('self')
    slug = SlugPreviewField(_("Slug"))
    # ...


    def get_absolute_url(self):
        if self.parent_id:
            return "{0}{1}/".format(self.parent.get_absolute_url(), self.slug)
        else:
            return "/{0}/".format(self.slug)

    def get_absolute_url_format(self):
        if self.parent_id:
            return "{0}{{slug}}/".format(self.parent.get_absolute_url())
        else:
            return "/{slug}/"

For a blog, you can add the /blog/{year}/{month}/ format too:

from django.core.urlresolvers import reverse
from django.db import models
from django.utils.timezone import now
from slug_preview.models import SlugPreviewField

class Article(models.Model):
    slug = SlugPreviewField(_("Slug"))
    pubdate = models.DateTimeField(default=now)
    # ...

    def get_absolute_url(self):
        root = reverse('article_list')
        return "{root}/{year}/{month}/{slug}/".format(
            root=reverse('article_list').rstrip('/'),
            year=self.pubdate.strftime('%Y'),
            monthy=self.pubdate.strftime('%M'),
            slug=self.slug
        )

    def get_absolute_url_format(self):
        root = reverse('article_list')
        pubdate = self.pubdate or now()
        return "{root}/{year}/{month}/{{slug}}/".format(
            root=reverse('article_list').rstrip('/'),
            year=pubdate.strftime('%Y'),
            monthy=pubdate.strftime('%M'),
        )

Improving this package

This module is designed to be usable for other projects too. In case there is anything you didn’t like about it, or think it’s not flexible enough, please let us know. We’d love to improve it! Pull requests are welcome too. :-)

Release files for django-slug-preview 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-slug-preview 2.0.1
File Size Uploaded
django-slug-preview-2.0.1.tar.gz 11.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for django-slug-preview 2.0.1
File Interpreter ABI Platform
django_slug_preview-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 23.6 kB

Release files / django-slug-preview-2.0.1.tar.gz

Download URL django-slug-preview-2.0.1.tar.gz
Size 11.1 kB
Tags Source
SHA-256 checksum
How to use checksums
54967848101ffd241321e3373b4675d98a40e683c0c54b7d7efbfb2c653d2bf9
BLAKE2b-256 checksum
How to use checksums
90ca8c80606da33dcb8b0658f8b139ee3dacc618a889d881c88229bd92b75088
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

Release files / django_slug_preview-2.0.1-py3-none-any.whl

Download URL django_slug_preview-2.0.1-py3-none-any.whl
Size 12.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
87e69df096534be417f9f5296d1a8d256bc6eeac608ada899920ff9c751ba57f
BLAKE2b-256 checksum
How to use checksums
359dcb76d4cd8c520c1523e3b512a7f248182c96f42e0b4709585c7a8eaa58f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.6

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 release files

2.0

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0

2 release files

0.9

2 release files

0.9.dev0

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page