Skip to main content

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

Project description

Introduction

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:

  • filter 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

Dependencies

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..

Documentation

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

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

Contributing

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file adafruit-circuitpython-templateengine-1.0.1.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-templateengine-1.0.1.tar.gz
Algorithm Hash digest
SHA256 6e0664245847eb8f4496759db5ff2146cce5f9662007a5dbeb966c63eb33fa88
MD5 bff650f04f91ca6c34f1d07a0cb4f840
BLAKE2b-256 503a6307bd3b60cc577604a2dc4567205a0aa25a5dd86caec5a121de046e8cb3

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_templateengine-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_templateengine-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1b830a0bd7056ae1158f552c781c73c1b18dcb79ac0b340ac2c7ab4adbf3fd12
MD5 0942846de3739dda449d987c1a33add4
BLAKE2b-256 f8c67d7bae9da02c5827f2e16eef2b2eb4a3865091b47a1c9eabb5a3b68ec917

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page