typja 0.1.0__tar.gz

typja-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.3
+Name: typja
+Version: 0.1.0
+Summary: Type checker for your Jinja2 templates
+Keywords: jinja2,type checking,static analysis
+Author: Daniel Brai
+Author-email: Daniel Brai <danielbrai.dev@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: typer>=0.23.0
+Requires-Dist: tomli==2.4.0 ; python_full_version < '3.11'
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/Daniel-Brai/Typja
+Project-URL: Repository, https://github.com/Daniel-Brai/Typja
+Project-URL: Source, https://github.com/Daniel-Brai/Typja
+Project-URL: Issues, https://github.com/Daniel-Brai/Typja/issues
+Description-Content-Type: text/markdown
+
+# Typja
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Build and Test Typja](https://github.com/Daniel-Brai/Typja/actions/workflows/ci.yml/badge.svg)](https://github.com/Daniel-Brai/Typja/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Daniel-Brai/Typja/branch/main/graph/badge.svg)](https://codecov.io/gh/Daniel-Brai/Typja)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An experimental tool to check Jinja templates for type errors using Python's type hints. It parses Jinja templates, extracts variable usage, and checks them against provided type information.
+
+## Features
+
+- **Type Checking for Jinja2 Templates**: Validate that variables in your Jinja2 templates match their declared types
+- **Python Type Hints Integration**: Leverage your existing Python type annotations to catch template errors early
+- **Pre-commit Integration**: Built-in pre-commit hook for automated checking
+- **Flexible Configuration**: Customize checking behavior with `typja.toml`
+- **Rich Error Reports**: Detailed error messages with code snippets and suggestions
+- **Watch Mode**: Monitor templates for changes and run checks automatically
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install typja
+```
+
+### Basic Usage
+
+```bash
+# Check all templates in current directory
+typja check
+
+# Run in watch mode
+typja watch
+
+# Initialize a new typja.toml configuration
+typja init
+```
+
+### Configuration
+
+Create a `typja.toml` file in your project root with `typja init` or manually:
+
+```toml
+[project]
+root = "."
+paths = ["./models/**/*.py"]
+fail_on_warning = false
+
+[environment]
+template_dirs = ["./templates"]
+include_patterns = ["*.html", "*.jinja", "*.jinja2"]
+
+[linting]
+strict = false
+prefer_pep604_unions = true
+validate_imports = true
+validate_variables = true
+
+[errors]
+verbosity = "normal"
+show_snippets = true
+show_hints = true
+color = "auto"
+```
+
+## Type Annotations in Templates
+
+Use special Jinja2 comments to declare variable types:
+
+```jinja2
+{# typja:var user: User #}
+{# typja:var items: list[str] #}
+{# typja:var count: int #}
+
+<h1>{{ user.name }}</h1>
+<ul>
+  {% for item in items %}
+    <li>{{ item }}</li>
+  {% endfor %}
+</ul>
+```
+
+## Examples
+
+See the [examples/fastapi/](examples/fastapi/) directory for a complete FastAPI application with Jinja2 template type checking.
+
+## Pre-commit Integration
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/Daniel-Brai/Typja
+    rev: v0.1.0
+    hooks:
+      - id: typja-check
+        # With args
+        # args: ["--strict", "--fix"]
+```
+
+## Documentation
+
+- [Configuration Guide](docs/CONFIGURATION.md) - Detailed configuration options
+- [Syntax Guide](docs/SYNTAX.md) - Template syntax and type annotations
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development instructions.
+
+## License
+
+See [LICENSE](LICENSE) for details.

typja-0.1.0/README.md

@@ -0,0 +1,113 @@
+# Typja
+
+[![Python Version](https://img.shields.io/badge/python-3.10%2B-blue.svg)](https://www.python.org/downloads/)
+[![Build and Test Typja](https://github.com/Daniel-Brai/Typja/actions/workflows/ci.yml/badge.svg)](https://github.com/Daniel-Brai/Typja/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/Daniel-Brai/Typja/branch/main/graph/badge.svg)](https://codecov.io/gh/Daniel-Brai/Typja)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+An experimental tool to check Jinja templates for type errors using Python's type hints. It parses Jinja templates, extracts variable usage, and checks them against provided type information.
+
+## Features
+
+- **Type Checking for Jinja2 Templates**: Validate that variables in your Jinja2 templates match their declared types
+- **Python Type Hints Integration**: Leverage your existing Python type annotations to catch template errors early
+- **Pre-commit Integration**: Built-in pre-commit hook for automated checking
+- **Flexible Configuration**: Customize checking behavior with `typja.toml`
+- **Rich Error Reports**: Detailed error messages with code snippets and suggestions
+- **Watch Mode**: Monitor templates for changes and run checks automatically
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install typja
+```
+
+### Basic Usage
+
+```bash
+# Check all templates in current directory
+typja check
+
+# Run in watch mode
+typja watch
+
+# Initialize a new typja.toml configuration
+typja init
+```
+
+### Configuration
+
+Create a `typja.toml` file in your project root with `typja init` or manually:
+
+```toml
+[project]
+root = "."
+paths = ["./models/**/*.py"]
+fail_on_warning = false
+
+[environment]
+template_dirs = ["./templates"]
+include_patterns = ["*.html", "*.jinja", "*.jinja2"]
+
+[linting]
+strict = false
+prefer_pep604_unions = true
+validate_imports = true
+validate_variables = true
+
+[errors]
+verbosity = "normal"
+show_snippets = true
+show_hints = true
+color = "auto"
+```
+
+## Type Annotations in Templates
+
+Use special Jinja2 comments to declare variable types:
+
+```jinja2
+{# typja:var user: User #}
+{# typja:var items: list[str] #}
+{# typja:var count: int #}
+
+<h1>{{ user.name }}</h1>
+<ul>
+  {% for item in items %}
+    <li>{{ item }}</li>
+  {% endfor %}
+</ul>
+```
+
+## Examples
+
+See the [examples/fastapi/](examples/fastapi/) directory for a complete FastAPI application with Jinja2 template type checking.
+
+## Pre-commit Integration
+
+Add to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+  - repo: https://github.com/Daniel-Brai/Typja
+    rev: v0.1.0
+    hooks:
+      - id: typja-check
+        # With args
+        # args: ["--strict", "--fix"]
+```
+
+## Documentation
+
+- [Configuration Guide](docs/CONFIGURATION.md) - Detailed configuration options
+- [Syntax Guide](docs/SYNTAX.md) - Template syntax and type annotations
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development instructions.
+
+## License
+
+See [LICENSE](LICENSE) for details.

typja-0.1.0/pyproject.toml

@@ -0,0 +1,106 @@
+[build-system]
+requires = ["uv_build>=0.9.26,<0.10.0"]
+build-backend = "uv_build"
+
+[project]
+name = "typja"
+version = "0.1.0"
+description = "Type checker for your Jinja2 templates"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [
+    { name = "Daniel Brai", email = "danielbrai.dev@gmail.com" }
+]
+keywords = ["jinja2", "type checking", "static analysis"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+
+    "Intended Audience :: Developers",
+
+    "Natural Language :: English",
+
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX :: Linux",
+
+    "Topic :: Utilities",
+
+    "Typing :: Typed",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "jinja2>=3.1.6",
+    "typer>=0.23.0",
+    "tomli==2.4.0; python_version<'3.11'",
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.1",
+]
+
+test = [
+    "pydantic>=2.12.5",
+    "coverage>=7.13.4",
+    "pytest>=9.0.2",
+    "pytest-cov>=7.0.0",
+    "pytest-xdist>=3.8.0",
+    "pytest-asyncio>=1.3.0",
+]
+
+[project.scripts]
+typja = "typja:main"
+
+
+[project.urls]
+Homepage = "https://github.com/Daniel-Brai/Typja"
+Repository = "https://github.com/Daniel-Brai/Typja"
+Source = "https://github.com/Daniel-Brai/Typja"
+Issues = "https://github.com/Daniel-Brai/Typja/issues"
+
+
+[tool.uv]
+package = true
+
+[tool.bandit]
+severity_level = "HIGH"
+confidence_level = "HIGH"
+exclude_dirs = ["tests", "venv", ".venv", "build", "dist", "__pycache__", "examples"]
+
+[tool.mypy]
+python_version = "3.10"
+show_error_codes = true
+warn_unused_configs = true
+check_untyped_defs = true
+implicit_optional = true
+exclude = ["^./build/.*$", "^./.venv/.*$", "^.*/tests/.*$", "^./examples/.*$"]
+
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+]
+ignore = [
+    "E501", # line too long, handled by black
+    "B008", # do not perform function calls in argument defaults
+    "W191", # indentation contains tabs
+    "C416", # Allow use of list comprehensions
+]
+
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["./tests/"]
+python_files = ["test_*.py"]

typja-0.1.0/src/typja/__init__.py

@@ -0,0 +1,18 @@
+"""
+typja - Type checking for Jinja2 templates
+"""
+
+from importlib.metadata import version
+
+from typja.constants import PACKAGE_NAME
+
+__version__ = version(PACKAGE_NAME)
+
+
+def main() -> None:
+    from typja.cli.app import app
+
+    app()
+
+
+__all__ = ["main"]

typja-0.1.0/src/typja/__main__.py

@@ -0,0 +1,4 @@
+from typja.cli.app import app
+
+if __name__ == "__main__":
+    app()