Welcome to django-template_tree’s documentation!¶

Contents:

django-template_tree¶

Generate diagrams showing relationships between templates in Django projects

Documentation¶

The full documentation is at https://django_template_tree.readthedocs.io.

Quickstart¶

Install django-template_tree:

pip install django_template_tree

Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'template_tree',
    ...
)

Add django-template_tree’s URL patterns:

from template_tree import urls as template_tree_urls
from django import settings
if settings.DEBUG:
    urlpatterns += [
        url(r'^__tt__/', include('template_tree.urls', namespace='template_tree')),
    ]

Features¶

Displays a collapsible tree diagram showing the hierarchy of templates used by a Django application.

Nodes can be collapsed and expanded, by clicking on them.

Apps can be filtered out of the tree, using the ‘exclude_app’ querystring parameter, thus:

http://localhost:8000/__tt__/?exclude_app=template_tree&exclude_app=admin

By default, admin is excluded, so http://localhost:8000/__tt__/ is equivalent to http://localhost:8000/__tt__/?exclude_app=admin

In order to show the admin app as well, you will need to ‘unexclude’ it thus: http://localhost:8000/__tt__/?exclude_app=

Visiting the template_tree url, requesting an application/json response will return json data compatible with d3 hierarchies, so you can roll your own diagrams.

Running Tests¶

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits¶

Tools used in rendering this package:

Installation¶

At the command line:

$ easy_install django_template_tree

Or, if you have virtualenvwrapper installed:

$ mkvirtualenv django_template_tree
$ pip install django_template_tree

Usage¶

To use django-template_tree in a project, add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'template_tree',
    ...
)

Add django-template_tree’s URL patterns:

from template_tree import urls as django_template_tree_urls


urlpatterns = [
    ...
    url(r'^__tt__/', include(django_template_tree_urls)),
    ...
]

Ideally, you should not enable this app in production, as it may reveal facts about your application that you wish to keep secret.

Visiting the URL in a browser will show a template inheritance diagram like this one:

Nodes can be collapsed (by clicking), in order to improve clarity or illustrate a particular line of inheritance.

Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions¶

Report Bugs¶

Report bugs at https://github.com/paul-butcher/django_template_tree/issues.

If you are reporting a bug, please include:

Your operating system name and version.
Any details about your local setup that might be helpful in troubleshooting.
Detailed steps to reproduce the bug.

Fix Bugs¶

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.

Implement Features¶

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

Write Documentation¶

django-template_tree could always use more documentation, whether as part of the official django-template_tree docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback¶

The best way to send feedback is to file an issue at https://github.com/paul-butcher/django_template_tree/issues.

If you are proposing a feature:

Explain in detail how it would work.
Keep the scope as narrow as possible, to make it easier to implement.
Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!¶

Ready to contribute? Here’s how to set up django_template_tree for local development.

Fork the django_template_tree repo on GitHub.

Clone your fork locally:

$ git clone git@github.com:your_name_here/django_template_tree.git

Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
```
$ mkvirtualenv django_template_tree
$ cd django_template_tree/
$ python setup.py develop
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
```
$ flake8 django_template_tree tests
$ python setup.py test
$ tox
```
To get flake8 and tox, just pip install them into your virtualenv.

Commit your changes and push your branch to GitHub:

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

The pull request should include tests.
If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/paul-butcher/django_template_tree/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_django_template_tree

Credits¶

Development Lead¶

Paul Butcher <paul.butcher@gmail.com>

Contributors¶

None yet. Why not be the first?

History¶

0.1.0 (2018-01-06)¶

First release on PyPI.