raztodo-web 0.1.0__tar.gz

raztodo_web-0.1.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: raztodo-web
+Version: 0.1.0
+Summary: Web UI for RazTodo
+Keywords: raztodo,web-ui,fastapi,task-manager,local-first
+License-Expression: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: raztodo>=0.11.0
+Requires-Dist: fastapi[standard]>=0.141.1
+Maintainer: Raz
+Maintainer-email: Raz <real.raz.dev@gmail.com>
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/razbuild/raztodo-web
+Project-URL: Documentation, https://github.com/razbuild/raztodo-web#readme
+Project-URL: Repository, https://github.com/razbuild/raztodo-web
+Project-URL: Issues, https://github.com/razbuild/raztodo-web/issues
+Project-URL: Changelog, https://github.com/razbuild/raztodo-web/releases
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<h1>RazTodo Web</h1>
+
+<img src="https://raw.githubusercontent.com/razbuild/raztodo-web/main/assets/preview.png" alt="RazTodo Web task management interface">
+
+<p>
+  RazTodo Web adds a browser-based UI and a REST API on top of
+  <a href="https://github.com/razbuild/raztodo">RazTodo</a>.<br>
+  It's a presentation layer, not a replacement.
+</p>
+
+<br>
+
+</div>
+
+## What is RazTodo Web?
+
+RazTodo Web is a Vanilla **JavaScript + FastAPI** web interface for [RazTodo](https://github.com/razbuild/raztodo), built directly on top of its core.
+
+## Features
+
+| Type        | Item                   | Details                                    |
+| ----------- | ---------------------- | ------------------------------------------ |
+| 🤖 Optional | **Ollama**             | Access RazTodo's AI-powered task explanations |
+| 📋 Feature  | **Task Management**    | Create, update, complete, and delete tasks |
+| 🔎 Feature  | **Search & Filtering** | Search and filter by status                |
+| 🏷️ Feature  | **Organization**       | Priorities, tags, projects, and due dates  |
+| 📥 Feature  | **Import / Export**    | Import and export tasks as JSON            |
+| 🧹 Feature  | **Clean All**          | Delete all tasks at once                   |
+| 🌐 Feature  | **Responsive Web UI**  | Browser-based interface                    |
+| 🔌 Feature  | **REST API**           | FastAPI-powered API                        |
+| 🌓 Feature  | **Light / Dark Theme** | Light and dark themes                      |
+| 💾 Feature  | **Local-first**        | Runs locally without an external backend   |
+
+
+## Requirements
+
+* Python 3.10+
+* RazTodo 0.11.x
+
+## Architecture
+
+```text
+┌──────────────────────────────────────┐
+│             RazTodo Web              │
+│       Web UI - FastAPI - REST        │
+└──────────────────┬───────────────────┘
+                   │
+                   ▼
+┌──────────────────────────────────────┐
+│               RazTodo                │
+│    Domain - Application - Storage    │
+└──────────────────────────────────────┘
+```
+
+## Quick Start
+
+### 1. Install
+
+```bash
+pip install raztodo-web
+```
+
+RazTodo is installed automatically as a dependency.
+
+### 2. Run
+
+```bash
+rt-web
+```
+
+The server starts on `http://127.0.0.1:8000` by default.
+
+### 3. Access
+
+Once the server is running:
+
+| Service       | URL                         |
+| ------------- | --------------------------- |
+| 🌐 Web UI     | http://127.0.0.1:8000       |
+| 📖 Swagger UI | http://127.0.0.1:8000/docs  |
+| 📚 ReDoc      | http://127.0.0.1:8000/redoc |
+
+### 4. Configure
+
+Set a custom host or port with environment variables:
+
+```bash
+RAZTODO_WEB_HOST=0.0.0.0 RAZTODO_WEB_PORT=8080 rt-web
+```
+
+
+## License
+
+[![License](https://img.shields.io/github/license/razbuild/raztodo-web)](https://github.com/razbuild/raztodo-web/blob/main/LICENSE)
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/razbuild/.github/main/assets/badge.svg" alt="Made by RazBuild" width="160">
+</div>

raztodo_web-0.1.0/README.md

@@ -0,0 +1,100 @@
+<div align="center">
+
+<h1>RazTodo Web</h1>
+
+<img src="https://raw.githubusercontent.com/razbuild/raztodo-web/main/assets/preview.png" alt="RazTodo Web task management interface">
+
+<p>
+  RazTodo Web adds a browser-based UI and a REST API on top of
+  <a href="https://github.com/razbuild/raztodo">RazTodo</a>.<br>
+  It's a presentation layer, not a replacement.
+</p>
+
+<br>
+
+</div>
+
+## What is RazTodo Web?
+
+RazTodo Web is a Vanilla **JavaScript + FastAPI** web interface for [RazTodo](https://github.com/razbuild/raztodo), built directly on top of its core.
+
+## Features
+
+| Type        | Item                   | Details                                    |
+| ----------- | ---------------------- | ------------------------------------------ |
+| 🤖 Optional | **Ollama**             | Access RazTodo's AI-powered task explanations |
+| 📋 Feature  | **Task Management**    | Create, update, complete, and delete tasks |
+| 🔎 Feature  | **Search & Filtering** | Search and filter by status                |
+| 🏷️ Feature  | **Organization**       | Priorities, tags, projects, and due dates  |
+| 📥 Feature  | **Import / Export**    | Import and export tasks as JSON            |
+| 🧹 Feature  | **Clean All**          | Delete all tasks at once                   |
+| 🌐 Feature  | **Responsive Web UI**  | Browser-based interface                    |
+| 🔌 Feature  | **REST API**           | FastAPI-powered API                        |
+| 🌓 Feature  | **Light / Dark Theme** | Light and dark themes                      |
+| 💾 Feature  | **Local-first**        | Runs locally without an external backend   |
+
+
+## Requirements
+
+* Python 3.10+
+* RazTodo 0.11.x
+
+## Architecture
+
+```text
+┌──────────────────────────────────────┐
+│             RazTodo Web              │
+│       Web UI - FastAPI - REST        │
+└──────────────────┬───────────────────┘
+                   │
+                   ▼
+┌──────────────────────────────────────┐
+│               RazTodo                │
+│    Domain - Application - Storage    │
+└──────────────────────────────────────┘
+```
+
+## Quick Start
+
+### 1. Install
+
+```bash
+pip install raztodo-web
+```
+
+RazTodo is installed automatically as a dependency.
+
+### 2. Run
+
+```bash
+rt-web
+```
+
+The server starts on `http://127.0.0.1:8000` by default.
+
+### 3. Access
+
+Once the server is running:
+
+| Service       | URL                         |
+| ------------- | --------------------------- |
+| 🌐 Web UI     | http://127.0.0.1:8000       |
+| 📖 Swagger UI | http://127.0.0.1:8000/docs  |
+| 📚 ReDoc      | http://127.0.0.1:8000/redoc |
+
+### 4. Configure
+
+Set a custom host or port with environment variables:
+
+```bash
+RAZTODO_WEB_HOST=0.0.0.0 RAZTODO_WEB_PORT=8080 rt-web
+```
+
+
+## License
+
+[![License](https://img.shields.io/github/license/razbuild/raztodo-web)](https://github.com/razbuild/raztodo-web/blob/main/LICENSE)
+
+<div align="center">
+<img src="https://raw.githubusercontent.com/razbuild/.github/main/assets/badge.svg" alt="Made by RazBuild" width="160">
+</div>

raztodo_web-0.1.0/pyproject.toml

@@ -0,0 +1,68 @@
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "raztodo-web"
+version = "0.1.0"
+description = "Web UI for RazTodo"
+license = "MIT"
+requires-python = ">=3.10"
+keywords = [
+    "raztodo",
+    "web-ui",
+    "fastapi",
+    "task-manager",
+    "local-first",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "raztodo>=0.11.0",
+    "fastapi[standard]>=0.141.1",
+]
+
+[project.readme]
+file = "README.md"
+content-type = "text/markdown"
+
+[[project.maintainers]]
+name = "Raz"
+email = "real.raz.dev@gmail.com"
+
+[project.urls]
+Homepage = "https://github.com/razbuild/raztodo-web"
+Documentation = "https://github.com/razbuild/raztodo-web#readme"
+Repository = "https://github.com/razbuild/raztodo-web"
+Issues = "https://github.com/razbuild/raztodo-web/issues"
+Changelog = "https://github.com/razbuild/raztodo-web/releases"
+
+[project.scripts]
+rt-web = "raztodo_web.__main__:main"
+
+[dependency-groups]
+dev = [
+    "ruff",
+    "ty",
+    "pytest",
+]
+
+[tool.uv.build-backend]
+module-name = "raztodo_web"
+module-root = "src"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--strict-config",
+    "--strict-markers",
+]
+xfail_strict = true
+filterwarnings = ["error"]

raztodo_web-0.1.0/pyproject.toml.orig

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["uv_build>=0.12.5,<0.13"]
+build-backend = "uv_build"
+
+[project]
+name = "raztodo-web"
+version = "0.1.0"
+description = "Web UI for RazTodo"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = "MIT"
+requires-python = ">=3.10"
+maintainers = [
+    { name = "Raz", email = "real.raz.dev@gmail.com" },
+]
+keywords = [
+    "raztodo",
+    "web-ui",
+    "fastapi",
+    "task-manager",
+    "local-first",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "raztodo>=0.11.0",
+    "fastapi[standard]>=0.141.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/razbuild/raztodo-web"
+Documentation = "https://github.com/razbuild/raztodo-web#readme"
+Repository = "https://github.com/razbuild/raztodo-web"
+Issues = "https://github.com/razbuild/raztodo-web/issues"
+Changelog = "https://github.com/razbuild/raztodo-web/releases"
+
+[project.scripts]
+rt-web = "raztodo_web.__main__:main"
+
+[dependency-groups]
+dev = [
+    "ruff",
+    "ty",
+    "pytest",
+]
+
+[tool.uv.build-backend]
+module-name = "raztodo_web"
+module-root = "src"
+
+[tool.pytest.ini_options]
+addopts = ["--strict-config", "--strict-markers"]
+xfail_strict = true
+filterwarnings = ["error"]

raztodo_web-0.1.0/src/raztodo_web/__main__.py

@@ -0,0 +1,36 @@
+from __future__ import annotations
+
+import os
+
+
+def web_host() -> str:
+    return os.getenv("RAZTODO_WEB_HOST", "127.0.0.1")
+
+
+def web_port() -> int:
+    return int(os.getenv("RAZTODO_WEB_PORT", "8000"))
+
+
+def main() -> None:
+    import importlib.util
+
+    if (
+        importlib.util.find_spec("fastapi") is None
+        or importlib.util.find_spec("uvicorn") is None
+    ):
+        raise SystemExit(
+            "Web dependencies are not installed. Install with: pip install 'raztodo[web]'"
+        )
+
+    import uvicorn  # type: ignore[import]
+
+    uvicorn.run(
+        "raztodo_web.app.factory:app",
+        host=web_host(),
+        port=web_port(),
+        reload=False,
+    )
+
+
+if __name__ == "__main__":
+    main()

raztodo_web-0.1.0/src/raztodo_web/app/dependencies.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+from typing import Annotated, Any
+
+from fastapi import Depends
+from raztodo.application.factory import DefaultUseCaseFactory
+from raztodo.infrastructure.container import build_container
+from raztodo.infrastructure.sqlite.task_repository import SQLiteTaskRepository
+
+_container = build_container()
+
+
+def get_storage() -> SQLiteTaskRepository:
+    return _container.repo_singleton()
+
+
+def get_factory() -> DefaultUseCaseFactory:
+    return DefaultUseCaseFactory()
+
+
+StorageDep = Annotated[SQLiteTaskRepository, Depends(get_storage)]
+FactoryDep = Annotated[DefaultUseCaseFactory, Depends(get_factory)]
+
+
+def get_use_case(factory_method: str):
+    def _dependency(storage: StorageDep, factory: FactoryDep) -> Any:
+        return getattr(factory, factory_method)(storage)
+
+    return _dependency
+
+
+get_list_uc = get_use_case("create_list_tasks")
+get_create_uc = get_use_case("create_create_task")
+get_update_uc = get_use_case("create_update_task")
+get_delete_uc = get_use_case("create_delete_task")
+get_clear_uc = get_use_case("create_clear_tasks")
+get_mark_done_uc = get_use_case("create_mark_done")
+get_export_uc = get_use_case("create_export_tasks")
+get_import_uc = get_use_case("create_import_tasks")
+get_explain_uc = get_use_case("create_explain_task")

raztodo_web-0.1.0/src/raztodo_web/app/factory.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+from pathlib import Path
+
+from fastapi import FastAPI, Request
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+from raztodo.infrastructure.version import get_version
+
+from raztodo_web.features.explain.routes import router as explain_router
+from raztodo_web.features.tasks.routes import router as tasks_router
+
+_WEB_DIR = Path(__file__).resolve().parent.parent / "web"
+_STATIC_DIR = _WEB_DIR / "static"
+_TEMPLATES_DIR = _WEB_DIR / "templates"
+
+
+app = FastAPI(
+    title="RazTodo",
+    description="Local web interface for RazTodo",
+    version=get_version(),
+)
+
+app.mount(
+    "/static",
+    StaticFiles(directory=_STATIC_DIR),
+    name="static",
+)
+
+templates = Jinja2Templates(directory=_TEMPLATES_DIR)
+
+app.include_router(tasks_router)
+app.include_router(explain_router)
+
+
+@app.get("/", include_in_schema=False)
+async def index(request: Request):
+    """Serve the single-page UI, rendered from templates/index.html."""
+    return templates.TemplateResponse(request, "index.html")

raztodo_web-0.1.0/src/raztodo_web/features/explain/routes.py

@@ -0,0 +1,42 @@
+from typing import Any
+
+from fastapi import APIRouter, Depends, HTTPException
+from fastapi.responses import StreamingResponse
+from raztodo.domain.exceptions import RazTodoException
+
+from raztodo_web.app.dependencies import get_explain_uc
+
+router = APIRouter(prefix="/api/tasks", tags=["tasks"])
+
+
+@router.get("/{task_id}/explain")
+def explain_task(
+    task_id: int,
+    mode: str = "short",
+    uc: Any = Depends(get_explain_uc),  # noqa: B008
+) -> StreamingResponse:
+    """
+    Stream the LLM explanation as Server-Sent Events (SSE).
+    Each event: data: <token>\n\n
+    Final event: data: [DONE]\n\n
+    """
+    if mode not in ("short", "deep", "plan"):
+        raise HTTPException(
+            status_code=422, detail="mode must be: short, deep, or plan"
+        )
+
+    def _sse_generator():
+        try:
+            for token in uc.stream(task_id, mode=mode):
+                safe = token.replace("\n", "\\n")
+                yield f"data: {safe}\n\n"
+        except RazTodoException as _exc:
+            yield "event: error\ndata: An internal error occurred.\n\n"
+        finally:
+            yield "data: [DONE]\n\n"
+
+    return StreamingResponse(
+        _sse_generator(),
+        media_type="text/event-stream",
+        headers={"Cache-Control": "no-cache", "X-Accel-Buffering": "no"},
+    )

raztodo_web-0.1.0/src/raztodo_web/features/tasks/helpers.py

@@ -0,0 +1,23 @@
+import os
+from typing import Any
+
+from raztodo_web.features.tasks.schemas import TaskResponse
+
+
+def remove_file(path: str) -> None:
+    if os.path.exists(path):
+        os.unlink(path)
+
+
+def task_to_response(task: Any) -> TaskResponse:
+    return TaskResponse(
+        id=task.id,
+        title=task.title,
+        description=getattr(task, "description", "") or "",
+        done=getattr(task, "done", False),
+        created_at=getattr(task, "created_at", "") or "",
+        priority=getattr(task, "priority", "") or "",
+        due_date=getattr(task, "due_date", None),
+        tags=list(getattr(task, "tags", None) or []),
+        project=getattr(task, "project", None),
+    )