Skip to main content

An advanced slug field with URL previews.

Project description

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

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-slug-preview-1.0.4.tar.gz (10.8 kB view details)

Uploaded Source

Built Distribution

django_slug_preview-1.0.4-py2.py3-none-any.whl (10.5 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-slug-preview-1.0.4.tar.gz.

File metadata

File hashes

Hashes for django-slug-preview-1.0.4.tar.gz
Algorithm Hash digest
SHA256 b93801bd5382837ceb397114bf6b4324a506eb2793845c4ba4c4a3f1865042d4
MD5 1ad03804816a0117f98df345ca75d64b
BLAKE2b-256 6acfa5c1f74901afa23f9ee43200840041595c039aa9be0b2b2a263cbae09866

See more details on using hashes here.

File details

Details for the file django_slug_preview-1.0.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_slug_preview-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 4dd6f3d87acf745c2c04d8e2b5e013ea830eaad66a6ae020ef487c321ca6abc7
MD5 f7e2cc2d73078a966395d28a243db229
BLAKE2b-256 e30bae30feeb4f23105925c59aea9b206368751a93d7dd430f55813919d46196

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