makejinja 2.6.2__tar.gz → 2.7.0__tar.gz

{makejinja-2.6.2 → makejinja-2.7.0}/PKG-INFO

@@ -1,13 +1,36 @@
 Metadata-Version: 2.1
 Name: makejinja
-Version: 2.6.2
+Version: 2.7.0
 Summary: Generate entire directory structures using Jinja templates with support for external data and custom plugins.
-Home-page: https://mirkolenz.github.io/makejinja/
-License: MIT
+Author-email: Mirko Lenz <mirko@mirkolenz.com>
+License: MIT License
+        
+        Copyright (c) 2022 Mirko Lenz
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/mirkolenz/makejinja
+Project-URL: Homepage, https://mirkolenz.github.io/makejinja/
+Project-URL: Documentation, https://mirkolenz.github.io/makejinja/makejinja/cli.html
+Project-URL: Issues, https://github.com/mirkolenz/makejinja/issues
+Project-URL: Changelog, https://github.com/mirkolenz/makejinja/releases
 Keywords: jinja2,home-assistant,hassio,dashboard,lovelace,template,generator,cli,tool,library
-Author: Mirko Lenz
-Author-email: mirko@mirkolenz.com
-Requires-Python: >=3.11,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Framework :: Pytest
@@ -17,9 +40,6 @@ Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: File Formats
 Classifier: Topic :: Home Automation
 Classifier: Topic :: Software Development :: Code Generators
@@ -29,14 +49,18 @@ Classifier: Topic :: System :: Systems Administration
 Classifier: Topic :: Text Processing :: Markup
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Dist: immutables (>=0.20,<0.21)
-Requires-Dist: jinja2 (>=3.1,<4.0)
-Requires-Dist: pyyaml (>=6.0,<7.0)
-Requires-Dist: rich-click (>=1.7,<2.0)
-Requires-Dist: typed-settings[attrs,cattrs,click] (>=23.1,<25)
-Project-URL: Documentation, https://mirkolenz.github.io/makejinja/makejinja/cli.html
-Project-URL: Repository, https://github.com/mirkolenz/makejinja
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2<4,>=3
+Requires-Dist: pyyaml<7,>=6
+Requires-Dist: rich-click<2,>=1
+Requires-Dist: typed-settings[attrs,cattrs,click]<25,>=23
+Requires-Dist: immutables<1,>=0.20
 
 <!-- markdownlint-disable MD033 MD041 -->
 <h2><p align="center">makejinja</p></h2>
@@ -109,4 +133,3 @@ docker run --rm -v $(pwd)/data:/data ghcr.io/mirkolenz/makejinja:latest -i /data
 In its default configuration, makejinja searches the input directory recursively for files ending in `.jinja`.
 It then renders these files and writes them to the output directory, preserving the directory structure.
 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.7.0/makejinja.egg-info/PKG-INFO

@@ -0,0 +1,135 @@
+Metadata-Version: 2.1
+Name: makejinja
+Version: 2.7.0
+Summary: Generate entire directory structures using Jinja templates with support for external data and custom plugins.
+Author-email: Mirko Lenz <mirko@mirkolenz.com>
+License: MIT License
+        
+        Copyright (c) 2022 Mirko Lenz
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Repository, https://github.com/mirkolenz/makejinja
+Project-URL: Homepage, https://mirkolenz.github.io/makejinja/
+Project-URL: Documentation, https://mirkolenz.github.io/makejinja/makejinja/cli.html
+Project-URL: Issues, https://github.com/mirkolenz/makejinja/issues
+Project-URL: Changelog, https://github.com/mirkolenz/makejinja/releases
+Keywords: jinja2,home-assistant,hassio,dashboard,lovelace,template,generator,cli,tool,library
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: File Formats
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Code Generators
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Software Distribution
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2<4,>=3
+Requires-Dist: pyyaml<7,>=6
+Requires-Dist: rich-click<2,>=1
+Requires-Dist: typed-settings[attrs,cattrs,click]<25,>=23
+Requires-Dist: immutables<1,>=0.20
+
+<!-- markdownlint-disable MD033 MD041 -->
+<h2><p align="center">makejinja</p></h2>
+<p align="center">
+  <img width="256px" alt="makejinja logo" 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://github.com/users/mirkolenz/packages/container/package/makejinja">Docker</a> |
+  <a href="https://mirkolenz.github.io/makejinja">Docs</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">Jinja reference</a>
+</p>
+<p align="center">
+  Generate entire directory structures using Jinja templates with support for external data and custom plugins.
+</p>
+
+---
+
+# makejinja
+
+makejinja can be used to automatically generate files from [Jinja templates](https://jinja.palletsprojects.com/en/3.1.x/templates).
+It is conceptually similar to [Ansible templates](https://docs.ansible.com/ansible/latest/collections/ansible/builtin/template_module.html) since both are built on top of Jinja.
+However, makejinja is a standalone tool that can be used without Ansible and offers some advanced features like custom plugins.
+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](https://github.com/mirkolenz/makejinja/tree/main/tests/data) can be found in the tests directory.
+
+## Highlights
+
+- Recursively render nested directories containing template files to a common output directory.
+- Load data files containing variables to use in your Jinja templates from YAML, TOML, and Python files.
+- Write custom [plugins](https://mirkolenz.github.io/makejinja/makejinja/plugin.html#Plugin) to extend the functionality of makejinja.
+- Adjust all Jinja options (e.g., whitespace behavior and delimiters) to your needs via CLI flags or a config file.
+
+## Installation
+
+The tool is written in Python and can be installed via pip, nix, and docker.
+It can be used as a CLI tool or as a Python library.
+
+### PIP
+
+makejinja is available on [PyPI](https://pypi.org/project/makejinja/) and can be installed via `pip`:
+
+```shell
+pip install makejinja
+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` or apply the overlay `makejinja.overlays.default`.
+You can also run it directly as follows:
+
+```shell
+nix run github:mirkolenz/makejinja -- -i ./input -o ./output
+```
+
+### Docker
+
+We automatically publish an image to the [GitHub Container Registry](https://ghcr.io/mirkolenz/makejinja).
+To use it, mount a directory to the container and pass the options as the command:
+
+```shell
+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 directory recursively for files ending in `.jinja`.
+It then renders these files and writes them to the output directory, preserving the directory structure.
+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.7.0/makejinja.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+makejinja/__init__.py
+makejinja/__main__.py
+makejinja/app.py
+makejinja/cli.py
+makejinja/config.py
+makejinja/plugin.py
+makejinja/py.typed
+makejinja.egg-info/PKG-INFO
+makejinja.egg-info/SOURCES.txt
+makejinja.egg-info/dependency_links.txt
+makejinja.egg-info/entry_points.txt
+makejinja.egg-info/requires.txt
+makejinja.egg-info/top_level.txt
+tests/test_makejinja.py

makejinja-2.7.0/makejinja.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

makejinja-2.7.0/makejinja.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+makejinja = makejinja.cli:makejinja_cli

makejinja-2.7.0/makejinja.egg-info/requires.txt

@@ -0,0 +1,5 @@
+jinja2<4,>=3
+pyyaml<7,>=6
+rich-click<2,>=1
+typed-settings[attrs,cattrs,click]<25,>=23
+immutables<1,>=0.20

makejinja-2.7.0/makejinja.egg-info/top_level.txt

@@ -0,0 +1 @@
+makejinja

{makejinja-2.6.2 → makejinja-2.7.0}/pyproject.toml

@@ -1,13 +1,11 @@
-[tool.poetry]
+[project]
 name = "makejinja"
-version = "2.6.2"
+version = "2.7.0"
 description = "Generate entire directory structures using Jinja templates with support for external data and custom plugins."
-authors = ["Mirko Lenz <mirko@mirkolenz.com>"]
-license = "MIT"
+requires-python = ">=3.11"
+authors = [{ name = "Mirko Lenz", email = "mirko@mirkolenz.com" }]
+license = { file = "LICENSE" }
 readme = "README.md"
-repository = "https://github.com/mirkolenz/makejinja"
-homepage = "https://mirkolenz.github.io/makejinja/"
-documentation = "https://mirkolenz.github.io/makejinja/makejinja/cli.html"
 keywords = [
     "jinja2",
     "home-assistant",
@@ -39,29 +37,36 @@ classifiers = [
     "Topic :: Text Processing :: Markup",
     "Topic :: Utilities",
     "Typing :: Typed",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+dependencies = [
+    "jinja2>=3,<4",
+    "pyyaml>=6,<7",
+    "rich-click>=1,<2",
+    "typed-settings[attrs,cattrs,click]>=23,<25",
+    "immutables>=0.20,<1",
 ]
 
-[tool.poetry.scripts]
-makejinja = "makejinja.cli:makejinja_cli"
+[project.urls]
+Repository = "https://github.com/mirkolenz/makejinja"
+Homepage = "https://mirkolenz.github.io/makejinja/"
+Documentation = "https://mirkolenz.github.io/makejinja/makejinja/cli.html"
+Issues = "https://github.com/mirkolenz/makejinja/issues"
+Changelog = "https://github.com/mirkolenz/makejinja/releases"
 
-[tool.poetry.dependencies]
-python = "^3.11"
-jinja2 = "^3.1"
-pyyaml = "^6.0"
-rich-click = "^1.7"
-typed-settings = { version = ">=23.1, <25", extras = [
-    "attrs",
-    "cattrs",
-    "click",
-] }
-immutables = "^0.20"
+[project.scripts]
+makejinja = "makejinja.cli:makejinja_cli"
 
-[tool.poetry.group.dev.dependencies]
-pytest = "^8.0.0"
-pytest-cov = "^5.0.0"
+[dependency-groups]
+test = ["pytest>=8,<9", "pytest-cov>=6,<7"]
+docs = ["pdoc>=15,<16"]
 
-[tool.poetry.group.docs.dependencies]
-pdoc = "^14.1"
+[tool.uv]
+default-groups = ["test", "docs"]
+package = true
 
 [tool.pytest.ini_options]
 addopts = "--cov makejinja --cov-report term-missing"
@@ -74,6 +79,5 @@ ignore = ["E501"]
 [tool.ruff.pydocstyle]
 convention = "google"
 
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
+[tool.setuptools]
+packages = ["makejinja"]

makejinja-2.7.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

makejinja-2.7.0/tests/test_makejinja.py

@@ -0,0 +1,66 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+import pytest
+from click.testing import CliRunner
+
+
+@dataclass
+class Paths:
+    input: Path
+    baseline: Path
+    output: Path
+
+    def __repr__(self) -> str:
+        return "makejinja"
+
+
+@pytest.fixture(scope="session")
+def exec(tmp_path_factory: pytest.TempPathFactory) -> Paths:
+    assert __package__ is not None
+    data_path = Path(__package__, "data")
+    input_path = data_path / "input"
+    baseline_path = data_path / "output"
+    output_path = tmp_path_factory.mktemp("data")
+
+    with pytest.MonkeyPatch.context() as m:
+        m.chdir(data_path)
+        runner = CliRunner()
+
+        # Need to import it AFTER chdir
+        from makejinja.cli import makejinja_cli
+
+        runner.invoke(
+            makejinja_cli,
+            [
+                # Override it here to use our tmp_path
+                "--output",
+                str(output_path),
+            ],
+            catch_exceptions=False,
+            color=True,
+        )
+
+    return Paths(input_path, baseline_path, output_path)
+
+
+def _dir_content(path: Path) -> set[Path]:
+    return {item.relative_to(path) for item in path.rglob("*")}
+
+
+def test_dir_content(exec: Paths):
+    assert _dir_content(exec.baseline) == _dir_content(exec.output)
+
+
+def test_file_content(exec: Paths):
+    paths = _dir_content(exec.baseline)
+
+    for item in paths:
+        baseline_path = exec.baseline / item
+        output_path = exec.output / item
+
+        if baseline_path.is_file() and output_path.is_file():
+            baseline = baseline_path.read_text()
+            output = output_path.read_text()
+
+            assert baseline.strip() == output.strip(), str(item)