jinja2-git-dir 0.1.0__tar.gz

jinja2_git_dir-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.cache/
+.direnv/
+.idea/
+.venv/
+
+__pycache__
+
+.DS_Store

jinja2_git_dir-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Gordon Code LLC
+
+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.

jinja2_git_dir-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: jinja2-git-dir
+Version: 0.1.0
+Summary: Jinja2 filter extension for detecting if a directory is a git repository
+Project-URL: repository, https://github.com/gordoncode/jinja2-git-dir/
+Author-email: Will Gordon <will@gordoncode.dev>
+License: MIT License
+        
+        Copyright (c) 2025 Gordon Code LLC
+        
+        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.
+License-File: LICENSE
+Keywords: copier,extension,filters,jinja,jinja2
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: jinja2>=3.0
+Description-Content-Type: text/markdown
+
+# Git Directory Extension
+
+Jinja2 filter extension for detecting if a directory is a git repository.
+
+## Usage
+
+Examples:
+
+- Detect if `git_path` is a git directory  
+    `{{ git_path | gitdir }}`
+- Assert that `git_path` is a git directory  
+    `{{ git_path | gitdir is true }}`
+- Assert that `git_path` is **NOT** a git directory  
+    `{{ git_path | gitdir is false }}`
+- Using `gitdir` in a conditional  
+    `{% if (git_path | gitdir) %}{{ git_path }} is a git directory{% else %}no git directory at {{ git_path }}{% endif %}`
+
+### Copier
+
+This can be utilized within a Copier `copier.yaml` file for determining if the destination
+path is already initialized as a git directory.
+
+Example:  
+
+This will configure a Copier `_task` to run `git init` but _only_ if the destination
+path isn't already a git directory.
+
+```yaml
+_jinja_extensions:
+    - jinja2_git_dir.GitDirectoryExtension
+_tasks:
+  - command: "git init"
+    when: "{{ _copier_conf.dst_path | realpath | gitdir }}"
+```

jinja2_git_dir-0.1.0/README.md

@@ -0,0 +1,34 @@
+# Git Directory Extension
+
+Jinja2 filter extension for detecting if a directory is a git repository.
+
+## Usage
+
+Examples:
+
+- Detect if `git_path` is a git directory  
+    `{{ git_path | gitdir }}`
+- Assert that `git_path` is a git directory  
+    `{{ git_path | gitdir is true }}`
+- Assert that `git_path` is **NOT** a git directory  
+    `{{ git_path | gitdir is false }}`
+- Using `gitdir` in a conditional  
+    `{% if (git_path | gitdir) %}{{ git_path }} is a git directory{% else %}no git directory at {{ git_path }}{% endif %}`
+
+### Copier
+
+This can be utilized within a Copier `copier.yaml` file for determining if the destination
+path is already initialized as a git directory.
+
+Example:  
+
+This will configure a Copier `_task` to run `git init` but _only_ if the destination
+path isn't already a git directory.
+
+```yaml
+_jinja_extensions:
+    - jinja2_git_dir.GitDirectoryExtension
+_tasks:
+  - command: "git init"
+    when: "{{ _copier_conf.dst_path | realpath | gitdir }}"
+```

jinja2_git_dir-0.1.0/jinja2_git_dir/__init__.py

@@ -0,0 +1,25 @@
+from pathlib import Path
+from subprocess import CalledProcessError, CompletedProcess, run
+
+from jinja2.environment import Environment
+from jinja2.ext import Extension
+
+
+def _git_dir(git_path: str) -> bool:
+    # Utilize Path() to sanitize the input and resolve to an absolute path
+    try:
+        git_path = str(Path(git_path).resolve())
+    except TypeError:
+        return False
+    command: list[str] = ["git", "-C", git_path, "rev-parse", "--show-toplevel"]
+    try:
+        result: CompletedProcess[str] = run(command, check=True, capture_output=True, text=True)  # noqa: S603
+        return result.stdout.lower() == git_path
+    except CalledProcessError:
+        return False
+
+
+class GitDirectoryExtension(Extension):
+    def __init__(self, environment: Environment) -> None:
+        super().__init__(environment)
+        environment.filters["gitdir"] = _git_dir

jinja2_git_dir-0.1.0/pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "jinja2-git-dir"
+version = "v0.1.0"
+description = "Jinja2 filter extension for detecting if a directory is a git repository"
+authors = [
+    {name = "Will Gordon", email = "will@gordoncode.dev"},
+]
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Typing :: Typed"
+]
+keywords = ["jinja", "jinja2", "extension", "filters", "copier"]
+dependencies = ["jinja2>=3.0"]
+
+[project.urls]
+repository = "https://github.com/gordoncode/jinja2-git-dir/"
+
+[dependency-groups]
+dev = ["mypy", "ruff", "pylint", "pytest", "pytest-subprocess"]
+
+[tool.hatch.build.targets.sdist]
+packages = ["src/jinja2_git_dir"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+line-length = 120
+src = ["src"]
+target-version = "py39"
+cache-dir = ".cache/.ruff_cache"
+force-exclude = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["D100", "D101", "D102", "D104", "D205", "D401", "COM812"]
+unfixable = ["T201", "F401", "F841"]
+
+[tool.ruff.lint.per-file-ignores]
+"test_*.py" = ["S101", "PLR2004", "SLF001", "INP001", "ANN001", "ANN201", "D103"]
+
+[tool.ruff.lint.isort]
+known-first-party = ["src"]
+section-order = ["future", "standard-library", "third-party", "first-party", "local-folder"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"
+
+[tool.pytest.ini_options]
+cache_dir = ".cache/.pytest_cache"
+python_files = "test_*.py"
+
+[tool.pylint.master]
+ignore-patterns = "test_.*.py"
+
+[tool.pylint.format]
+max-line-length = 120
+
+[tool.pylint.messages_control]
+disable = ["missing-module-docstring", "missing-class-docstring"]
+
+[tool.pylint.string]
+check-quote-consistency = "yes"
+
+[tool.mypy]
+cache_dir = ".cache/.mypy_cache"