feat: v3 - Move litestar-htmx to a package extra (#4063)

Remove litestar-htmx from default dependencies

Author: provinzkraut

docs/getting-started.rst

@@ -65,6 +65,9 @@ Installation
     :ref:`Polyfactory to generate OpenAPI examples <usage/openapi/schema_generation:Generating examples>`
         :code:`pip install litestar[structlog]`
 
+    :doc:`HTMX plugin </usage/htmx>`
+        :code:`pip install litestar[htmx]`
+
     Standard Installation (includes Uvicorn and Jinja2 templating):
         :code:`pip install litestar[standard]`
 

docs/release-notes/whats-new-3.rst

@@ -289,3 +289,10 @@ This does not change any behaviour, as this parameter was previously ignored.
 The `polyfactory <https://polyfactory.litestar.dev/>`_ library is not included by
 default anymore, and has been moved to the ``litestar[polyfactory]`` package extra. It
 is also included in ``litestar[full]``.
+
+
+``litestar-htmx`` package removed from default dependencies
+-----------------------------------------------------------
+
+The `litestar-htmx <https://github.com/litestar-org/litestar-htmx/>`_ package powering
+the :doc:`HTMX plugin </usage/htmx>` has been moved to the ``litestar[htmx]`` extra.

docs/usage/htmx.rst

@@ -8,11 +8,14 @@ HTMX is a JavaScript library that gives you access to AJAX, CSS Transitions, Web
 This section assumes that you have prior knowledge of HTMX.
 If you want to learn HTMX, we recommend consulting their `official tutorial <https://htmx.org/docs>`_.
 
+
 HTMXPlugin
 ------------
 
 a Litestar plugin ``HTMXPlugin`` is available to easily configure the default request class for all Litestar routes.
 
+It can be installed via the ``litestar[htmx]`` package extra.
+
 .. code-block:: python
 
     from litestar.plugins.htmx import HTMXPlugin

pyproject.toml

@@ -43,8 +43,6 @@ dependencies = [
   "rich>=13.0.0",
   "rich-click",
   "multipart>=1.2.0",
-  # default litestar plugins
-  "litestar-htmx>=0.4.0",
 ]
 description = "Litestar - A production-ready, highly performant, extensible ASGI API Framework"
 keywords = ["api", "rest", "asgi", "litestar", "starlite"]
@@ -82,8 +80,8 @@ brotli = ["brotli"]
 cli = ["jsbeautifier", "uvicorn[standard]", "uvloop>=0.18.0; sys_platform != 'win32'"]
 cryptography = ["cryptography"]
 full = [
-  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,picologging,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version < \"3.13\"",
-  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey]; python_version >= \"3.13\"",
+  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,picologging,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey,htmx]; python_version < \"3.13\"",
+  "litestar[annotated-types,attrs,brotli,cli,cryptography,jinja,jwt,mako,minijinja,opentelemetry,piccolo,polyfactory,prometheus,pydantic,redis,sqlalchemy,standard,structlog,valkey,htmx]; python_version >= \"3.13\"",
 ]
 jinja = ["jinja2>=3.1.2"]
 jwt = ["cryptography", "pyjwt>=2.9.0"]
@@ -110,6 +108,7 @@ standard = [
 structlog = ["structlog"]
 valkey = ["valkey[libvalkey]>=6.0.2"]
 polyfactory = ["polyfactory>=2.6.3"]
+htmx = ["litestar-htmx>=0.4.0"]
 
 [project.scripts]
 litestar = "litestar.__main__:run_cli"