adafruit-circuitpython-templateengine


Nameadafruit-circuitpython-templateengine JSON
Version 2.0.2 PyPI version JSON
download
home_pageNone
SummaryTemplating engine to substitute variables into a template string. Templates can also include conditional logic and loops. Often used for web pages.
upload_time2024-11-02 22:18:21
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython templateengine template string substitution web html escaping syntax
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-template-engine/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/templateengine/en/latest/
    :alt: Documentation Status


.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
    :target: https://adafru.it/discord
    :alt: Discord


.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/actions
    :alt: Build Status


.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/psf/black
    :alt: 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 <https://jinja.palletsprojects.com/en/3.1.x/templates/>`_
and `Django Templates <https://docs.djangoproject.com/en/4.2/ref/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:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.



Installing from PyPI
=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-templateengine/>`_.
To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-templateengine

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-templateengine

To install in a virtual environment in your current project:

.. code-block:: shell

    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:

.. code-block:: shell

    pip3 install circup

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

.. code-block:: shell

    circup install adafruit_templateengine

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example
=============

`See the simpletest for an example of how to use it. <examples/templateengine_simpletest>`_.

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/templateengine/en/latest/>`_.

For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-templateengine",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, templateengine, template, string, substitution, web, html, escaping, syntax",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/7d/0d/601ab4a65660bd170e92e9833b326d9f6dbef3c935b3de44e509ff8a8321/adafruit_circuitpython_templateengine-2.0.2.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-template-engine/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/templateengine/en/latest/\n    :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n    :target: https://adafru.it/discord\n    :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/actions\n    :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n    :target: https://github.com/psf/black\n    :alt: Code Style: Black\n\nTemplating engine to substitute variables into a template string. Templates can also include conditional logic and loops. Often used for web pages.\n\nLibrary is highly inspired by the\n`Jinja2 <https://jinja.palletsprojects.com/en/3.1.x/templates/>`_\nand `Django Templates <https://docs.djangoproject.com/en/4.2/ref/templates/>`_,\nbut it does not implement all of their features and takes a different approach to some of them.\n\nMain diffrences from Jinja2 and Django Templates:\n\n- filters are not supported, and there is no plan to support them\n- all variables passed inside context must be accessed using the ``context`` object\n- you can call methods inside templates just like in Python\n- no support for nested blocks, although inheritance is supported\n- no support for custom tags\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-templateengine/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-templateengine\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-templateengine\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n    mkdir project-name && cd project-name\n    python3 -m venv .venv\n    source .env/bin/activate\n    pip3 install adafruit-circuitpython-templateengine\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n    pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n    circup install adafruit_templateengine\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n    circup update\n\nUsage Example\n=============\n\n`See the simpletest for an example of how to use it. <examples/templateengine_simpletest>`_.\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/templateengine/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Templating engine to substitute variables into a template string. Templates can also include conditional logic and loops. Often used for web pages.",
    "version": "2.0.2",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TemplateEngine"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " templateengine",
        " template",
        " string",
        " substitution",
        " web",
        " html",
        " escaping",
        " syntax"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aeb990cc15d7bb5dbaeac31ad9bcf66e13751ecfc55f7083a5dc97799140b0ff",
                "md5": "2d3f389c7f096a47911a374b1cbd0b8f",
                "sha256": "d009869ea8c19364dabaf800572e35cd228d8c51227aa30d8d3a55bd9a5b1898"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_templateengine-2.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2d3f389c7f096a47911a374b1cbd0b8f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 10553,
            "upload_time": "2024-11-02T22:18:20",
            "upload_time_iso_8601": "2024-11-02T22:18:20.477214Z",
            "url": "https://files.pythonhosted.org/packages/ae/b9/90cc15d7bb5dbaeac31ad9bcf66e13751ecfc55f7083a5dc97799140b0ff/adafruit_circuitpython_templateengine-2.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7d0d601ab4a65660bd170e92e9833b326d9f6dbef3c935b3de44e509ff8a8321",
                "md5": "53bb70f66203affaf7831750ce9a8e8d",
                "sha256": "3171eb9f4e426b8d73937eca79d16b93c088584baffa047927eb61dc6893c046"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_templateengine-2.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "53bb70f66203affaf7831750ce9a8e8d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 37146,
            "upload_time": "2024-11-02T22:18:21",
            "upload_time_iso_8601": "2024-11-02T22:18:21.731342Z",
            "url": "https://files.pythonhosted.org/packages/7d/0d/601ab4a65660bd170e92e9833b326d9f6dbef3c935b3de44e509ff8a8321/adafruit_circuitpython_templateengine-2.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-02 22:18:21",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_TemplateEngine",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-templateengine"
}
        
Elapsed time: 0.41720s