{"author":null,"author_email":"James Prior ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy"],"description":"

Python Liquid

\n\n

\nPython Liquid is a Python engine for Liquid, the safe, customer-facing template language.\n
\nWe follow Shopify/Liquid closely and test against the Golden Liquid test suite.\n

\n \n $\"PyPi$ \n \n \n $\"conda-forge\"$ \n \n \n $\"Python$ \n \n
\n \n $\"Tests\"$ \n \n \n $\"Coverage\"$ \n \n
\n \n $\"PyPI$ \n \n
\n \n $\"License\"$ \n \n

\n\n---\n\n**Table of Contents**\n\n- [Install](#install)\n- [Links](#links)\n- [Related Projects](#related-projects)\n- [Quick Start](#example)\n- [Contributing](#contributing)\n\n## Install\n\nInstall Python Liquid using [Pipenv](https://pipenv.pypa.io/en/latest/):\n\n```shell\n$ pipenv install -u python-liquid\n```\n\nOr [pip](https://pip.pypa.io/en/stable/getting-started/):\n\n```shell\n$ pip install python-liquid\n```\n\nOr from [conda-forge](https://anaconda.org/conda-forge/python-liquid):\n\n```shell\n$ conda install -c conda-forge python-liquid\n```\n\n## Links\n\n- Documentation: https://jg-rp.github.io/liquid/\n- Documentation for Python Liquid version 1.x: https://jg-rp.github.io/python-liquid-docs-archive/\n- Change Log: https://github.com/jg-rp/liquid/blob/main/CHANGES.md\n- PyPi: https://pypi.org/project/python-liquid/\n- Source Code: https://github.com/jg-rp/liquid\n- Issue Tracker: https://github.com/jg-rp/liquid/issues\n\n## Related Projects\n\n- [Python Liquid2](https://github.com/jg-rp/python-liquid2): A new Python engine for Liquid with [extra features](https://jg-rp.github.io/python-liquid2/migration/#new-features).\n- [Ruby Liquid2](https://github.com/jg-rp/ruby-liquid2): Liquid2 templates for Ruby.\n- [LiquidScript](https://github.com/jg-rp/liquidscript): A JavaScript engine for Liquid with a similar high-level API to Python Liquid.\n\n## Quick Start\n\n### `render()`\n\nThis example renders a template from a string of text with the package-level `render()` function. The template has just one placeholder variable `you`, which we've given the value `\"World\"`.\n\n```python\nfrom liquid import render\n\nprint(render(\"Hello, {{ you }}!\", you=\"World\"))\n# Hello, World!\n```\n\n### `parse()`\n\nOften you'll want to render the same template several times with different variables. We can parse source text without immediately rendering it using the `parse()` function. `parse()` returns a `BoundTemplate` instance with a `render()` method.\n\n```python\nfrom liquid import parse\n\ntemplate = parse(\"Hello, {{ you }}!\")\nprint(template.render(you=\"World\")) # Hello, World!\nprint(template.render(you=\"Liquid\")) # Hello, Liquid!\n```\n\n### Configure\n\nBoth `parse()` and `render()` are convenience functions that use the default Liquid environment. For all but the simplest cases, you'll want to configure an instance of `Environment`, then load and render templates from that.\n\n```python\nfrom liquid import CachingFileSystemLoader\nfrom liquid import Environment\n\nenv = Environment(\n autoescape=True,\n loader=CachingFileSystemLoader(\"./templates\"),\n)\n```\n\nThen, using `env.parse()` or `env.get_template()`, we can create a `BoundTemplate` from a string or read from the file system, respectively.\n\n```python\n# ... continued from above\ntemplate = env.parse(\"Hello, {{ you }}!\")\nprint(template.render(you=\"World\")) # Hello, World!\n\n# Try to load \"./templates/index.html\"\nanother_template = env.get_template(\"index.html\")\ndata = {\"some\": {\"thing\": [1, 2, 3]}}\nresult = another_template.render(**data)\n```\n\nUnless you happen to have a relative folder called `templates` with a file called `index.html` within it, we would expect a `TemplateNotFoundError` to be raised when running the example above.\n\n## Contributing\n\nPlease see [Contributing to Python Liquid](https://github.com/jg-rp/liquid/blob/main/contributing.md).\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":null,"license":null,"license_expression":"MIT","license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"python-liquid","package_url":"https://pypi.org/project/python-liquid/","platform":null,"project_url":"https://pypi.org/project/python-liquid/","project_urls":{"Change Log":"https://github.com/jg-rp/liquid/blob/main/CHANGES.md","Documentation":"https://jg-rp.github.io/liquid/","Homepage":"https://jg-rp.github.io/liquid/","Issue Tracker":"https://github.com/jg-rp/liquid/issues","Source Code":"https://github.com/jg-rp/liquid"},"provides_extra":null,"release_url":"https://pypi.org/project/python-liquid/2.0.2/","requires_dist":["babel>=2","markupsafe>=3","python-dateutil>=2.8.1","pytz"],"requires_python":">=3.7","summary":"A Python engine for the Liquid template language.","version":"2.0.2","yanked":false,"yanked_reason":null}

Dependencies of python-liquid (4).
Dependency	Optional
babel	false
markupsafe	false
python-dateutil	false
pytz	false

Package search

python-liquid

project_urls

Dependencies

All package metadata

Releases