https://github.com/peopledoc/django-templates-forest

Django commands to help you inspect your templates' structure
https://github.com/peopledoc/django-templates-forest

approved-public ghec-mig-migrated

Last synced: 2 months ago
JSON representation

Django commands to help you inspect your templates' structure

• Host: GitHub
• URL: https://github.com/peopledoc/django-templates-forest
• Owner: peopledoc
• Created: 2018-02-06T10:08:57.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-06T15:20:59.000Z (over 7 years ago)
• Last Synced: 2025-03-22T20:38:26.192Z (3 months ago)
• Topics: approved-public, ghec-mig-migrated
• Language: Python
• Size: 60.5 KB
• Stars: 3
• Watchers: 14
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md

Awesome Lists containing this project

README

        
# Django Templates Forest (BETA)

Templates Forest is just a series of django commands that might help you

visualize your templates' inheritance and will give you some detailed

information about them so you could clean your template's structure

## Install

1. Add ``templates-forest`` to your requirements (and install it, via pip or something)

2. Add ``templates_forest`` to your ``INSTALLED_APPS``

3. Add ``APPLICATION_DIR`` to your settings. This is the path to your app

# How to use

There are currently three django commands and they all have the same common

parameters.

## Common parameters

- ``--quiet`` Will ignore the warnings and problems found when parsing the

  templates

- ``--include-packages`` If added, it will not only parse the templates on

  `APPLICATION_DIR` but also the installed packages (``INSTALLED_APPS``)

- ``--vars`` You can pass some variables that will be used in the template's

  context, for example when you use dynamic inheritance e.g.:

    ``{% extends my_var %}``

  you can call the command using: ``--vars my_var=foo.html``.

  For boolean variables you can pass ``True`` or ``False`` values, for example ``--vars my_var=False``

  It also works if the variable in the template is an attribute of an object: ``--vars foo.bar.aze=base.html``  

## templates_trees

Displays a list of trees found. For each tree we display the top template to

select which tree to display.

Next to each tree root we have the ``height`` of the three (the number of edges on the longest downward path between the root and a leaf)

![Templates_trees command example](screenshots/templates_trees.png "Example of the templates_tree command result")

## template_info ````

Displays the information for a single template: His position inside a tree,

all the templates included inside this template, and the list of templates that include this template:

![template_info command example](screenshots/template_info.png "Example of the template_info command result")

## templates_check

Using the template trees it will display a list of templates that we only

included once ("useless include") and the orphan templates that were never

included and that can't be found on the python files in ``APPLICATION_DIR``

![templates_check command example](screenshots/templates_check.png "Example of the templates_check command result")