httk-web 0.1.0__py3-none-any.whl

httk/web/__init__.py

@@ -0,0 +1,3 @@
+from .api import create_asgi_app, publish, serve
+
+__all__ = ["create_asgi_app", "serve", "publish"]

httk/web/api.py

@@ -0,0 +1,71 @@
+from pathlib import Path
+
+from starlette.applications import Starlette
+
+from .engine.site_engine import SiteEngine
+from .model.config import SiteConfig
+from .model.page import PublishReport
+from .publishing.static import publish_site
+from .runtime.asgi import create_app
+from .runtime.devserver import run_dev_server
+
+
+def create_asgi_app(
+    srcdir: str | Path,
+    *,
+    baseurl: str | None = None,
+    compatibility_mode: bool = False,
+    config_name: str = "config",
+    debug: bool = False,
+) -> Starlette:
+    config = SiteConfig.from_srcdir(
+        srcdir=srcdir,
+        baseurl=baseurl,
+        compatibility_mode=compatibility_mode,
+        config_name=config_name,
+    )
+    engine = SiteEngine(config)
+    return create_app(engine=engine, debug=debug)
+
+
+def serve(
+    srcdir: str | Path,
+    *,
+    host: str = "127.0.0.1",
+    port: int = 8080,
+    baseurl: str | None = None,
+    compatibility_mode: bool = False,
+    config_name: str = "config",
+    debug: bool = False,
+) -> None:
+    app = create_asgi_app(
+        srcdir=srcdir,
+        baseurl=baseurl,
+        compatibility_mode=compatibility_mode,
+        config_name=config_name,
+        debug=debug,
+    )
+    run_dev_server(app=app, host=host, port=port)
+
+
+def publish(
+    srcdir: str | Path,
+    outdir: str | Path,
+    baseurl: str,
+    *,
+    host_static: str | None = None,
+    compatibility_mode: bool = False,
+    config_name: str = "config",
+    use_urls_without_ext: bool | None = None,
+) -> PublishReport:
+    publish_use_urls_without_ext = use_urls_without_ext if use_urls_without_ext is not None else not compatibility_mode
+    config = SiteConfig.from_srcdir(
+        srcdir=srcdir,
+        baseurl=baseurl,
+        host_static=host_static,
+        compatibility_mode=compatibility_mode,
+        config_name=config_name,
+        publish_use_urls_without_ext=publish_use_urls_without_ext,
+    )
+    engine = SiteEngine(config)
+    return publish_site(engine=engine, outdir=outdir)

httk/web/compat/__init__.py

@@ -0,0 +1 @@
+# Placeholder package for compatibility helpers.

httk/web/engine/__init__.py

@@ -0,0 +1,3 @@
+from .site_engine import SiteEngine
+
+__all__ = ["SiteEngine"]

httk/web/engine/discovery.py

@@ -0,0 +1,51 @@
+from pathlib import Path
+
+from httk.web.model.config import SiteConfig
+from httk.web.model.page import ResolvedRoute
+
+DEFAULT_CONTENT_EXTENSIONS: tuple[str, ...] = (".md", ".rst", ".html", ".httkweb")
+
+
+def normalize_route(route: str) -> str:
+    normalized = route.lstrip("/").strip()
+    if normalized in {"", "."}:
+        return "index"
+    return normalized
+
+
+def _is_within(path: Path, root: Path) -> bool:
+    try:
+        path.resolve().relative_to(root.resolve())
+        return True
+    except ValueError:
+        return False
+
+
+def resolve_route(config: SiteConfig, route: str) -> ResolvedRoute:
+    normalized = normalize_route(route)
+
+    static_candidate = (config.static_dir / normalized).resolve()
+    if static_candidate.exists() and static_candidate.is_file() and _is_within(static_candidate, config.static_dir):
+        return ResolvedRoute(kind="static", route=normalized, source_path=static_candidate)
+
+    content = _resolve_content_route(content_dir=config.content_dir, route=normalized)
+    if content is not None:
+        return ResolvedRoute(kind="content", route=normalized, source_path=content)
+
+    return ResolvedRoute(kind="missing", route=normalized)
+
+
+def _resolve_content_route(content_dir: Path, route: str) -> Path | None:
+    route_path = Path(route)
+
+    if route_path.suffix:
+        candidate = (content_dir / route_path).resolve()
+        if candidate.exists() and candidate.is_file() and _is_within(candidate, content_dir):
+            return candidate
+
+    for ext in DEFAULT_CONTENT_EXTENSIONS:
+        candidate = (content_dir / route_path).with_suffix(ext).resolve()
+        if candidate.exists() and candidate.is_file() and _is_within(candidate, content_dir):
+            return candidate
+
+    return None