jx 0.5.1__tar.gz

jx-0.5.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Juan-Pablo Scaletti
+
+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.

jx-0.5.1/PKG-INFO

@@ -0,0 +1,74 @@
+Metadata-Version: 2.4
+Name: jx
+Version: 0.5.1
+Summary: Replace your HTML templates with Python server-Side components
+Author-email: Juan Pablo Scaletti <juanpablo@jpscaletti.com>
+Project-URL: Code, https://github.com/jpsca/jx
+Project-URL: Documentation, https://jx.scaletti.dev/
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: User Interfaces
+Classifier: Topic :: Text Processing :: Markup :: HTML
+Classifier: Typing :: Typed
+Requires-Python: <4,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: jinja2>=3.0
+Dynamic: license-file
+
+<div align="center">
+  <h1><img alt="Jx" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/assets/images/logo-jx.png" height="100" align="top"></h1>
+</div>
+<p align="center">
+  <img alt="python: 3.12, 3.13, 3.14" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/python.svg">
+  <img alt="license: MIT" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/license.svg">
+</p>
+
+### Python server-side components
+
+From chaos to clarity: The power of components in your server-side-rendered Python web app.
+
+<!-- Documentation: https://jx.scaletti.dev/ -->
+
+## How It Works
+
+Jx is a Python library for creating reusable template components with Jinja2. It works by pre-parsing the template source and replacing TitleCased HTML tags with Jinja calls that render the component.
+
+### Component Definition
+
+Components are defined as regular Jinja2 templates (.jinja files) with special metadata comments:
+
+- `{# def parameter1 parameter2=default_value #}` - Defines required and optional parameters
+- `{# import "path/to/component.jinja" as ComponentName #}` - Imports other components
+- `{# css "/path/to/style.css" #}` - Includes CSS files
+- `{# js "/path/to/script.js" #}` - Includes JavaScript files
+
+Example component:
+
+```jinja
+{# def message #}
+{# import "button.jinja" as Button #}
+
+<div class="greeting">{{ message }}</div>
+<Button text="OK" />
+```
+
+### Usage Example
+
+```python
+from jx import Catalog
+
+# Create a catalog and add a components folder
+catalog = Catalog("templates/components")
+
+# Render a component with parameters
+html = catalog.render("card.jinja", title="Hello", content="This is a card")
+```

jx-0.5.1/README.md

@@ -0,0 +1,48 @@
+<div align="center">
+  <h1><img alt="Jx" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/assets/images/logo-jx.png" height="100" align="top"></h1>
+</div>
+<p align="center">
+  <img alt="python: 3.12, 3.13, 3.14" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/python.svg">
+  <img alt="license: MIT" src="https://raw.githubusercontent.com/jpsca/jx/main/docs/license.svg">
+</p>
+
+### Python server-side components
+
+From chaos to clarity: The power of components in your server-side-rendered Python web app.
+
+<!-- Documentation: https://jx.scaletti.dev/ -->
+
+## How It Works
+
+Jx is a Python library for creating reusable template components with Jinja2. It works by pre-parsing the template source and replacing TitleCased HTML tags with Jinja calls that render the component.
+
+### Component Definition
+
+Components are defined as regular Jinja2 templates (.jinja files) with special metadata comments:
+
+- `{# def parameter1 parameter2=default_value #}` - Defines required and optional parameters
+- `{# import "path/to/component.jinja" as ComponentName #}` - Imports other components
+- `{# css "/path/to/style.css" #}` - Includes CSS files
+- `{# js "/path/to/script.js" #}` - Includes JavaScript files
+
+Example component:
+
+```jinja
+{# def message #}
+{# import "button.jinja" as Button #}
+
+<div class="greeting">{{ message }}</div>
+<Button text="OK" />
+```
+
+### Usage Example
+
+```python
+from jx import Catalog
+
+# Create a catalog and add a components folder
+catalog = Catalog("templates/components")
+
+# Render a component with parameters
+html = catalog.render("card.jinja", title="Hello", content="This is a card")
+```

jx-0.5.1/pyproject.toml

@@ -0,0 +1,185 @@
+[build-system]
+requires = ["setuptools"]
+
+
+[project]
+name = "jx"
+version = "0.5.1"
+description = "Replace your HTML templates with Python server-Side components"
+authors = [
+    {name = "Juan Pablo Scaletti", email = "juanpablo@jpscaletti.com"},
+]
+license = { "file" = "MIT-LICENSE" }
+readme = "README.md"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: User Interfaces",
+    "Topic :: Text Processing :: Markup :: HTML",
+    "Typing :: Typed",
+]
+requires-python = ">=3.12,<4"
+dependencies = [
+    "jinja2 >= 3.0",
+]
+
+[project.urls]
+Code = "https://github.com/jpsca/jx"
+Documentation = "https://jx.scaletti.dev/"
+
+[dependency-groups]
+dev = [
+    "ipdb",
+    "pre-commit",
+    "tox-uv",
+    "ty",
+]
+docs = [
+    "writeadoc>=0.7.0",
+]
+test = [
+    "pytest >= 7.2",
+    "pytest-cov",
+    "ruff > 0.3",
+]
+
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[tool.ty.src]
+exclude = [
+    "docs",
+]
+
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "TYPE_CHECKING",
+    "def __repr__",
+    "def __str__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:"
+]
+
+[tool.coverage.html]
+directory = "covreport"
+
+
+[tool.pytest.ini_options]
+addopts = "--doctest-modules"
+
+
+[tool.tox]
+legacy_tox_ini = """
+[tox]
+env_list =
+    3.12
+    3.13
+    3.14
+
+[testenv]
+runner = uv-venv-lock-runner
+dependency_groups =
+    dev
+    test
+commands =
+    pytest -x src/jx tests
+"""
+
+
+[tool.ruff]
+line-length = 90
+indent-width = 4
+target-version = "py312"
+exclude = [
+  ".*",
+  "_build",
+  "build",
+  "covreport",
+  "dist",
+  "benchmark",
+]
+include = ["*.py"]
+
+[tool.ruff.format]
+# Like Black, use double quotes for strings.
+quote-style = "double"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = false
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint]
+fixable = ["ALL"]
+
+ignore = [
+	# x is too complex
+	"C901",
+	# whitespace before ':'
+	"E203",
+	"E501",
+	# x defined from star imports
+	"F405",
+	# line break before binary operator
+	"W505",
+	"W605",
+]
+select = [
+	# bugbear
+	"B",
+	# mccabe"", comprehensions, commas
+	"C",
+	# pycodestyle errors
+	"E",
+	# pyflakes
+	"F",
+	# logging format
+	"G",
+	# imports
+	"I",
+	# quotes
+	"Q",
+	# pycodestyle warnings
+	"W",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["jx"]
+known-local-folder = ["src/jx"]
+
+# Use two line after imports.
+lines-after-imports = 2

jx-0.5.1/setup.cfg

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

jx-0.5.1/src/jx/__init__.py

@@ -0,0 +1,6 @@
+"""
+Jx | Copyright (c) Juan-Pablo Scaletti
+"""
+
+from .catalog import CData, Catalog  # noqa
+from .exceptions import *  # noqa