basic-memory 0.16.1__py3-none-any.whl → 0.17.4__py3-none-any.whl

basic_memory/deps/db.py

@@ -0,0 +1,56 @@
+"""Database dependency injection for basic-memory.
+
+This module provides database-related dependencies:
+- Engine and session maker factories
+- Session dependencies for request handling
+"""
+
+from typing import Annotated
+
+from fastapi import Depends, Request
+from loguru import logger
+from sqlalchemy.ext.asyncio import (
+    AsyncEngine,
+    AsyncSession,
+    async_sessionmaker,
+)
+
+from basic_memory import db
+from basic_memory.deps.config import get_app_config
+
+
+async def get_engine_factory(
+    request: Request,
+) -> tuple[AsyncEngine, async_sessionmaker[AsyncSession]]:  # pragma: no cover
+    """Get cached engine and session maker from app state.
+
+    For API requests, returns cached connections from app.state for optimal performance.
+    For non-API contexts (CLI), falls back to direct database connection.
+    """
+    # Try to get cached connections from app state (API context)
+    if (
+        hasattr(request, "app")
+        and hasattr(request.app.state, "engine")
+        and hasattr(request.app.state, "session_maker")
+    ):
+        return request.app.state.engine, request.app.state.session_maker
+
+    # Fallback for non-API contexts (CLI)
+    logger.debug("Using fallback database connection for non-API context")
+    app_config = get_app_config()
+    engine, session_maker = await db.get_or_create_db(app_config.database_path)
+    return engine, session_maker
+
+
+EngineFactoryDep = Annotated[
+    tuple[AsyncEngine, async_sessionmaker[AsyncSession]], Depends(get_engine_factory)
+]
+
+
+async def get_session_maker(engine_factory: EngineFactoryDep) -> async_sessionmaker[AsyncSession]:
+    """Get session maker."""
+    _, session_maker = engine_factory
+    return session_maker
+
+
+SessionMakerDep = Annotated[async_sessionmaker, Depends(get_session_maker)]

basic_memory/deps/importers.py

@@ -0,0 +1,200 @@
+"""Importer dependency injection for basic-memory.
+
+This module provides importer dependencies:
+- ChatGPTImporter
+- ClaudeConversationsImporter
+- ClaudeProjectsImporter
+- MemoryJsonImporter
+"""
+
+from typing import Annotated
+
+from fastapi import Depends
+
+from basic_memory.deps.projects import (
+    ProjectConfigDep,
+    ProjectConfigV2Dep,
+    ProjectConfigV2ExternalDep,
+)
+from basic_memory.deps.services import (
+    FileServiceDep,
+    FileServiceV2Dep,
+    FileServiceV2ExternalDep,
+    MarkdownProcessorDep,
+    MarkdownProcessorV2Dep,
+    MarkdownProcessorV2ExternalDep,
+)
+from basic_memory.importers import (
+    ChatGPTImporter,
+    ClaudeConversationsImporter,
+    ClaudeProjectsImporter,
+    MemoryJsonImporter,
+)
+
+
+# --- ChatGPT Importer ---
+
+
+async def get_chatgpt_importer(
+    project_config: ProjectConfigDep,
+    markdown_processor: MarkdownProcessorDep,
+    file_service: FileServiceDep,
+) -> ChatGPTImporter:
+    """Create ChatGPTImporter with dependencies."""
+    return ChatGPTImporter(project_config.home, markdown_processor, file_service)
+
+
+ChatGPTImporterDep = Annotated[ChatGPTImporter, Depends(get_chatgpt_importer)]
+
+
+async def get_chatgpt_importer_v2(  # pragma: no cover
+    project_config: ProjectConfigV2Dep,
+    markdown_processor: MarkdownProcessorV2Dep,
+    file_service: FileServiceV2Dep,
+) -> ChatGPTImporter:
+    """Create ChatGPTImporter with v2 dependencies."""
+    return ChatGPTImporter(project_config.home, markdown_processor, file_service)
+
+
+ChatGPTImporterV2Dep = Annotated[ChatGPTImporter, Depends(get_chatgpt_importer_v2)]
+
+
+async def get_chatgpt_importer_v2_external(
+    project_config: ProjectConfigV2ExternalDep,
+    markdown_processor: MarkdownProcessorV2ExternalDep,
+    file_service: FileServiceV2ExternalDep,
+) -> ChatGPTImporter:
+    """Create ChatGPTImporter with v2 external_id dependencies."""
+    return ChatGPTImporter(project_config.home, markdown_processor, file_service)
+
+
+ChatGPTImporterV2ExternalDep = Annotated[ChatGPTImporter, Depends(get_chatgpt_importer_v2_external)]
+
+
+# --- Claude Conversations Importer ---
+
+
+async def get_claude_conversations_importer(
+    project_config: ProjectConfigDep,
+    markdown_processor: MarkdownProcessorDep,
+    file_service: FileServiceDep,
+) -> ClaudeConversationsImporter:
+    """Create ClaudeConversationsImporter with dependencies."""
+    return ClaudeConversationsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeConversationsImporterDep = Annotated[
+    ClaudeConversationsImporter, Depends(get_claude_conversations_importer)
+]
+
+
+async def get_claude_conversations_importer_v2(  # pragma: no cover
+    project_config: ProjectConfigV2Dep,
+    markdown_processor: MarkdownProcessorV2Dep,
+    file_service: FileServiceV2Dep,
+) -> ClaudeConversationsImporter:
+    """Create ClaudeConversationsImporter with v2 dependencies."""
+    return ClaudeConversationsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeConversationsImporterV2Dep = Annotated[
+    ClaudeConversationsImporter, Depends(get_claude_conversations_importer_v2)
+]
+
+
+async def get_claude_conversations_importer_v2_external(
+    project_config: ProjectConfigV2ExternalDep,
+    markdown_processor: MarkdownProcessorV2ExternalDep,
+    file_service: FileServiceV2ExternalDep,
+) -> ClaudeConversationsImporter:
+    """Create ClaudeConversationsImporter with v2 external_id dependencies."""
+    return ClaudeConversationsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeConversationsImporterV2ExternalDep = Annotated[
+    ClaudeConversationsImporter, Depends(get_claude_conversations_importer_v2_external)
+]
+
+
+# --- Claude Projects Importer ---
+
+
+async def get_claude_projects_importer(
+    project_config: ProjectConfigDep,
+    markdown_processor: MarkdownProcessorDep,
+    file_service: FileServiceDep,
+) -> ClaudeProjectsImporter:
+    """Create ClaudeProjectsImporter with dependencies."""
+    return ClaudeProjectsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeProjectsImporterDep = Annotated[ClaudeProjectsImporter, Depends(get_claude_projects_importer)]
+
+
+async def get_claude_projects_importer_v2(  # pragma: no cover
+    project_config: ProjectConfigV2Dep,
+    markdown_processor: MarkdownProcessorV2Dep,
+    file_service: FileServiceV2Dep,
+) -> ClaudeProjectsImporter:
+    """Create ClaudeProjectsImporter with v2 dependencies."""
+    return ClaudeProjectsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeProjectsImporterV2Dep = Annotated[
+    ClaudeProjectsImporter, Depends(get_claude_projects_importer_v2)
+]
+
+
+async def get_claude_projects_importer_v2_external(
+    project_config: ProjectConfigV2ExternalDep,
+    markdown_processor: MarkdownProcessorV2ExternalDep,
+    file_service: FileServiceV2ExternalDep,
+) -> ClaudeProjectsImporter:
+    """Create ClaudeProjectsImporter with v2 external_id dependencies."""
+    return ClaudeProjectsImporter(project_config.home, markdown_processor, file_service)
+
+
+ClaudeProjectsImporterV2ExternalDep = Annotated[
+    ClaudeProjectsImporter, Depends(get_claude_projects_importer_v2_external)
+]
+
+
+# --- Memory JSON Importer ---
+
+
+async def get_memory_json_importer(
+    project_config: ProjectConfigDep,
+    markdown_processor: MarkdownProcessorDep,
+    file_service: FileServiceDep,
+) -> MemoryJsonImporter:
+    """Create MemoryJsonImporter with dependencies."""
+    return MemoryJsonImporter(project_config.home, markdown_processor, file_service)
+
+
+MemoryJsonImporterDep = Annotated[MemoryJsonImporter, Depends(get_memory_json_importer)]
+
+
+async def get_memory_json_importer_v2(  # pragma: no cover
+    project_config: ProjectConfigV2Dep,
+    markdown_processor: MarkdownProcessorV2Dep,
+    file_service: FileServiceV2Dep,
+) -> MemoryJsonImporter:
+    """Create MemoryJsonImporter with v2 dependencies."""
+    return MemoryJsonImporter(project_config.home, markdown_processor, file_service)
+
+
+MemoryJsonImporterV2Dep = Annotated[MemoryJsonImporter, Depends(get_memory_json_importer_v2)]
+
+
+async def get_memory_json_importer_v2_external(
+    project_config: ProjectConfigV2ExternalDep,
+    markdown_processor: MarkdownProcessorV2ExternalDep,
+    file_service: FileServiceV2ExternalDep,
+) -> MemoryJsonImporter:
+    """Create MemoryJsonImporter with v2 external_id dependencies."""
+    return MemoryJsonImporter(project_config.home, markdown_processor, file_service)
+
+
+MemoryJsonImporterV2ExternalDep = Annotated[
+    MemoryJsonImporter, Depends(get_memory_json_importer_v2_external)
+]

basic_memory/deps/projects.py

@@ -0,0 +1,238 @@
+"""Project dependency injection for basic-memory.
+
+This module provides project-related dependencies:
+- Project path extraction from URL
+- Project config resolution
+- Project ID validation
+- Project repository
+"""
+
+import pathlib
+from typing import Annotated
+
+from fastapi import Depends, HTTPException, Path, status
+
+from basic_memory.config import ProjectConfig
+from basic_memory.deps.db import SessionMakerDep
+from basic_memory.repository.project_repository import ProjectRepository
+from basic_memory.utils import generate_permalink
+
+
+# --- Project Repository ---
+
+
+async def get_project_repository(
+    session_maker: SessionMakerDep,
+) -> ProjectRepository:
+    """Get the project repository."""
+    return ProjectRepository(session_maker)
+
+
+ProjectRepositoryDep = Annotated[ProjectRepository, Depends(get_project_repository)]
+
+
+# --- Path Extraction ---
+
+# V1 API: Project name from URL path
+ProjectPathDep = Annotated[str, Path()]
+
+
+# --- Project ID Resolution (V1 API) ---
+
+
+async def get_project_id(
+    project_repository: ProjectRepositoryDep,
+    project: ProjectPathDep,
+) -> int:
+    """Get the current project ID from request state.
+
+    When using sub-applications with /{project} mounting, the project value
+    is stored in request.state by middleware.
+
+    Args:
+        project_repository: Repository for project operations
+        project: The project name from URL path
+
+    Returns:
+        The resolved project ID
+
+    Raises:
+        HTTPException: If project is not found
+    """
+    # Convert project name to permalink for lookup
+    project_permalink = generate_permalink(str(project))
+    project_obj = await project_repository.get_by_permalink(project_permalink)
+    if project_obj:
+        return project_obj.id
+
+    # Try by name if permalink lookup fails
+    project_obj = await project_repository.get_by_name(str(project))  # pragma: no cover
+    if project_obj:  # pragma: no cover
+        return project_obj.id
+
+    # Not found
+    raise HTTPException(  # pragma: no cover
+        status_code=status.HTTP_404_NOT_FOUND, detail=f"Project '{project}' not found."
+    )
+
+
+ProjectIdDep = Annotated[int, Depends(get_project_id)]
+
+
+# --- Project Config Resolution (V1 API) ---
+
+
+async def get_project_config(
+    project: ProjectPathDep, project_repository: ProjectRepositoryDep
+) -> ProjectConfig:  # pragma: no cover
+    """Get the current project referenced from request state.
+
+    Args:
+        project: The project name from URL path
+        project_repository: Repository for project operations
+
+    Returns:
+        The resolved project config
+
+    Raises:
+        HTTPException: If project is not found
+    """
+    # Convert project name to permalink for lookup
+    project_permalink = generate_permalink(str(project))
+    project_obj = await project_repository.get_by_permalink(project_permalink)
+    if project_obj:
+        return ProjectConfig(name=project_obj.name, home=pathlib.Path(project_obj.path))
+
+    # Not found
+    raise HTTPException(  # pragma: no cover
+        status_code=status.HTTP_404_NOT_FOUND, detail=f"Project '{project}' not found."
+    )
+
+
+ProjectConfigDep = Annotated[ProjectConfig, Depends(get_project_config)]
+
+
+# --- V2 API: Integer Project ID from Path ---
+
+
+async def validate_project_id(
+    project_id: int,
+    project_repository: ProjectRepositoryDep,
+) -> int:
+    """Validate that a numeric project ID exists in the database.
+
+    This is used for v2 API endpoints that take project IDs as integers in the path.
+    The project_id parameter will be automatically extracted from the URL path by FastAPI.
+
+    Args:
+        project_id: The numeric project ID from the URL path
+        project_repository: Repository for project operations
+
+    Returns:
+        The validated project ID
+
+    Raises:
+        HTTPException: If project with that ID is not found
+    """
+    project_obj = await project_repository.get_by_id(project_id)
+    if not project_obj:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail=f"Project with ID {project_id} not found.",
+        )
+    return project_id
+
+
+ProjectIdPathDep = Annotated[int, Depends(validate_project_id)]
+
+
+async def get_project_config_v2(
+    project_id: ProjectIdPathDep, project_repository: ProjectRepositoryDep
+) -> ProjectConfig:  # pragma: no cover
+    """Get the project config for v2 API (uses integer project_id from path).
+
+    Args:
+        project_id: The validated numeric project ID from the URL path
+        project_repository: Repository for project operations
+
+    Returns:
+        The resolved project config
+
+    Raises:
+        HTTPException: If project is not found
+    """
+    project_obj = await project_repository.get_by_id(project_id)
+    if project_obj:
+        return ProjectConfig(name=project_obj.name, home=pathlib.Path(project_obj.path))
+
+    # Not found (this should not happen since ProjectIdPathDep already validates existence)
+    raise HTTPException(  # pragma: no cover
+        status_code=status.HTTP_404_NOT_FOUND, detail=f"Project with ID {project_id} not found."
+    )
+
+
+ProjectConfigV2Dep = Annotated[ProjectConfig, Depends(get_project_config_v2)]
+
+
+# --- V2 API: External UUID Project ID from Path ---
+
+
+async def validate_project_external_id(
+    project_id: str,
+    project_repository: ProjectRepositoryDep,
+) -> int:
+    """Validate that a project external_id (UUID) exists in the database.
+
+    This is used for v2 API endpoints that take project external_ids as strings in the path.
+    The project_id parameter will be automatically extracted from the URL path by FastAPI.
+
+    Args:
+        project_id: The external UUID from the URL path (named project_id for URL consistency)
+        project_repository: Repository for project operations
+
+    Returns:
+        The internal numeric project ID (for use by repositories)
+
+    Raises:
+        HTTPException: If project with that external_id is not found
+    """
+    project_obj = await project_repository.get_by_external_id(project_id)
+    if not project_obj:
+        raise HTTPException(
+            status_code=status.HTTP_404_NOT_FOUND,
+            detail=f"Project with external_id '{project_id}' not found.",
+        )
+    return project_obj.id
+
+
+ProjectExternalIdPathDep = Annotated[int, Depends(validate_project_external_id)]
+
+
+async def get_project_config_v2_external(
+    project_id: ProjectExternalIdPathDep, project_repository: ProjectRepositoryDep
+) -> ProjectConfig:  # pragma: no cover
+    """Get the project config for v2 API (uses external_id UUID from path).
+
+    Args:
+        project_id: The internal project ID resolved from external_id
+        project_repository: Repository for project operations
+
+    Returns:
+        The resolved project config
+
+    Raises:
+        HTTPException: If project is not found
+    """
+    project_obj = await project_repository.get_by_id(project_id)
+    if project_obj:
+        return ProjectConfig(name=project_obj.name, home=pathlib.Path(project_obj.path))
+
+    # Not found (this should not happen since ProjectExternalIdPathDep already validates)
+    raise HTTPException(  # pragma: no cover
+        status_code=status.HTTP_404_NOT_FOUND, detail=f"Project with ID {project_id} not found."
+    )
+
+
+ProjectConfigV2ExternalDep = Annotated[
+    ProjectConfig, Depends(get_project_config_v2_external)
+]

basic_memory/deps/repositories.py

@@ -0,0 +1,179 @@
+"""Repository dependency injection for basic-memory.
+
+This module provides repository dependencies:
+- EntityRepository
+- ObservationRepository
+- RelationRepository
+- SearchRepository
+
+Each repository is scoped to a project ID from the request.
+"""
+
+from typing import Annotated
+
+from fastapi import Depends
+
+from basic_memory.deps.db import SessionMakerDep
+from basic_memory.deps.projects import (
+    ProjectIdDep,
+    ProjectIdPathDep,
+    ProjectExternalIdPathDep,
+)
+from basic_memory.repository.entity_repository import EntityRepository
+from basic_memory.repository.observation_repository import ObservationRepository
+from basic_memory.repository.relation_repository import RelationRepository
+from basic_memory.repository.search_repository import SearchRepository, create_search_repository
+
+
+# --- Entity Repository ---
+
+
+async def get_entity_repository(
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdDep,
+) -> EntityRepository:
+    """Create an EntityRepository instance for the current project."""
+    return EntityRepository(session_maker, project_id=project_id)
+
+
+EntityRepositoryDep = Annotated[EntityRepository, Depends(get_entity_repository)]
+
+
+async def get_entity_repository_v2(  # pragma: no cover
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdPathDep,
+) -> EntityRepository:
+    """Create an EntityRepository instance for v2 API (uses integer project_id from path)."""
+    return EntityRepository(session_maker, project_id=project_id)
+
+
+EntityRepositoryV2Dep = Annotated[EntityRepository, Depends(get_entity_repository_v2)]
+
+
+async def get_entity_repository_v2_external(
+    session_maker: SessionMakerDep,
+    project_id: ProjectExternalIdPathDep,
+) -> EntityRepository:
+    """Create an EntityRepository instance for v2 API (uses external_id from path)."""
+    return EntityRepository(session_maker, project_id=project_id)
+
+
+EntityRepositoryV2ExternalDep = Annotated[EntityRepository, Depends(get_entity_repository_v2_external)]
+
+
+# --- Observation Repository ---
+
+
+async def get_observation_repository(
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdDep,
+) -> ObservationRepository:
+    """Create an ObservationRepository instance for the current project."""
+    return ObservationRepository(session_maker, project_id=project_id)
+
+
+ObservationRepositoryDep = Annotated[ObservationRepository, Depends(get_observation_repository)]
+
+
+async def get_observation_repository_v2(  # pragma: no cover
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdPathDep,
+) -> ObservationRepository:
+    """Create an ObservationRepository instance for v2 API."""
+    return ObservationRepository(session_maker, project_id=project_id)
+
+
+ObservationRepositoryV2Dep = Annotated[
+    ObservationRepository, Depends(get_observation_repository_v2)
+]
+
+
+async def get_observation_repository_v2_external(
+    session_maker: SessionMakerDep,
+    project_id: ProjectExternalIdPathDep,
+) -> ObservationRepository:
+    """Create an ObservationRepository instance for v2 API (uses external_id)."""
+    return ObservationRepository(session_maker, project_id=project_id)
+
+
+ObservationRepositoryV2ExternalDep = Annotated[
+    ObservationRepository, Depends(get_observation_repository_v2_external)
+]
+
+
+# --- Relation Repository ---
+
+
+async def get_relation_repository(
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdDep,
+) -> RelationRepository:
+    """Create a RelationRepository instance for the current project."""
+    return RelationRepository(session_maker, project_id=project_id)
+
+
+RelationRepositoryDep = Annotated[RelationRepository, Depends(get_relation_repository)]
+
+
+async def get_relation_repository_v2(  # pragma: no cover
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdPathDep,
+) -> RelationRepository:
+    """Create a RelationRepository instance for v2 API."""
+    return RelationRepository(session_maker, project_id=project_id)
+
+
+RelationRepositoryV2Dep = Annotated[RelationRepository, Depends(get_relation_repository_v2)]
+
+
+async def get_relation_repository_v2_external(
+    session_maker: SessionMakerDep,
+    project_id: ProjectExternalIdPathDep,
+) -> RelationRepository:
+    """Create a RelationRepository instance for v2 API (uses external_id)."""
+    return RelationRepository(session_maker, project_id=project_id)
+
+
+RelationRepositoryV2ExternalDep = Annotated[
+    RelationRepository, Depends(get_relation_repository_v2_external)
+]
+
+
+# --- Search Repository ---
+
+
+async def get_search_repository(
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdDep,
+) -> SearchRepository:
+    """Create a backend-specific SearchRepository instance for the current project.
+
+    Uses factory function to return SQLiteSearchRepository or PostgresSearchRepository
+    based on database backend configuration.
+    """
+    return create_search_repository(session_maker, project_id=project_id)
+
+
+SearchRepositoryDep = Annotated[SearchRepository, Depends(get_search_repository)]
+
+
+async def get_search_repository_v2(  # pragma: no cover
+    session_maker: SessionMakerDep,
+    project_id: ProjectIdPathDep,
+) -> SearchRepository:
+    """Create a SearchRepository instance for v2 API."""
+    return create_search_repository(session_maker, project_id=project_id)
+
+
+SearchRepositoryV2Dep = Annotated[SearchRepository, Depends(get_search_repository_v2)]
+
+
+async def get_search_repository_v2_external(
+    session_maker: SessionMakerDep,
+    project_id: ProjectExternalIdPathDep,
+) -> SearchRepository:
+    """Create a SearchRepository instance for v2 API (uses external_id)."""
+    return create_search_repository(session_maker, project_id=project_id)
+
+
+SearchRepositoryV2ExternalDep = Annotated[SearchRepository, Depends(get_search_repository_v2_external)]