djhtmx 1.1.0__tar.gz → 1.1.1__tar.gz

{djhtmx-1.1.0 → djhtmx-1.1.1}/CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.1.1] - 2025-08-23
+
+- Remove `get_model_subscriptions` `Action` annotation as string literals, as this does not reflect model relationships
+
 ## [1.1.0] - 2025-08-15
 
 ### Changed

{djhtmx-1.1.0 → djhtmx-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: djhtmx
-Version: 1.1.0
+Version: 1.1.1
 Summary: Interactive UI Components for Django using HTMX
 Project-URL: Homepage, https://github.com/edelvalle/djhtmx
 Project-URL: Documentation, https://github.com/edelvalle/djhtmx#readme
@@ -54,8 +54,19 @@ Interactive UI Components for Django using [htmx](https://htmx.org)
 
 ## Install
 
-Add `djhtmx` to your `INSTALLED_APPS` and install the Middleware as the last one
-of the list:
+```bash
+uv add djhtmx
+```
+
+or 
+
+```bash
+pip install djhtmx
+```
+
+# Configuration
+
+Add `djhtmx` to your `INSTALLED_APPS`.
 
 ```python
 INSTALLED_APPS = [
@@ -63,11 +74,33 @@ INSTALLED_APPS = [
     "djhtmx",
     ...
 ]
+```
 
+Install the Middleware as the last one  of the list 
+
+```python
 MIDDLEWARE = [
     ...,
     "djhtmx.middleware",
 ]
+```
+
+Add `djhtmx.context.component_repo` to the list of context processors:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                ...,
+                "djhtmx.context.component_repo",
+            ],
+        },
+    },
+]
 
 ```
 

{djhtmx-1.1.0 → djhtmx-1.1.1}/README.md

@@ -7,8 +7,19 @@ Interactive UI Components for Django using [htmx](https://htmx.org)
 
 ## Install
 
-Add `djhtmx` to your `INSTALLED_APPS` and install the Middleware as the last one
-of the list:
+```bash
+uv add djhtmx
+```
+
+or 
+
+```bash
+pip install djhtmx
+```
+
+# Configuration
+
+Add `djhtmx` to your `INSTALLED_APPS`.
 
 ```python
 INSTALLED_APPS = [
@@ -16,11 +27,33 @@ INSTALLED_APPS = [
     "djhtmx",
     ...
 ]
+```
 
+Install the Middleware as the last one  of the list 
+
+```python
 MIDDLEWARE = [
     ...,
     "djhtmx.middleware",
 ]
+```
+
+Add `djhtmx.context.component_repo` to the list of context processors:
+
+```python
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                ...,
+                "djhtmx.context.component_repo",
+            ],
+        },
+    },
+]
 
 ```
 

{djhtmx-1.1.0 → djhtmx-1.1.1}/src/djhtmx/__init__.py

@@ -1,4 +1,4 @@
 from .middleware import middleware
 
-__version__ = "1.1.0"
+__version__ = "1.1.1"
 __all__ = ("middleware",)

{djhtmx-1.1.0 → djhtmx-1.1.1}/src/djhtmx/utils.py

@@ -63,12 +63,9 @@ def get_instance_subscriptions(
         return {f"{prefix}.{action}" for action in actions}
 
 
-Action = t.Literal["created", "updated", "deleted"]
-
-
 def get_model_subscriptions(
     obj: type[models.Model] | models.Model,
-    actions: t.Sequence[Action | None] = (),
+    actions: t.Sequence[str | None] = (),
 ) -> set[str]:
     """Get the subscriptions to actions of the model.