Rename htmx.py file to fastapi.py file (#17)

* Rename htmx.py file to fastapi.py file

* update safety

CHANGELOG.md

@@ -9,6 +9,13 @@
 
 ## Latest Changes
 
+## Version 3.0.0
+
+### Breaking
+
+* Rename `htmx.py` to `fastapi.py`. The decorators were only for fastAPI. If we support django or flask, then they should get their own versions. This change facilitates for that so we don't have to have a breaking change further down the line.
+* Don't expose `@htmx` and `@full` decorators directly from `hypermedia`, but require them to be imported from `hypermedia.fastapi`. 
+
 ### Housekeeping
 
 * Readme file: Add features section, improve examples

README.md

@@ -92,6 +92,10 @@ HTMX provides an `HX-Request` header that is always true. We can check for this
 
 We've chosen to implement that check in a `@htmx` decorator. The decorator expects `partial` and optionally `full` arguments in the endpoint definition. These must be resolved by FastAPI's dependency injection system.
 
+```python
+from hypermedia.fastapi import htmx, full
+```
+
 The `partial` argument is a function that returns the partial HTML.
 The `full` argument is a function that needs to return the whole HTML, for example on first navigation or a refresh.
 

hypermedia/__init__.py

@@ -95,7 +95,6 @@
     TextArea,
 )
 from hypermedia.frames import IFrame
-from hypermedia.htmx import full, htmx
 from hypermedia.images import (
     Area,
     Canvas,
@@ -183,9 +182,6 @@
     # Models
     "Element",
     "ElementList",
-    # HTMX
-    "htmx",
-    "full",
     # audio and video
     "Audio",
     "Source",

hypermedia/htmx.py → hypermedia/fastapi.py

@@ -72,7 +72,7 @@ async def wrapper(
 def full(
     func: Callable[Param, ReturnType],
 ) -> Callable[Param, Coroutine[Any, Any, Callable[[], ReturnType]]]:
-    """Wrap the paru full page render dependency and makes it lazy."""
+    """Wrap the full page render dependency and makes it lazy."""
 
     @wraps(func)
     async def wrapper(