makejinja 2.3.0__tar.gz → 2.3.1__tar.gz

{makejinja-2.3.0 → makejinja-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: makejinja
-Version: 2.3.0
+Version: 2.3.1
 Summary: makejinja is a CLI tool and Python library to automatically generate files from Jinja2 templates. Use it to easily generate complex Home Assistant dashboards!
 Home-page: https://mirkolenz.github.io/makejinja/
 License: MIT
@@ -39,12 +39,12 @@ Description-Content-Type: text/markdown
 
 <!-- markdownlint-disable MD033 MD041 -->
 <p align="center">
-  <img width="256px" src="./assets/logo.png" />
+  <img width="256px" src="https://raw.githubusercontent.com/mirkolenz/makejinja/main/assets/logo.png" />
 </p>
 <p align="center">
   <a href="https://pypi.org/project/makejinja/">PyPI</a> |
   <a href="https://mirkolenz.github.io/makejinja">Docs</a> |
-  <a href="./tests/data">Example</a> |
+  <a href="https://github.com/mirkolenz/makejinja/tree/main/tests/data">Example</a> |
   <a href="https://jinja.palletsprojects.com/en/3.1.x/templates">Templating</a>
 </p>
 <p align="center">
@@ -61,7 +61,7 @@ This allows you to load variables from external files or create repeating patter
 It is conceptually similar to [gomplate](https://github.com/hairyhenderson/gomplate), but is built on Python and Jinja instead of Go.
 A use case for this tool is generating config files for [Home Assistant](https://www.home-assistant.io/):
 Using the same language that the built-in templates use, you can greatly simplify your configuration.
-An [example for Home Assistant](./tests/data) can be found in the tests directory.
+An [example for Home Assistant](https://github.com/mirkolenz/makejinja/tree/main/tests/data) can be found in the tests directory.
 
 ## Features
 
@@ -72,7 +72,7 @@ An [example for Home Assistant](./tests/data) can be found in the tests director
 - Tailor the whitespace behavior to your needs.
 - Use custom delimiters for Jinja blocks/comments/variables.
 - Modify _all_ init options for the Jinja environment.
-- Write custom **Python loaders** that implement a subset of our fully typed [abstract loader class](./makejinja/loader.py)
+- Write custom **Python loaders** that implement a subset of our fully typed [abstract loader class](https://mirkolenz.github.io/makejinja/makejinja/loader.html#AbstractLoader)
 
 ## Installation
 
@@ -92,25 +92,25 @@ Thus, we advise leveraging [`pipx`](https://github.com/pypa/pipx) instead:
 
 You can then directly invoke the app as follows:
 
-`makejinja --input ./data/input --output ./data/output`
+`makejinja -i ./input -o ./output`
 
 ### Nix
 
 If you use the `nix` package manager, you can add this repository as an input to your flake and use `makejinja.packages.${system}.default`.
 You can also run it directly
 
-`nix run github:mirkolenz/makejinja -- --input ./data/input --output ./data/output`
+`nix run github:mirkolenz/makejinja -- -i ./input -o ./output`
 
 ### Docker
 
 We automatically publish an image at `ghcr.io/mirkolenz/makejinja`.
 To use it, mount a folder to the container and pass the options as the command.
 
-`docker run --rm -v $(pwd)/data:/data ghcr.io/mirkolenz/makejinja:latest --input /data/input --output /data/output`
+`docker run --rm -v $(pwd)/data:/data ghcr.io/mirkolenz/makejinja:latest -i /data/input -o /data/output`
 
 ## Usage in Terminal / Command Line
 
 In its default configuration, makejinja searches the input folder recursively for files ending in `.jinja`.
 It then renders these files and writes them to the output folder, preserving the directory structure.
-Our [documentation](https://mirkolenz.github.io/makejinja/cli.html) contains a detailed description of all options and can also be accessed via `makejinja --help`.
+Our [documentation](https://mirkolenz.github.io/makejinja/makejinja/cli.html) contains a detailed description of all options and can also be accessed via `makejinja --help`.
 

{makejinja-2.3.0 → makejinja-2.3.1}/README.md

@@ -1,11 +1,11 @@
 <!-- markdownlint-disable MD033 MD041 -->
 <p align="center">
-  <img width="256px" src="./assets/logo.png" />
+  <img width="256px" src="https://raw.githubusercontent.com/mirkolenz/makejinja/main/assets/logo.png" />
 </p>
 <p align="center">
   <a href="https://pypi.org/project/makejinja/">PyPI</a> |
   <a href="https://mirkolenz.github.io/makejinja">Docs</a> |
-  <a href="./tests/data">Example</a> |
+  <a href="https://github.com/mirkolenz/makejinja/tree/main/tests/data">Example</a> |
   <a href="https://jinja.palletsprojects.com/en/3.1.x/templates">Templating</a>
 </p>
 <p align="center">
@@ -22,7 +22,7 @@ This allows you to load variables from external files or create repeating patter
 It is conceptually similar to [gomplate](https://github.com/hairyhenderson/gomplate), but is built on Python and Jinja instead of Go.
 A use case for this tool is generating config files for [Home Assistant](https://www.home-assistant.io/):
 Using the same language that the built-in templates use, you can greatly simplify your configuration.
-An [example for Home Assistant](./tests/data) can be found in the tests directory.
+An [example for Home Assistant](https://github.com/mirkolenz/makejinja/tree/main/tests/data) can be found in the tests directory.
 
 ## Features
 
@@ -33,7 +33,7 @@ An [example for Home Assistant](./tests/data) can be found in the tests director
 - Tailor the whitespace behavior to your needs.
 - Use custom delimiters for Jinja blocks/comments/variables.
 - Modify _all_ init options for the Jinja environment.
-- Write custom **Python loaders** that implement a subset of our fully typed [abstract loader class](./makejinja/loader.py)
+- Write custom **Python loaders** that implement a subset of our fully typed [abstract loader class](https://mirkolenz.github.io/makejinja/makejinja/loader.html#AbstractLoader)
 
 ## Installation
 
@@ -53,24 +53,24 @@ Thus, we advise leveraging [`pipx`](https://github.com/pypa/pipx) instead:
 
 You can then directly invoke the app as follows:
 
-`makejinja --input ./data/input --output ./data/output`
+`makejinja -i ./input -o ./output`
 
 ### Nix
 
 If you use the `nix` package manager, you can add this repository as an input to your flake and use `makejinja.packages.${system}.default`.
 You can also run it directly
 
-`nix run github:mirkolenz/makejinja -- --input ./data/input --output ./data/output`
+`nix run github:mirkolenz/makejinja -- -i ./input -o ./output`
 
 ### Docker
 
 We automatically publish an image at `ghcr.io/mirkolenz/makejinja`.
 To use it, mount a folder to the container and pass the options as the command.
 
-`docker run --rm -v $(pwd)/data:/data ghcr.io/mirkolenz/makejinja:latest --input /data/input --output /data/output`
+`docker run --rm -v $(pwd)/data:/data ghcr.io/mirkolenz/makejinja:latest -i /data/input -o /data/output`
 
 ## Usage in Terminal / Command Line
 
 In its default configuration, makejinja searches the input folder recursively for files ending in `.jinja`.
 It then renders these files and writes them to the output folder, preserving the directory structure.
-Our [documentation](https://mirkolenz.github.io/makejinja/cli.html) contains a detailed description of all options and can also be accessed via `makejinja --help`.
+Our [documentation](https://mirkolenz.github.io/makejinja/makejinja/cli.html) contains a detailed description of all options and can also be accessed via `makejinja --help`.

{makejinja-2.3.0 → makejinja-2.3.1}/makejinja/__init__.py

@@ -1,4 +1,6 @@
 """
+![Screencast demo](../assets/demo.gif)
+
 .. include:: ../README.md
 
 ## Usage as a Library

{makejinja-2.3.0 → makejinja-2.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "makejinja"
-version = "2.3.0"
+version = "2.3.1"
 description = "makejinja is a CLI tool and Python library to automatically generate files from Jinja2 templates. Use it to easily generate complex Home Assistant dashboards!"
 authors = ["Mirko Lenz <mirko@mirkolenz.com>"]
 license = "MIT"