litestar-vite 0.1.1__py3-none-any.whl → 0.15.0__py3-none-any.whl

litestar_vite/__init__.py

@@ -1,8 +1,58 @@
-from __future__ import annotations
+"""Litestar-Vite: Seamless integration between Litestar and Vite.
 
-from litestar_vite.config import ViteConfig, ViteTemplateConfig
+This package provides integration between the Litestar web framework and
+Vite, the next-generation frontend build tool.
+
+Basic usage:
+    from litestar import Litestar
+    from litestar_vite import VitePlugin, ViteConfig
+
+    app = Litestar(
+        plugins=[VitePlugin(config=ViteConfig(dev_mode=True))],
+    )
+
+For more advanced configuration:
+    from litestar_vite import VitePlugin, ViteConfig, PathConfig, RuntimeConfig
+
+    app = Litestar(
+        plugins=[
+            VitePlugin(
+                config=ViteConfig(
+                    mode="spa",
+                    dev_mode=True,
+                    paths=PathConfig(bundle_dir=Path("dist")),
+                    runtime=RuntimeConfig(executor="bun"),
+                    types=True,
+                )
+            )
+        ],
+    )
+"""
+
+from litestar_vite import inertia
+from litestar_vite.config import (
+    DeployConfig,
+    ExternalDevServer,
+    InertiaConfig,
+    InertiaSSRConfig,
+    PathConfig,
+    RuntimeConfig,
+    TypeGenConfig,
+    ViteConfig,
+)
 from litestar_vite.loader import ViteAssetLoader
 from litestar_vite.plugin import VitePlugin
-from litestar_vite.template_engine import ViteTemplateEngine
 
-__all__ = ("ViteConfig", "ViteTemplateConfig", "VitePlugin", "ViteAssetLoader", "ViteTemplateEngine")
+__all__ = (
+    "DeployConfig",
+    "ExternalDevServer",
+    "InertiaConfig",
+    "InertiaSSRConfig",
+    "PathConfig",
+    "RuntimeConfig",
+    "TypeGenConfig",
+    "ViteAssetLoader",
+    "ViteConfig",
+    "VitePlugin",
+    "inertia",
+)

litestar_vite/__metadata__.py

@@ -1,11 +1,16 @@
 """Metadata for the Project."""
-from __future__ import annotations
 
-import importlib.metadata
+from importlib.metadata import PackageNotFoundError, metadata, version
 
-__all__ = ["__version__", "__project__"]
+__all__ = ("__project__", "__version__")
 
-__version__ = importlib.metadata.version("litestar_vite")
-"""Version of the project."""
-__project__ = importlib.metadata.metadata("litestar_vite")["Name"]
-"""Name of the project."""
+try:
+    __version__ = version("litestar_vite")
+    """Version of the project."""
+    __project__ = metadata("litestar_vite")["Name"]
+    """Name of the project."""
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0"
+    __project__ = "Litestar Vite"
+finally:
+    del version, PackageNotFoundError, metadata