Django DjangoViewHiearchy

• WIP: This app is still being developed and documented!
• NOTE: Presently only supports Python 3.5+ and Django 1.9+ (see issue #1)

Hierarchical view system for Python Django.

Define an arbitrary hierarchical URL structure in your urls.py, define how breadcrumbs get generated for each view, and then this package will automatically generate an urlpatterns list and breadcrumbs attached to the request object that can be easily rendered in any page, to easily link "up" the view hierarchy.

Features

• Supports both Class Based Views and simple functional views
• Auto-generates an urlpatterns for any nested URL pattern, keeping your urlpatterns more DRY instead of repeating common URL pattern elements
• Automatically generates breadcrumbs with both title and URL available as request.breadcrumbs for each node in ancestor tree
• Simple Python package: No configuration changes needed

Quick start

Overview:

1. Install django_view_hierarchy and put in requirements file
2. Using decorators or mixins, enhance some views to be "breadcrumb aware"
3. Create a view hierarchy in an urlpatterns including these views

1. Install

pip install django_view_hierarchy

2. Use decorator or mixin to add view hierarchy to views

For Class Based Views, do the following:

from django.views import View
from django_view_hierarchy.views import BreadcrumbMixin

class UserList(BreadcrumbMixin, View):
    breadcrumb = 'All users'    # Static

For more complicated examples, you may need to specify a breadcrumb that involves fetching data from the DB or giving your view a name:

For function-style views, you can do the same thing as follows:

3. Configure hierarchy in urls.py

For example, to make a set of views like:

• /users/ for a list of all users
• /users/<userid>/ for a particular user
• /users/<userid>/followers/ for a sub-page of a particular user, showing off their followers

The hierarchy can be built like:

Note that Class Based Views should not include as_view, this will be done automatically.

5. Use breadcrumbs in views and/or templates

<ul>
    {% for breadcrumb in request.breadcrumbs %}
        <li>
            <a href="{{ breadcrumb.url }}">{{ breadcrumb.title }}</a>
        </li>
    {% endfor %}
</ul>

Credits

Tools used in creating this package:

• Cookiecutter
• cookiecutter-djangopackage