basic-memory 0.4.3__tar.gz → 0.6.0__tar.gz

{basic_memory-0.4.3 → basic_memory-0.6.0}/CHANGELOG.md

@@ -1,6 +1,27 @@
 # CHANGELOG
 
 
+## v0.6.0 (2025-02-18)
+
+### Features
+
+- Configure logfire telemetry ([#12](https://github.com/basicmachines-co/basic-memory/pull/12),
+  [`6da1438`](https://github.com/basicmachines-co/basic-memory/commit/6da143898bd45cdab8db95b5f2b75810fbb741ba))
+
+Co-authored-by: phernandez <phernandez@basicmachines.co>
+
+
+## v0.5.0 (2025-02-18)
+
+### Features
+
+- Return semantic info in markdown after write_note
+  ([#11](https://github.com/basicmachines-co/basic-memory/pull/11),
+  [`0689e7a`](https://github.com/basicmachines-co/basic-memory/commit/0689e7a730497827bf4e16156ae402ddc5949077))
+
+Co-authored-by: phernandez <phernandez@basicmachines.co>
+
+
 ## v0.4.3 (2025-02-18)
 
 ### Bug Fixes

{basic_memory-0.4.3 → basic_memory-0.6.0}/Makefile

@@ -4,7 +4,7 @@ install:
 	pip install -e ".[dev]"
 
 test:
-	pytest -p pytest_mock -v
+	uv run pytest -p pytest_mock -v
 
 lint:
 	ruff check . --fix
@@ -40,4 +40,4 @@ installer-win:
 
 
 update-deps:
-	uv lock f--upgrade
+	uv lock f--upgrade

{basic_memory-0.4.3 → basic_memory-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-memory
-Version: 0.4.3
+Version: 0.6.0
 Summary: Local-first knowledge management combining Zettelkasten with knowledge graphs
 Project-URL: Homepage, https://github.com/basicmachines-co/basic-memory
 Project-URL: Repository, https://github.com/basicmachines-co/basic-memory
@@ -15,6 +15,7 @@ Requires-Dist: dateparser>=1.2.0
 Requires-Dist: fastapi[standard]>=0.115.8
 Requires-Dist: greenlet>=3.1.1
 Requires-Dist: icecream>=2.1.3
+Requires-Dist: logfire[fastapi,sqlalchemy,sqlite3]>=3.6.0
 Requires-Dist: loguru>=0.7.3
 Requires-Dist: markdown-it-py>=3.0.0
 Requires-Dist: mcp>=1.2.0

{basic_memory-0.4.3 → basic_memory-0.6.0}/installer/installer.py

@@ -49,7 +49,14 @@ def update_claude_config():
         config = {"mcpServers": {}}
 
     # Add/update basic-memory config
-    config["mcpServers"]["basic-memory"] = {"command": "uvx", "args": ["basic-memory", "mcp"]}
+    config["mcpServers"]["basic-memory"] = {
+        "command": "uvx",
+        "args": ["basic-memory@latest", "mcp"],
+        "env": {
+            "BASIC_MEMORY_ENV": "user",
+            "LOGFIRE_TOKEN": "n2Fpvn34LjKYq8TdF1ZrXMgdBPXGn4HfXy6tYghZ55dB",
+        },
+    }
 
     # Write back config
     config_path.write_text(json.dumps(config, indent=2))

{basic_memory-0.4.3 → basic_memory-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "basic-memory"
-version = "0.4.3"
+version = "0.6.0"
 description = "Local-first knowledge management combining Zettelkasten with knowledge graphs"
 readme = "README.md"
 requires-python = ">=3.12.1"
@@ -29,6 +29,7 @@ dependencies = [
     "fastapi[standard]>=0.115.8",
     "alembic>=1.14.1",
     "qasync>=0.27.1",
+    "logfire[fastapi,sqlalchemy,sqlite3]>=3.6.0",
 ]
 
 

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/__init__.py

@@ -1,3 +1,3 @@
 """basic-memory - Local-first knowledge management combining Zettelkasten with knowledge graphs"""
 
-__version__ = "0.4.3"
+__version__ = "0.6.0"

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/api/app.py

@@ -2,6 +2,7 @@
 
 from contextlib import asynccontextmanager
 
+import logfire
 from fastapi import FastAPI, HTTPException
 from fastapi.exception_handlers import http_exception_handler
 from loguru import logger
@@ -10,11 +11,13 @@ import basic_memory
 from basic_memory import db
 from basic_memory.config import config as app_config
 from basic_memory.api.routers import knowledge, search, memory, resource
+from basic_memory.utils import setup_logging
 
 
 @asynccontextmanager
 async def lifespan(app: FastAPI):  # pragma: no cover
     """Lifecycle manager for the FastAPI app."""
+    setup_logging(log_file=".basic-memory/basic-memory.log")
     logger.info(f"Starting Basic Memory API {basic_memory.__version__}")
     await db.run_migrations(app_config)
     yield
@@ -30,6 +33,10 @@ app = FastAPI(
     lifespan=lifespan,
 )
 
+if app_config != "test":
+    logfire.instrument_fastapi(app)
+
+
 # Include routers
 app.include_router(knowledge.router)
 app.include_router(search.router)

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/api/routers/resource_router.py

@@ -31,7 +31,7 @@ def get_entity_ids(item: SearchIndexRow) -> list[int]:
             from_entity = item.from_id
             to_entity = item.to_id  # pyright: ignore [reportReturnType]
             return [from_entity, to_entity] if to_entity else [from_entity]  # pyright: ignore [reportReturnType]
-        case _:
+        case _:  # pragma: no cover
             raise ValueError(f"Unexpected type: {item.type}")
 
 

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/cli/main.py

@@ -1,7 +1,6 @@
 """Main CLI entry point for basic-memory."""  # pragma: no cover
 
 from basic_memory.cli.app import app  # pragma: no cover
-from basic_memory.utils import setup_logging  # pragma: no cover
 
 # Register commands
 from basic_memory.cli.commands import (  # noqa: F401  # pragma: no cover
@@ -16,8 +15,5 @@ from basic_memory.cli.commands import (  # noqa: F401  # pragma: no cover
 )
 
 
-# Set up logging when module is imported
-setup_logging(log_file=".basic-memory/basic-memory-cli.log")  # pragma: no cover
-
 if __name__ == "__main__":  # pragma: no cover
     app()

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/config.py

@@ -1,6 +1,7 @@
 """Configuration management for basic-memory."""
 
 from pathlib import Path
+from typing import Literal
 
 from pydantic import Field, field_validator
 from pydantic_settings import BaseSettings, SettingsConfigDict
@@ -8,10 +9,14 @@ from pydantic_settings import BaseSettings, SettingsConfigDict
 DATABASE_NAME = "memory.db"
 DATA_DIR_NAME = ".basic-memory"
 
+Environment = Literal["test", "dev", "prod"]
+
 
 class ProjectConfig(BaseSettings):
     """Configuration for a specific basic-memory project."""
 
+    env: Environment = Field(default="dev", description="Environment name")
+
     # Default to ~/basic-memory but allow override with env var: BASIC_MEMORY_HOME
     home: Path = Field(
         default_factory=lambda: Path.home() / "basic-memory",

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/mcp/tools/notes.py

@@ -17,15 +17,14 @@ from basic_memory.schemas.memory import memory_url_path
 
 
 @mcp.tool(
-    description="Create or update a markdown note. Returns the permalink for referencing.",
+    description="Create or update a markdown note. Returns a markdown formatted summary of the semantic content.",
 )
 async def write_note(
     title: str,
     content: str,
     folder: str,
     tags: Optional[List[str]] = None,
-    verbose: bool = False,
-) -> EntityResponse | str:
+) -> str:
     """Write a markdown note to the knowledge base.
 
     The content can include semantic observations and relations using markdown syntax.
@@ -53,14 +52,16 @@ async def write_note(
         content: Markdown content for the note, can include observations and relations
         folder: the folder where the file should be saved
         tags: Optional list of tags to categorize the note
-        verbose: If True, returns full EntityResponse with semantic info
 
     Returns:
-        If verbose=False: Permalink that can be used to reference the note
-        If verbose=True: EntityResponse with full semantic details
+        A markdown formatted summary of the semantic content, including:
+        - Creation/update status
+        - File path and checksum
+        - Observation counts by category
+        - Relation counts (resolved/unresolved)
+        - Tags if present
 
     Examples:
-        # Note with both explicit and inline relations
         write_note(
             title="Search Implementation",
             content="# Search Component\\n\\n"
@@ -73,20 +74,6 @@ async def write_note(
                    "- depends_on [[Database Schema]]",
             folder="docs/components"
         )
-
-        # Note with tags
-        write_note(
-            title="Error Handling Design",
-            content="# Error Handling\\n\\n"
-                   "This design builds on [[Reliability Design]].\\n\\n"
-                   "## Approach\\n"
-                   "- [design] Use error codes #architecture\\n"
-                   "- [tech] Implement retry logic #implementation\\n\\n"
-                   "## Relations\\n"
-                   "- extends [[Base Error Handling]]",
-            folder="docs/design",
-            tags=["architecture", "reliability"]
-        )
     """
     logger.info(f"Writing note folder:'{folder}' title: '{title}'")
 
@@ -101,12 +88,43 @@ async def write_note(
         entity_metadata=metadata,
     )
 
-    # Use existing knowledge tool
+    # Create or update via knowledge API
     logger.info(f"Creating {entity.permalink}")
     url = f"/knowledge/entities/{entity.permalink}"
     response = await call_put(client, url, json=entity.model_dump())
     result = EntityResponse.model_validate(response.json())
-    return result if verbose else result.permalink
+
+    # Format semantic summary based on status code
+    action = "Created" if response.status_code == 201 else "Updated"
+    assert result.checksum is not None
+    summary = [
+        f"# {action} {result.file_path} ({result.checksum[:8]})",
+        f"permalink: {result.permalink}",
+    ]
+
+    if result.observations:
+        categories = {}
+        for obs in result.observations:
+            categories[obs.category] = categories.get(obs.category, 0) + 1
+
+        summary.append("\n## Observations")
+        for category, count in sorted(categories.items()):
+            summary.append(f"- {category}: {count}")
+
+    if result.relations:
+        unresolved = sum(1 for r in result.relations if not r.to_id)
+        resolved = len(result.relations) - unresolved
+
+        summary.append("\n## Relations")
+        summary.append(f"- Resolved: {resolved}")
+        if unresolved:
+            summary.append(f"- Unresolved: {unresolved}")
+            summary.append("\nUnresolved relations will be retried on next sync.")
+
+    if tags:
+        summary.append(f"\n## Tags\n- {', '.join(tags)}")
+
+    return "\n".join(summary)
 
 
 @mcp.tool(description="Read note content by title, permalink, relation, or pattern")

{basic_memory-0.4.3 → basic_memory-0.6.0}/src/basic_memory/utils.py

@@ -9,8 +9,11 @@ from typing import Optional, Union
 from loguru import logger
 from unidecode import unidecode
 
+import basic_memory
 from basic_memory.config import config
 
+import logfire
+
 
 def generate_permalink(file_path: Union[Path, str]) -> str:
     """Generate a stable permalink from a file path.
@@ -61,19 +64,45 @@ def generate_permalink(file_path: Union[Path, str]) -> str:
     return "/".join(clean_segments)
 
 
-def setup_logging(home_dir: Path = config.home, log_file: Optional[str] = None) -> None:
+def setup_logging(
+    home_dir: Path = config.home, log_file: Optional[str] = None
+) -> None:  # pragma: no cover
     """
     Configure logging for the application.
+    :param home_dir: the root directory for the application
+    :param log_file: the name of the log file to write to
+    :param app: the fastapi application instance
     """
 
     # Remove default handler and any existing handlers
     logger.remove()
 
-    # Add file handler
-    if log_file:
+    # Add file handler if we are not running tests
+    if log_file and config.env != "test":
+        # enable pydantic logfire
+        logfire.configure(
+            code_source=logfire.CodeSource(
+                repository="https://github.com/basicmachines-co/basic-memory",
+                revision=basic_memory.__version__,
+                root_path="/src/basic_memory",
+            ),
+            environment=config.env,
+        )
+        logger.configure(handlers=[logfire.loguru_handler()])
+
+        # instrument code spans
+        logfire.instrument_sqlite3()
+        logfire.instrument_pydantic()
+
+        from basic_memory.db import _engine as engine
+
+        if engine:
+            logfire.instrument_sqlalchemy(engine=engine)
+
+        # setup logger
         log_path = home_dir / log_file
         logger.add(
-            str(log_path),  # loguru expects a string path
+            str(log_path),
             level=config.log_level,
             rotation="100 MB",
             retention="10 days",
@@ -85,3 +114,5 @@ def setup_logging(home_dir: Path = config.home, log_file: Optional[str] = None)
 
     # Add stderr handler
     logger.add(sys.stderr, level=config.log_level, backtrace=True, diagnose=True, colorize=True)
+
+    logger.info(f"ENV: '{config.env}' Log level: '{config.log_level}' Logging to {log_file}")

basic_memory-0.6.0/tests/__init__.py

@@ -0,0 +1,4 @@
+from basic_memory.config import config
+
+# set config.env to "test" for pytest to prevent logging to file in utils.setup_logging()
+config.env = "test"

{basic_memory-0.4.3 → basic_memory-0.6.0}/tests/api/test_resource_router.py

@@ -158,7 +158,6 @@ async def test_get_resource_entities(client, test_config, entity_repository):
     entity2 = EntityResponse(**entity_response)
 
     assert len(entity2.relations) == 1
-    relation = entity2.relations[0]
 
     # Test getting the content via the relation
     response = await client.get("/resource/test/*")

{basic_memory-0.4.3 → basic_memory-0.6.0}/tests/mcp/test_tool_knowledge.py

@@ -13,7 +13,7 @@ from basic_memory.schemas.delete import DeleteEntitiesRequest
 async def test_get_single_entity(client):
     """Test retrieving a single entity."""
     # First create an entity
-    permalink = await notes.write_note(
+    result = await notes.write_note(
         title="Test Note",
         folder="test",
         content="""
@@ -22,9 +22,10 @@ async def test_get_single_entity(client):
 """,
         tags=["test", "documentation"],
     )
+    assert result
 
     # Get the entity
-    entity = await get_entity(permalink)
+    entity = await get_entity("test/test-note")
 
     # Verify entity details
     assert entity.title == "Test Note"
@@ -36,40 +37,40 @@ async def test_get_single_entity(client):
 async def test_get_multiple_entities(client):
     """Test retrieving multiple entities."""
     # Create two test entities
-    permalink1 = await notes.write_note(
+    await notes.write_note(
         title="Test Note 1",
         folder="test",
         content="# Test 1",
     )
-    permalink2 = await notes.write_note(
+    await notes.write_note(
         title="Test Note 2",
         folder="test",
         content="# Test 2",
     )
 
     # Get both entities
-    request = GetEntitiesRequest(permalinks=[permalink1, permalink2])
+    request = GetEntitiesRequest(permalinks=["test/test-note-1", "test/test-note-2"])
     response = await get_entities(request)
 
     # Verify we got both entities
     assert len(response.entities) == 2
     permalinks = {e.permalink for e in response.entities}
-    assert permalink1 in permalinks
-    assert permalink2 in permalinks
+    assert "test/test-note-1" in permalinks
+    assert "test/test-note-2" in permalinks
 
 
 @pytest.mark.asyncio
 async def test_delete_entities(client):
     """Test deleting entities."""
     # Create a test entity
-    permalink = await notes.write_note(
+    await notes.write_note(
         title="Test Note",
         folder="test",
         content="# Test Note to Delete",
     )
 
     # Delete the entity
-    request = DeleteEntitiesRequest(permalinks=[permalink])
+    request = DeleteEntitiesRequest(permalinks=["test/test-note"])
     response = await delete_entities(request)
 
     # Verify deletion
@@ -77,7 +78,7 @@ async def test_delete_entities(client):
 
     # Verify entity no longer exists
     with pytest.raises(ToolError):
-        await get_entity(permalink)
+        await get_entity("test/test-note")
 
 
 @pytest.mark.asyncio