Documentation Status Discord Build Status Code Style: Black

Templating engine to substitute variables into a template string. Templates can also include conditional logic and loops. Often used for web pages.

Library is highly inspired by the Jinja2 and Django Templates, but it does not implement all of their features and takes a different approach to some of them.

Main diffrences from Jinja2 and Django Templates:

  • filters are not supported, and there is no plan to support them

  • all variables passed inside context must be accessed using the context object

  • you can call methods inside templates just like in Python

  • no support for nested blocks, although inheritance is supported

  • no support for custom tags


This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-templateengine

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-templateengine

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .env/bin/activate
pip3 install adafruit-circuitpython-templateengine

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install adafruit_templateengine

Or the following command to update an existing version:

circup update

Usage Example

See the simpletest for an example of how to use it..


API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.


Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Table of Contents

Indices and tables