# README
## Overview
The `formatted_yaml` template handler enhances Sceptre's built-in `File` handler by delivering YAML output that is not only rendered but also reformatted according to an opinionated style aimed at improving readability. This feature is particularly useful for templates that utilize Jinja interpolation, which often introduces unwanted whitespace into the rendered output. By employing the `formatted_yaml` handler, Sceptre users can ensure that their YAML configurations are visually appealing both in the Jinja source code and in the generated output and without spending time navigating Jinja's whitespace management features.
## Installation
Installation instructions
To install directly from PyPI
```shell
pip install sceptre-formatted-yaml-handler
```
To install from the git repo
```shell
pip install git+https://github.com/Sceptre/sceptre-formatted-yaml-handler.git
```
## Usage/Examples
Refer to the
[Sceptre template handler docs](https://docs.sceptre-project.org/latest/docs/hooks.html#hook-points)
for more information.
```yaml
template:
type: formatted_yaml
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Sceptre/sceptre-formatted-yaml-handler",
"name": "sceptre-formatted-yaml-handler",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "sceptre,sceptre-handler",
"author": "Mitchell Rowling",
"author_email": "57084321+mrowlingfox@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/f6/06/858a89b7ef55d99ac580c68ba71b3603da830cabb55d59c501f3128a773a/sceptre_formatted_yaml_handler-1.0.0.tar.gz",
"platform": null,
"description": "# README\n\n## Overview\n\nThe `formatted_yaml` template handler enhances Sceptre's built-in `File` handler by delivering YAML output that is not only rendered but also reformatted according to an opinionated style aimed at improving readability. This feature is particularly useful for templates that utilize Jinja interpolation, which often introduces unwanted whitespace into the rendered output. By employing the `formatted_yaml` handler, Sceptre users can ensure that their YAML configurations are visually appealing both in the Jinja source code and in the generated output and without spending time navigating Jinja's whitespace management features.\n\n## Installation\n\nInstallation instructions\n\nTo install directly from PyPI\n```shell\npip install sceptre-formatted-yaml-handler\n```\n\nTo install from the git repo\n```shell\npip install git+https://github.com/Sceptre/sceptre-formatted-yaml-handler.git\n```\n\n## Usage/Examples\n\nRefer to the\n[Sceptre template handler docs](https://docs.sceptre-project.org/latest/docs/hooks.html#hook-points)\nfor more information.\n\n```yaml\ntemplate:\n type: formatted_yaml\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Sceptre template handler for opinionated formatted YAML",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/Sceptre/sceptre-formatted-yaml-handler",
"Repository": "https://github.com/Sceptre/sceptre-formatted-yaml-handler"
},
"split_keywords": [
"sceptre",
"sceptre-handler"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8065318e5612b9709addc0aae541aaf473246e0eb8b37cfdbc53e25cb90f77fb",
"md5": "76c8edea88cdae4eee7cb5b105d8384d",
"sha256": "609a315876d08830d8df1bae16245b92458e9c806c78a9ca8274f7658e76ecb0"
},
"downloads": -1,
"filename": "sceptre_formatted_yaml_handler-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "76c8edea88cdae4eee7cb5b105d8384d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 4140,
"upload_time": "2024-02-14T03:36:48",
"upload_time_iso_8601": "2024-02-14T03:36:48.210558Z",
"url": "https://files.pythonhosted.org/packages/80/65/318e5612b9709addc0aae541aaf473246e0eb8b37cfdbc53e25cb90f77fb/sceptre_formatted_yaml_handler-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f606858a89b7ef55d99ac580c68ba71b3603da830cabb55d59c501f3128a773a",
"md5": "bada51fa4fa78fee5a7eae9380bd5707",
"sha256": "c4e11ec60b079c070d57d4638db6452b396d78b0f2705584f527af0c187b24ef"
},
"downloads": -1,
"filename": "sceptre_formatted_yaml_handler-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "bada51fa4fa78fee5a7eae9380bd5707",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 3070,
"upload_time": "2024-02-14T03:36:49",
"upload_time_iso_8601": "2024-02-14T03:36:49.910890Z",
"url": "https://files.pythonhosted.org/packages/f6/06/858a89b7ef55d99ac580c68ba71b3603da830cabb55d59c501f3128a773a/sceptre_formatted_yaml_handler-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-14 03:36:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sceptre",
"github_project": "sceptre-formatted-yaml-handler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sceptre-formatted-yaml-handler"
}
JSON
