Skip to main content

Django reusable application for content categorization.

Project description

https://github.com/idlesign/django-sitecats

https://img.shields.io/pypi/v/django-sitecats.svg https://img.shields.io/pypi/l/django-sitecats.svg https://img.shields.io/coveralls/idlesign/django-sitecats/master.svg

Description

Django reusable application for content categorization.

Nay, - you say, - all that tags business lacks structuring.

This application is just about structuring your data: build categories hierarchy and link your site entities to those categories.

# Somewhere in views.py
from django.shortcuts import render, get_object_or_404

# Suppose Article model has sitecats.models.ModelWithCategory class mixed in.
from .models import Article


def article_details(self, request, article_id):
    """See, there is nothing special in this view, yet it'll render a page with categories for the article."""
    return self.render(request, 'article.html', {'article': get_object_or_404(Article, pk=article_id)})

def article_edit(self, request, article_id):
    """Let's allow this view to render and handle categories editor."""
    article = get_object_or_404(Article, pk=article_id)

    # Now we enable category editor for an article, and allow users
    # to add subcategories to `language`, and `os` categories
    # (suppose we created them beforehand with Admin contrib),
    # and link this article to them.
    article.enable_category_lists_editor(
        request,
        editor_init_kwargs={'allow_new': True},
        additional_parents_aliases=['language', 'os']
    )

    form = ... # Your usual Article edit handling code will be here.

    return render(request, 'article.html', {'article': article, 'form': form})

Template coding basically boils down to sitecats_categories template tags usage:

<!-- The same html is just fine for demonstration purposes for both our views.
     Do not forget to load `sitecats` template tags library. -->
{% extends "base.html" %}
{% load sitecats %}

{% block contents %}
    <!-- Some additional functionality (e.g. categories cloud rendering,
         editor enhancements) will require JS. -->
    <script src="{{ STATIC_URL }}js/sitecats/sitecats.min.js"></script>

    <h1>{{ article.title }}</h1>
    <div id="article_categories">
        {% sitecats_categories from article %} <!-- And that's it. -->
    </div>
    <!-- Form code goes somewhere here. -->
{% endblock %}

Read the docs, sitecats can do more.

Documentation

https://django-sitecats.readthedocs.org/

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-sitecats-1.2.2.tar.gz (37.6 kB view details)

Uploaded Source

Built Distribution

django_sitecats-1.2.2-py2.py3-none-any.whl (36.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-sitecats-1.2.2.tar.gz.

File metadata

  • Download URL: django-sitecats-1.2.2.tar.gz
  • Upload date:
  • Size: 37.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/2.7

File hashes

Hashes for django-sitecats-1.2.2.tar.gz
Algorithm Hash digest
SHA256 7e722d4d5527a2d04a7fdffb7e3bc3e95cda6569c9f4e4a042a3b98807ab0c96
MD5 485c558957c14fd296e0a353fbb17f5b
BLAKE2b-256 21b3730b8834211b77e92a9bb7455fcef480f99fcf77c75f8a7255641e396194

See more details on using hashes here.

File details

Details for the file django_sitecats-1.2.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_sitecats-1.2.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 af495258369cca8adba857d2cf47bec6d3e0d2af61e268ba57cdbd069e6f0f02
MD5 2161248ce6a690d9ce871405f5e4ff24
BLAKE2b-256 229a3f5f69666846f01168c8a309855ec0a1e6459bd1ca5587335eaaac27db14

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