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:

  • 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

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-2.0.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_templateengine-2.0.2.tar.gz
Algorithm Hash digest
SHA256 3171eb9f4e426b8d73937eca79d16b93c088584baffa047927eb61dc6893c046
MD5 53bb70f66203affaf7831750ce9a8e8d
BLAKE2b-256 7d0d601ab4a65660bd170e92e9833b326d9f6dbef3c935b3de44e509ff8a8321

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_templateengine-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d009869ea8c19364dabaf800572e35cd228d8c51227aa30d8d3a55bd9a5b1898
MD5 2d3f389c7f096a47911a374b1cbd0b8f
BLAKE2b-256 aeb990cc15d7bb5dbaeac31ad9bcf66e13751ecfc55f7083a5dc97799140b0ff

See more details on using hashes here.

Provenance

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