Welcome to jinja2-shell documentation!

Installation & Usage

• Installation
• Usage

Project Info

• Changelog
  • v0.1.3 (2024-01-11)
  • v0.1.2 (2023-02-21)
  • v0.1.1 (2023-02-21)
  • v0.1.0 (2023-02-21)
• Contributing
  • Types of Contributions
  • Get Started!
  • Pull Request Guidelines
  • Tips
  • Making a new release

API Reference

• jinja2_shell package
  • ShellExtension

jinja2-shell

Jinja2 Extension for running shell commands. Makes use of subprocess.run(shell=False).

Installation

Install this via pip (or your favourite package manager):

pip install jinja2-shell

Usage

The extension class is jinja2_shell.ShellExtension.

If the second argument is True (default), the output is stripped of trailing whitespace and newlines. (a\n\b \n -> a\nb)

As a statement:

{% shell "echo Hello World" %}
{% shell "echo Hello World", False %}
{% shell "echo 'Hello World', False %}
{% shell "echo \"Hello World\"", False %}

Hello World
Hello World (Ubuntu), Hello World\n (Windows)
Hello World (Ubuntu), Hello World\n (Windows)
Hello World (Ubuntu), Hello World\n (Windows)

As a expression:

{{ "echo Hello World" | shell }}
{{ "echo Hello World" | shell(False) }}
{{ "echo 'Hello World'" | shell(False) }}
{{ "echo \"Hello World\"" | shell(False) }

Hello World
Hello World (Ubuntu), Hello World\n (Windows)
Hello World (Ubuntu), Hello World\n (Windows)
Hello World (Ubuntu), Hello World\n (Windows)

Contributors ✨

Thanks goes to these wonderful people (emoji key):

34j 💻 🤔 📖

This project follows the all-contributors specification. Contributions of any kind welcome!