jinja2-ansible-filters

What it is and what it does

This package extracts and ports Ansible's Jinja2 template filters into a standalone library, so you can use Ansible-style filtering in any Jinja2 template without installing the full Ansible framework. It includes filters for common operations: base64 encoding/decoding, file path manipulation (basename, dirname, realpath), hashing (md5, sha1, checksum), JSON and YAML conversion, regex operations, and utility filters like type checking and UUID generation. A few filters with heavy Ansible dependencies (combine, get_encrypted_password, dict2items, items2dict) are excluded, and two filters (groupby, random) are prefixed with ans_ to avoid collisions with Jinja2 builtins.

The package is a thin extension layer that registers these filters as a Jinja2 extension, so you load it by passing AnsibleCoreFiltersExtension to your Environment. It depends only on Jinja2 and PyYAML, making it lightweight to add to projects that already use those libraries. However, the project has been abandoned since 2022-06-30 with no maintenance activity, so compatibility with newer Jinja2 releases is not guaranteed beyond what was tested at version 1.3.2.

Use it for

• Use it to port Ansible playbook templates to standalone Jinja2 rendering without Ansible as a runtime dependency.
• Use it in cookiecutter templates to access Ansible-style filters for file path and data transformation during project scaffolding.
• Use it to add base64, JSON, YAML, and regex filters to Jinja2 environments in configuration management or templating pipelines.
• Use it to perform hashing and encoding operations (md5, sha1, b64encode) directly in templates without custom filter registration.
• Use it in static site generators or documentation tools that use Jinja2 and need Ansible-compatible filter semantics.

Worth the install?

AI-flagged interpretation of the facts on this page. Verify before relying on it.

Install

jinja2-ansible-filters on PyPI

Before you install

Installation is straightforward with low friction; the package has only two runtime dependencies (Jinja2 and PyYAML). However, the project is marked as abandoned with no releases since 2022-06-30, which means bug fixes and compatibility updates are unlikely.

Requires Jinja2 and PyYAML to be installed; compatibility with Jinja2 versions 3.1+ requires the environmentfilter-to-pass_environment rename, which is included in version 1.3.1+.

License in practice

The package is released under GPL3 (copyleft), which means any code that incorporates or distributes this package must also be released under compatible open-source terms. This is a significant constraint for proprietary or closed-source projects.

Quickstart

from jinja2 import Environment
from jinja2_ansible_filters import AnsibleCoreFiltersExtension

env = Environment(extensions=[AnsibleCoreFiltersExtension])
template = env.from_string('{{ "hello" | b64encode }}')
result = template.render()

Package facts

Evidence: jinja2_ansible_filters-1.3.2-py3-none-any.whl

Tags

More Text Processing packages

See also jinja2-strcase · jinja2-cli · jinjanator · jinja2-humanize-extension · jinja2_pluralize · Jinja2 · j2cli · ruamel.yaml.jinja2 · jinja-cli · jinjanator-plugins