feat: introduce lfx package

.github/workflows/python_test.yml

@@ -124,6 +124,28 @@ jobs:
           PYLEAK_LOG_LEVEL: debug # enable pyleak logging
           DO_NOT_TRACK: true # disable telemetry reporting
 
+  lfx-tests:
+    name: LFX Tests - Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ${{ fromJson(inputs.python-versions || '["3.10", "3.11", "3.12", "3.13"]' ) }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.ref || github.ref }}
+      - name: "Setup Environment"
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
+          python-version: ${{ matrix.python-version }}
+          prune-cache: false
+      - name: Run lfx tests
+        run: make lfx_tests
+        env:
+          DO_NOT_TRACK: true # disable telemetry reporting
+
   test-cli:
     name: Test CLI - Python ${{ matrix.python-version }}
     runs-on: ubuntu-latest

.vscode/launch.json

@@ -19,7 +19,9 @@
         "--loop",
         "asyncio",
         "--reload-include",
-        "./src/backend/*"
+        "./src/backend/*",
+        "--reload-include",
+        "./src/lfx/*"
       ],
       "jinja": true,
       "justMyCode": false,

Makefile

@@ -138,6 +138,12 @@ unit_tests: ## run unit tests
 unit_tests_looponfail:
 	@make unit_tests args="-f"
 
+lfx_tests: ## run lfx package unit tests
+	@echo 'Running LFX Package Tests...'
+	@cd src/lfx && \
+	uv sync && \
+	uv run pytest tests/unit -v $(args)
+
 integration_tests:
 	uv run pytest src/backend/tests/integration \
 		--instafail -ra \

pyproject.toml

@@ -18,6 +18,7 @@ maintainers = [
 # Define your main dependencies here
 dependencies = [
     "langflow-base~=0.5.0",
+    "lfx~=0.1.0",
     "beautifulsoup4==4.12.3",
     "google-search-results>=2.4.1,<3.0.0",
     "google-api-python-client==2.154.0",
@@ -181,9 +182,14 @@ dev = [
 [tool.uv.sources]
 langflow-base = { workspace = true }
 langflow = { workspace = true }
+lfx = { workspace = true }
 
 [tool.uv.workspace]
-members = ["src/backend/base", "."]
+members = [
+    "src/backend/base",
+ ".",
+ "src/lfx",
+]
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/backend/langflow"]
@@ -299,6 +305,7 @@ ignore = [
 
     # Rules that are TODOs
     "ANN",
+    "D10"
 ]
 
 # Preview rules that are not yet activated

scripts/ci/update_starter_projects.py

@@ -11,10 +11,11 @@
     update_project_file,
     update_projects_components_with_latest_component_versions,
 )
-from langflow.interface.components import get_and_cache_all_types_dict
-from langflow.services.deps import get_settings_service
 from langflow.services.utils import initialize_services
 
+from lfx.interface.components import get_and_cache_all_types_dict
+from lfx.services.deps import get_settings_service
+
 
 async def main():
     """Updates the starter projects with the latest component versions.

src/backend/base/langflow/api/build.py

@@ -6,6 +6,8 @@
 from collections.abc import AsyncIterator
 
 from fastapi import BackgroundTasks, HTTPException, Response
+from lfx.graph.graph.base import Graph
+from lfx.graph.utils import log_vertex_build
 from loguru import logger
 from sqlmodel import select
 
@@ -28,8 +30,6 @@
 )
 from langflow.events.event_manager import EventManager
 from langflow.exceptions.component import ComponentBuildError
-from langflow.graph.graph.base import Graph
-from langflow.graph.utils import log_vertex_build
 from langflow.schema.message import ErrorMessage
 from langflow.schema.schema import OutputValue
 from langflow.services.database.models.flow.model import Flow

src/backend/base/langflow/api/limited_background_tasks.py

@@ -1,6 +1,6 @@
 from fastapi import BackgroundTasks
+from lfx.graph.utils import log_vertex_build
 
-from langflow.graph.utils import log_vertex_build
 from langflow.services.deps import get_settings_service
 
 

src/backend/base/langflow/api/utils.py

@@ -8,11 +8,11 @@
 
 from fastapi import Depends, HTTPException, Query
 from fastapi_pagination import Params
+from lfx.graph.graph.base import Graph
 from loguru import logger
 from sqlalchemy import delete
 from sqlmodel.ext.asyncio.session import AsyncSession
 
-from langflow.graph.graph.base import Graph
 from langflow.services.auth.utils import get_current_active_user, get_current_active_user_mcp
 from langflow.services.database.models.flow.model import Flow
 from langflow.services.database.models.message.model import MessageTable

src/backend/base/langflow/api/v1/base.py

@@ -1,7 +1,6 @@
+from lfx.template.frontend_node.base import FrontendNode
 from pydantic import BaseModel, field_validator, model_serializer
 
-from langflow.template.frontend_node.base import FrontendNode
-
 
 class CacheResponse(BaseModel):
     data: dict

src/backend/base/langflow/api/v1/callback.py

@@ -9,11 +9,11 @@
 from typing_extensions import override
 
 from langflow.api.v1.schemas import ChatResponse, PromptResponse
-from langflow.services.deps import get_chat_service, get_socket_service
+from langflow.services.deps import get_chat_service
 from langflow.utils.util import remove_ansi_escape_codes
 
 if TYPE_CHECKING:
-    from langflow.services.socket.service import SocketIOService
+    pass
 
 
 # https://github.com/hwchase17/chat-langchain/blob/master/callback.py
@@ -28,9 +28,7 @@ def ignore_chain(self) -> bool:
     def __init__(self, session_id: str):
         self.chat_service = get_chat_service()
         self.client_id = session_id
-        self.socketio_service: SocketIOService = get_socket_service()
         self.sid = session_id
-        # self.socketio_service = self.chat_service.active_connections[self.client_id]
 
     @override
     async def on_llm_new_token(self, token: str, **kwargs: Any) -> None:  # type: ignore[misc]

src/backend/base/langflow/api/v1/chat.py

@@ -16,6 +16,9 @@
     status,
 )
 from fastapi.responses import StreamingResponse
+from lfx.graph.graph.base import Graph
+from lfx.graph.utils import log_vertex_build
+from lfx.services.cache.utils import CacheMiss
 from loguru import logger
 
 from langflow.api.build import (
@@ -46,10 +49,7 @@
     VerticesOrderResponse,
 )
 from langflow.exceptions.component import ComponentBuildError
-from langflow.graph.graph.base import Graph
-from langflow.graph.utils import log_vertex_build
 from langflow.schema.schema import OutputValue
-from langflow.services.cache.utils import CacheMiss
 from langflow.services.chat.service import ChatService
 from langflow.services.database.models.flow.model import Flow
 from langflow.services.deps import (
@@ -63,7 +63,7 @@
 from langflow.services.telemetry.schema import ComponentPayload, PlaygroundPayload
 
 if TYPE_CHECKING:
-    from langflow.graph.vertex.vertex_types import InterfaceVertex
+    from lfx.graph.vertex.vertex_types import InterfaceVertex
 
 router = APIRouter(tags=["Chat"])
 

src/backend/base/langflow/api/v1/endpoints.py

@@ -11,6 +11,15 @@
 from fastapi import APIRouter, BackgroundTasks, Body, Depends, HTTPException, Request, UploadFile, status
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import StreamingResponse
+from lfx.custom.custom_component.component import Component
+from lfx.custom.utils import (
+    add_code_field_to_build_config,
+    build_custom_component_template,
+    get_instance_name,
+    update_component_build_config,
+)
+from lfx.graph.graph.base import Graph
+from lfx.graph.schema import RunOutputs
 from loguru import logger
 from sqlmodel import select
 
@@ -26,18 +35,9 @@
     UpdateCustomComponentRequest,
     UploadFileResponse,
 )
-from langflow.custom.custom_component.component import Component
-from langflow.custom.utils import (
-    add_code_field_to_build_config,
-    build_custom_component_template,
-    get_instance_name,
-    update_component_build_config,
-)
 from langflow.events.event_manager import create_stream_tokens_event_manager
 from langflow.exceptions.api import APIException, InvalidChatInputError
 from langflow.exceptions.serialization import SerializationError
-from langflow.graph.graph.base import Graph
-from langflow.graph.schema import RunOutputs
 from langflow.helpers.flow import get_flow_by_id_or_endpoint_name
 from langflow.helpers.user import get_user_by_flow_id_or_endpoint_name
 from langflow.interface.initialize.loading import update_params_with_load_from_db_fields

src/backend/base/langflow/api/v1/mcp_projects.py

@@ -14,6 +14,9 @@
 from anyio import BrokenResourceError
 from fastapi import APIRouter, HTTPException, Request, Response
 from fastapi.responses import HTMLResponse
+from lfx.base.mcp.constants import MAX_MCP_SERVER_NAME_LENGTH
+from lfx.base.mcp.util import sanitize_mcp_name
+from lfx.services.deps import get_settings_service, session_scope
 from mcp import types
 from mcp.server import NotificationOptions, Server
 from mcp.server.sse import SseServerTransport
@@ -35,10 +38,7 @@
     MCPProjectUpdateRequest,
     MCPSettings,
 )
-from langflow.base.mcp.constants import MAX_MCP_SERVER_NAME_LENGTH
-from langflow.base.mcp.util import sanitize_mcp_name
 from langflow.services.database.models import Flow, Folder
-from langflow.services.deps import get_settings_service, session_scope
 from langflow.services.settings.feature_flags import FEATURE_FLAGS
 
 logger = logging.getLogger(__name__)
@@ -153,8 +153,8 @@ async def handle_project_sse(
             await session.exec(select(Folder).where(Folder.id == project_id, Folder.user_id == current_user.id))
         ).first()
 
-        if not project:
-            raise HTTPException(status_code=404, detail="Project not found")
+    if not project:
+        raise HTTPException(status_code=404, detail="Project not found")
 
     # Get project-specific SSE transport and MCP server
     sse = get_project_sse(project_id)

src/backend/base/langflow/api/v1/mcp_utils.py

@@ -12,14 +12,14 @@
 from urllib.parse import quote, unquote, urlparse
 from uuid import uuid4
 
+from lfx.base.mcp.constants import MAX_MCP_TOOL_NAME_LENGTH
+from lfx.base.mcp.util import get_flow_snake_case, get_unique_name, sanitize_mcp_name
 from loguru import logger
 from mcp import types
 from sqlmodel import select
 
 from langflow.api.v1.endpoints import simple_run_flow
 from langflow.api.v1.schemas import SimplifiedAPIRequest
-from langflow.base.mcp.constants import MAX_MCP_TOOL_NAME_LENGTH
-from langflow.base.mcp.util import get_flow_snake_case, get_unique_name, sanitize_mcp_name
 from langflow.helpers.flow import json_schema_from_flow
 from langflow.schema.message import Message
 from langflow.services.database.models import Flow

src/backend/base/langflow/api/v1/schemas.py

@@ -4,6 +4,7 @@
 from typing import Any, Literal
 from uuid import UUID
 
+from lfx.graph.schema import RunOutputs
 from pydantic import (
     BaseModel,
     ConfigDict,
@@ -14,7 +15,6 @@
     model_serializer,
 )
 
-from langflow.graph.schema import RunOutputs
 from langflow.schema.dotdict import dotdict
 from langflow.schema.graph import Tweaks
 from langflow.schema.schema import InputType, OutputType, OutputValue

src/backend/base/langflow/api/v1/starter_projects.py

@@ -1,17 +1,75 @@
+from typing import Any
+
 from fastapi import APIRouter, Depends, HTTPException
+from pydantic import BaseModel
 
-from langflow.graph.graph.schema import GraphDump
 from langflow.services.auth.utils import get_current_active_user
 
 router = APIRouter(prefix="/starter-projects", tags=["Flows"])
 
 
+# Pydantic models for API schema compatibility
+class ViewPort(BaseModel):
+    x: float
+    y: float
+    zoom: float
+
+
+class NodeData(BaseModel):
+    # This is a simplified version - the actual NodeData has many more fields
+    # but we only need the basic structure for the API schema
+    model_config = {"extra": "allow"}  # Allow extra fields
+
+
+class EdgeData(BaseModel):
+    # This is a simplified version - the actual EdgeData has many more fields
+    # but we only need the basic structure for the API schema
+    model_config = {"extra": "allow"}  # Allow extra fields
+
+
+class GraphData(BaseModel):
+    nodes: list[dict[str, Any]]  # Use dict to be flexible with the complex NodeData structure
+    edges: list[dict[str, Any]]  # Use dict to be flexible with the complex EdgeData structure
+    viewport: ViewPort | None = None
+
+
+class GraphDumpResponse(BaseModel):
+    data: GraphData
+    is_component: bool | None = None
+    name: str | None = None
+    description: str | None = None
+    endpoint_name: str | None = None
+
+
 @router.get("/", dependencies=[Depends(get_current_active_user)], status_code=200)
-async def get_starter_projects() -> list[GraphDump]:
+async def get_starter_projects() -> list[GraphDumpResponse]:
     """Get a list of starter projects."""
     from langflow.initial_setup.load import get_starter_projects_dump
 
     try:
-        return get_starter_projects_dump()
+        # Get the raw data from lfx GraphDump
+        raw_data = get_starter_projects_dump()
+
+        # Convert TypedDict GraphDump to Pydantic GraphDumpResponse
+        results = []
+        for item in raw_data:
+            # Create GraphData
+            graph_data = GraphData(
+                nodes=item.get("data", {}).get("nodes", []),
+                edges=item.get("data", {}).get("edges", []),
+                viewport=item.get("data", {}).get("viewport"),
+            )
+
+            # Create GraphDumpResponse
+            graph_dump = GraphDumpResponse(
+                data=graph_data,
+                is_component=item.get("is_component"),
+                name=item.get("name"),
+                description=item.get("description"),
+                endpoint_name=item.get("endpoint_name"),
+            )
+            results.append(graph_dump)
+
     except Exception as exc:
         raise HTTPException(status_code=500, detail=str(exc)) from exc
+    return results

src/backend/base/langflow/api/v1/validate.py

@@ -1,9 +1,9 @@
 from fastapi import APIRouter, HTTPException
+from lfx.base.prompts.api_utils import process_prompt_template
 from loguru import logger
 
 from langflow.api.utils import CurrentActiveUser
 from langflow.api.v1.base import Code, CodeValidationResponse, PromptValidationResponse, ValidatePromptRequest
-from langflow.base.prompts.api_utils import process_prompt_template
 from langflow.utils.validate import validate_code
 
 # build router