django-template-check

Perform (minimal) syntax checks for Django templates.


Keywords
django, templates, syntax, check
License
CC0-1.0
Install
pip install django-template-check==0.4.0

Documentation

django-template-check travis

This package makes it possible to easily check for basic syntax errors in all loaded Django templates. This can be useful as part of a continuous integration step in a build process, so as not to discover these problems at runtime.

Currently, checking is very minimal, simply relying on the exceptions raised by Django's compile and render template pipeline. Furthermore, only the default Django template backend is tested and supported.

Requirements

This package requires Django version 1.8 or greater, and has been tested with 2.2 and 3.0

Installation

Simply get the package from pip:

pip install django-template-check

Then make sure to add django_template_check to your INSTALLED_APPS in your settings.py. It also requires the BASE_DIR setting to exist in your settings.py, which should be present if you used the Django startproject template.

Usage

After installing this package, simply use it by calling the management command:

python manage.py templatecheck

Optionally, only check templates that live inside the project directory by specifying the --project-only flag. This can be useful to ignore errors in 3rd party dependencies.

License

All included code is available under the CC0 1.0 Universal Public Domain Dedication.