marcanuy/django-slugs-example-app

A basic app to show how to add slugs to models

django-slugs-example-app

A basic app to show how to generate slugs based in a model's field.

This app shows the concepts explained at: https://simpleit.rocks/python/django/generating-slugs-automatically-in-django-easy-solid-approaches/

Demo: https://django-slugs-example-app.herokuapp.com/ (db reset daily)

Installation

python3 -m venv ~/.virtualenvs/django-slugs-example-app
source ~/.virtualenvs/django-slugs-example-app/bin/activate
pip install -r requirements.txt
./manage.py migrate

Run example site: ./manage.py runserver.

Models

URLs

/	blog.views.ComparatorListView	article-list
/blog/<int:pk>-<str:slug>/	blog.views.ArticlePkAndSlugDetailView	article-pk-slug-detail
/blog/<str:slug>	blog.views.ArticleUniqueSlugDetailView	articleunique-slug
/blog/create	blog.views.ComparatorFormView	article-create

django-slugs-example-app's Issues

avoid regenerating slug on each save with unique approach

https://twitter.com/LukeMartinVideo/status/1157220245523902470

Possible bug if title length is greater than max_length

If self.title is 99 characters or longer then, if it's necessary to append "-i", won't this cause the slug to be longer than SlugField max length of 100? Also max_length is defined but not used

class ArticleUniqueSlug(Article):

    slug = models.SlugField(default="", editable=False, max_length=100)  # random length

    def get_absolute_url(self):
        kwargs = {"slug": self.slug}
        return reverse("articleunique-slug", kwargs=kwargs)

    def _generate_slug(self):
        max_length = self._meta.get_field("slug").max_length
        value = self.title
        slug_candidate = slug_original = slugify(value, allow_unicode=True)
        for i in itertools.count(1):
            if not ArticleUniqueSlug.objects.filter(slug=slug_candidate).exists():
                break
            slug_candidate = "{}-{}".format(slug_original, i)

        self.slug = slug_candidate