# jinja2-shell
<p align="center">
<a href="https://github.com/34j/jinja2-shell/actions/workflows/ci.yml?query=branch%3Amain">
<img src="https://img.shields.io/github/actions/workflow/status/34j/jinja2-shell/ci.yml?branch=main&label=CI&logo=github&style=flat-square" alt="CI Status" >
</a>
<a href="https://jinja2-shell.readthedocs.io">
<img src="https://img.shields.io/readthedocs/jinja2-shell.svg?logo=read-the-docs&logoColor=fff&style=flat-square" alt="Documentation Status">
</a>
<a href="https://codecov.io/gh/34j/jinja2-shell">
<img src="https://img.shields.io/codecov/c/github/34j/jinja2-shell.svg?logo=codecov&logoColor=fff&style=flat-square" alt="Test coverage percentage">
</a>
</p>
<p align="center">
<a href="https://python-poetry.org/">
<img src="https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=" alt="Poetry">
</a>
<a href="https://github.com/ambv/black">
<img src="https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square" alt="black">
</a>
<a href="https://github.com/pre-commit/pre-commit">
<img src="https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square" alt="pre-commit">
</a>
</p>
<p align="center">
<a href="https://pypi.org/project/jinja2-shell/">
<img src="https://img.shields.io/pypi/v/jinja2-shell.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
</a>
<img src="https://img.shields.io/pypi/pyversions/jinja2-shell.svg?style=flat-square&logo=python&logoColor=fff" alt="Supported Python versions">
<img src="https://img.shields.io/pypi/l/jinja2-shell.svg?style=flat-square" alt="License">
</p>
Jinja2 Extension for running shell commands. Makes use of `subprocess.run(shell=False)`.
## Installation
Install this via pip (or your favourite package manager):
```shell
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:
```jinja2
{% shell "echo Hello World" %}
{% shell "echo Hello World", False %}
{% shell "echo 'Hello World', False %}
{% shell "echo \"Hello World\"", False %}
```
```text
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:
```jinja2
{{ "echo Hello World" | shell }}
{{ "echo Hello World" | shell(False) }}
{{ "echo 'Hello World'" | shell(False) }}
{{ "echo \"Hello World\"" | shell(False) }
```
```text
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](https://allcontributors.org/docs/en/emoji-key)):
<!-- prettier-ignore-start -->
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/34j"><img src="https://avatars.githubusercontent.com/u/55338215?v=4?s=80" width="80px;" alt="34j"/><br /><sub><b>34j</b></sub></a><br /><a href="https://github.com/34j/jinja2-shell/commits?author=34j" title="Code">💻</a> <a href="#ideas-34j" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/34j/jinja2-shell/commits?author=34j" title="Documentation">📖</a></td>
</tr>
</tbody>
</table>
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
<!-- prettier-ignore-end -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Raw data
{
"_id": null,
"home_page": "https://github.com/34j/jinja2-shell",
"name": "jinja2-shell",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "34j",
"author_email": "34j.95a2p@simplelogin.com",
"download_url": "https://files.pythonhosted.org/packages/ff/61/956a1b7379ca5037bd382adf01ee0420ce04a22242483808026b8c8395ce/jinja2_shell-0.1.4.tar.gz",
"platform": null,
"description": "# jinja2-shell\n\n<p align=\"center\">\n <a href=\"https://github.com/34j/jinja2-shell/actions/workflows/ci.yml?query=branch%3Amain\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/34j/jinja2-shell/ci.yml?branch=main&label=CI&logo=github&style=flat-square\" alt=\"CI Status\" >\n </a>\n <a href=\"https://jinja2-shell.readthedocs.io\">\n <img src=\"https://img.shields.io/readthedocs/jinja2-shell.svg?logo=read-the-docs&logoColor=fff&style=flat-square\" alt=\"Documentation Status\">\n </a>\n <a href=\"https://codecov.io/gh/34j/jinja2-shell\">\n <img src=\"https://img.shields.io/codecov/c/github/34j/jinja2-shell.svg?logo=codecov&logoColor=fff&style=flat-square\" alt=\"Test coverage percentage\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://python-poetry.org/\">\n <img src=\"https://img.shields.io/badge/packaging-poetry-299bd7?style=flat-square&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAASCAYAAABrXO8xAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAJJSURBVHgBfZLPa1NBEMe/s7tNXoxW1KJQKaUHkXhQvHgW6UHQQ09CBS/6V3hKc/AP8CqCrUcpmop3Cx48eDB4yEECjVQrlZb80CRN8t6OM/teagVxYZi38+Yz853dJbzoMV3MM8cJUcLMSUKIE8AzQ2PieZzFxEJOHMOgMQQ+dUgSAckNXhapU/NMhDSWLs1B24A8sO1xrN4NECkcAC9ASkiIJc6k5TRiUDPhnyMMdhKc+Zx19l6SgyeW76BEONY9exVQMzKExGKwwPsCzza7KGSSWRWEQhyEaDXp6ZHEr416ygbiKYOd7TEWvvcQIeusHYMJGhTwF9y7sGnSwaWyFAiyoxzqW0PM/RjghPxF2pWReAowTEXnDh0xgcLs8l2YQmOrj3N7ByiqEoH0cARs4u78WgAVkoEDIDoOi3AkcLOHU60RIg5wC4ZuTC7FaHKQm8Hq1fQuSOBvX/sodmNJSB5geaF5CPIkUeecdMxieoRO5jz9bheL6/tXjrwCyX/UYBUcjCaWHljx1xiX6z9xEjkYAzbGVnB8pvLmyXm9ep+W8CmsSHQQY77Zx1zboxAV0w7ybMhQmfqdmmw3nEp1I0Z+FGO6M8LZdoyZnuzzBdjISicKRnpxzI9fPb+0oYXsNdyi+d3h9bm9MWYHFtPeIZfLwzmFDKy1ai3p+PDls1Llz4yyFpferxjnyjJDSEy9CaCx5m2cJPerq6Xm34eTrZt3PqxYO1XOwDYZrFlH1fWnpU38Y9HRze3lj0vOujZcXKuuXm3jP+s3KbZVra7y2EAAAAAASUVORK5CYII=\" alt=\"Poetry\">\n </a>\n <a href=\"https://github.com/ambv/black\">\n <img src=\"https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square\" alt=\"black\">\n </a>\n <a href=\"https://github.com/pre-commit/pre-commit\">\n <img src=\"https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=flat-square\" alt=\"pre-commit\">\n </a>\n</p>\n<p align=\"center\">\n <a href=\"https://pypi.org/project/jinja2-shell/\">\n <img src=\"https://img.shields.io/pypi/v/jinja2-shell.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPI Version\">\n </a>\n <img src=\"https://img.shields.io/pypi/pyversions/jinja2-shell.svg?style=flat-square&logo=python&logoColor=fff\" alt=\"Supported Python versions\">\n <img src=\"https://img.shields.io/pypi/l/jinja2-shell.svg?style=flat-square\" alt=\"License\">\n</p>\n\nJinja2 Extension for running shell commands. Makes use of `subprocess.run(shell=False)`.\n\n## Installation\n\nInstall this via pip (or your favourite package manager):\n\n```shell\npip install jinja2-shell\n```\n\n## Usage\n\nThe extension class is `jinja2_shell.ShellExtension`.\n\nIf the second argument is `True` (default), the output is stripped of trailing whitespace and newlines. (`a\\n\\b \\n` -> `a\\nb`)\n\nAs a statement:\n\n```jinja2\n{% shell \"echo Hello World\" %}\n{% shell \"echo Hello World\", False %}\n{% shell \"echo 'Hello World', False %}\n{% shell \"echo \\\"Hello World\\\"\", False %}\n```\n\n```text\nHello World\nHello World (Ubuntu), Hello World\\n (Windows)\nHello World (Ubuntu), Hello World\\n (Windows)\nHello World (Ubuntu), Hello World\\n (Windows)\n```\n\nAs a expression:\n\n```jinja2\n{{ \"echo Hello World\" | shell }}\n{{ \"echo Hello World\" | shell(False) }}\n{{ \"echo 'Hello World'\" | shell(False) }}\n{{ \"echo \\\"Hello World\\\"\" | shell(False) }\n```\n\n```text\nHello World\nHello World (Ubuntu), Hello World\\n (Windows)\nHello World (Ubuntu), Hello World\\n (Windows)\nHello World (Ubuntu), Hello World\\n (Windows)\n```\n\n## Contributors \u2728\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n<!-- prettier-ignore-start -->\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n<table>\n <tbody>\n <tr>\n <td align=\"center\" valign=\"top\" width=\"14.28%\"><a href=\"https://github.com/34j\"><img src=\"https://avatars.githubusercontent.com/u/55338215?v=4?s=80\" width=\"80px;\" alt=\"34j\"/><br /><sub><b>34j</b></sub></a><br /><a href=\"https://github.com/34j/jinja2-shell/commits?author=34j\" title=\"Code\">\ud83d\udcbb</a> <a href=\"#ideas-34j\" title=\"Ideas, Planning, & Feedback\">\ud83e\udd14</a> <a href=\"https://github.com/34j/jinja2-shell/commits?author=34j\" title=\"Documentation\">\ud83d\udcd6</a></td>\n </tr>\n </tbody>\n</table>\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n<!-- prettier-ignore-end -->\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n",
"bugtrack_url": null,
"license": "CC0 1.0 Universal",
"summary": "Jinja2 Extension for running shell commands",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/34j/jinja2-shell/issues",
"Changelog": "https://github.com/34j/jinja2-shell/blob/main/CHANGELOG.md",
"Documentation": "https://jinja2-shell.readthedocs.io",
"Homepage": "https://github.com/34j/jinja2-shell",
"Repository": "https://github.com/34j/jinja2-shell"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c36e457c59bcba31c99ef329691f4e5ab038b72661e497ce5ddd0a16bfe81e29",
"md5": "ed04387411397c5eb4dcc6b5bc8a9d00",
"sha256": "0649aaf027b29a718df9814505776b0f616371ac6a34ae70f775385ff32006b4"
},
"downloads": -1,
"filename": "jinja2_shell-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ed04387411397c5eb4dcc6b5bc8a9d00",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 7460,
"upload_time": "2024-11-15T06:26:14",
"upload_time_iso_8601": "2024-11-15T06:26:14.445553Z",
"url": "https://files.pythonhosted.org/packages/c3/6e/457c59bcba31c99ef329691f4e5ab038b72661e497ce5ddd0a16bfe81e29/jinja2_shell-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ff61956a1b7379ca5037bd382adf01ee0420ce04a22242483808026b8c8395ce",
"md5": "afd70fdf3dd0eb0118ce08efb1cab8ce",
"sha256": "d772682f080648e50d3c8a59d20232e4a5a7dec9915fd726f8b20d9d0013c45b"
},
"downloads": -1,
"filename": "jinja2_shell-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "afd70fdf3dd0eb0118ce08efb1cab8ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 7347,
"upload_time": "2024-11-15T06:26:16",
"upload_time_iso_8601": "2024-11-15T06:26:16.073515Z",
"url": "https://files.pythonhosted.org/packages/ff/61/956a1b7379ca5037bd382adf01ee0420ce04a22242483808026b8c8395ce/jinja2_shell-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 06:26:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "34j",
"github_project": "jinja2-shell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jinja2-shell"
}
JSON
