<p align="center">
<img width="317" height="500" src="https://github.com/smashthings/jinny/blob/master/docs/img/logo.png?raw=true">
</p>
# jinny
Jinny is a templating tool for jinja templates. It can be used for a number of things but was created from a DevOps perspective to aid in configuration management for scaled deployments instead of using tools like Helm, Kustomize, jinja-cli, etc. These days jinny is still used for Ops work but is also used for live applications handling email templating, static HTML generation and more
## CLI Usage Examples
```
=> Templating multiple templates with a single input file:
$ jinny -t template-1.txt template-2.txt -i inputs.yml
=> Templating any number of templates with two input files where base-values.yml provides all the base values and any values in overrides.json acts as an override:
$ jinny -t template.yml -i base-values.yml overrides.json
=> Use an environment value file for templating
$ jinny -t template.yml -i ENVIRONMENT_VARIABLES.env
=> Add an explicit override via CLI argument -e
$ jinny -t template.yml -i base-values.yml -e 'image=smasherofallthings/flask-waitress:latest'
=> Add even more overrides via environment variables, so your pipelines can completely replace any bad value:
$ JINNY_overridden_value="top-priority" jinny -t template.yml -i base-values.yml overrides.json
=> Pump all your files to a single stdout stream with a separator so different files are clearly marked:
$ jinny -t template-1.yml template-2.yml -i inputs.json -s '---'
=> Dump all your templated files into a directory for capture, comparison and deployment
$ jinny -t template-1.yml template-2.yml -i inputs.json -d /path/to/directory
$ kubectl diff -f /path/to/directory
$ kubectl apply --server-dry-run -f /path/to/directory
=> Pipe jinny to kubectl directly
$ jinny -t template-1.yml -i inputs.json | kubectl apply -f -
```
## Documentation
Jinny has a lot of functionality, settings and more. You can review the documentation at - [https://jinny.southall.solutions](https://jinny.southall.solutions).
The documentation is a single HTML page built with Jinny. The source code for the site is at `docs/*` and contains:
- The main `index.html` page
- `docs/inputs/*` - containing `yml` files that cover separate content and configuration
- `docs/partials/*` - covering separate HTML parials which jinny collates into the single page
- `docs/css/*` && `docs/js/*` - static files that jinny dynamically loads in a build time with the templating provided at `index.html`
- `docs/img/*` - static images that jinny reads, base64 encodes and integrates directly into the HTML
- All the other frontend stuff
The directory tree is as standard as you can expect, but with jinny's features the whole functionality is compiled and deployed into a single HTML page.
Raw data
{
"_id": null,
"home_page": null,
"name": "jinny",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "jinja, template, jinja2, kubernetes, cli",
"author": "smasherofallthings",
"author_email": "bots@trulydigital.net",
"download_url": "https://files.pythonhosted.org/packages/94/cc/c693965d3a6c84fa46de19dca64125751213c4c8491a34523a890b046619/jinny-2.2.5.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=\"317\" height=\"500\" src=\"https://github.com/smashthings/jinny/blob/master/docs/img/logo.png?raw=true\">\n</p>\n\n# jinny\n\nJinny is a templating tool for jinja templates. It can be used for a number of things but was created from a DevOps perspective to aid in configuration management for scaled deployments instead of using tools like Helm, Kustomize, jinja-cli, etc. These days jinny is still used for Ops work but is also used for live applications handling email templating, static HTML generation and more\n\n\n## CLI Usage Examples\n\n```\n\n=> Templating multiple templates with a single input file:\n$ jinny -t template-1.txt template-2.txt -i inputs.yml\n\n=> Templating any number of templates with two input files where base-values.yml provides all the base values and any values in overrides.json acts as an override:\n$ jinny -t template.yml -i base-values.yml overrides.json\n\n=> Use an environment value file for templating\n$ jinny -t template.yml -i ENVIRONMENT_VARIABLES.env\n\n=> Add an explicit override via CLI argument -e\n$ jinny -t template.yml -i base-values.yml -e 'image=smasherofallthings/flask-waitress:latest'\n\n=> Add even more overrides via environment variables, so your pipelines can completely replace any bad value:\n$ JINNY_overridden_value=\"top-priority\" jinny -t template.yml -i base-values.yml overrides.json\n\n=> Pump all your files to a single stdout stream with a separator so different files are clearly marked:\n$ jinny -t template-1.yml template-2.yml -i inputs.json -s '---'\n\n=> Dump all your templated files into a directory for capture, comparison and deployment\n$ jinny -t template-1.yml template-2.yml -i inputs.json -d /path/to/directory\n$ kubectl diff -f /path/to/directory\n$ kubectl apply --server-dry-run -f /path/to/directory\n\n=> Pipe jinny to kubectl directly\n$ jinny -t template-1.yml -i inputs.json | kubectl apply -f -\n\n```\n\n## Documentation\n\nJinny has a lot of functionality, settings and more. You can review the documentation at - [https://jinny.southall.solutions](https://jinny.southall.solutions).\n\nThe documentation is a single HTML page built with Jinny. The source code for the site is at `docs/*` and contains:\n\n- The main `index.html` page\n- `docs/inputs/*` - containing `yml` files that cover separate content and configuration\n- `docs/partials/*` - covering separate HTML parials which jinny collates into the single page\n- `docs/css/*` && `docs/js/*` - static files that jinny dynamically loads in a build time with the templating provided at `index.html`\n- `docs/img/*` - static images that jinny reads, base64 encodes and integrates directly into the HTML\n- All the other frontend stuff\n\nThe directory tree is as standard as you can expect, but with jinny's features the whole functionality is compiled and deployed into a single HTML page.\n\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A practical templating tool for Jinja templates",
"version": "2.2.5",
"project_urls": {
"Documentation": "https://jinny.southall.solutions",
"Github": "https://github.com/smashthings/jinny",
"Gitlab": "https://gitlab.com/scripteddog/jinny",
"Sponsor": "https://skysiege.net"
},
"split_keywords": [
"jinja",
" template",
" jinja2",
" kubernetes",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94ccc693965d3a6c84fa46de19dca64125751213c4c8491a34523a890b046619",
"md5": "ac8ff7a1f06635df1957afb94ac15e9a",
"sha256": "c042a33541909d693cf4789620401314f173b157d4a3ca5550f8bb61a5031143"
},
"downloads": -1,
"filename": "jinny-2.2.5.tar.gz",
"has_sig": false,
"md5_digest": "ac8ff7a1f06635df1957afb94ac15e9a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 83470,
"upload_time": "2024-11-05T13:10:57",
"upload_time_iso_8601": "2024-11-05T13:10:57.653296Z",
"url": "https://files.pythonhosted.org/packages/94/cc/c693965d3a6c84fa46de19dca64125751213c4c8491a34523a890b046619/jinny-2.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-05 13:10:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smashthings",
"github_project": "jinny",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "jinny"
}
JSON
