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

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

@@ -1,6 +1,16 @@
 # 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

{basic_memory-0.5.0 → 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.5.0 → basic_memory-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: basic-memory
-Version: 0.5.0
+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.5.0 → 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.5.0 → basic_memory-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "basic-memory"
-version = "0.5.0"
+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.5.0 → 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.5.0"
+__version__ = "0.6.0"

{basic_memory-0.5.0 → 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.5.0 → 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.5.0 → 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.5.0 → 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.6.0/tests/test_basic_memory.py

@@ -0,0 +1,47 @@
+"""Tests for basic-memory package"""
+
+import sys
+import tomllib
+
+import pytest
+from frontmatter.default_handlers import toml
+
+from basic_memory import __version__
+from basic_memory.config import config
+
+
+def read_toml_version(file_path):
+    try:
+        with open(file_path, "rb") as f:
+            if sys.version_info >= (3, 11):
+                data = tomllib.load(f)
+            else:
+                data = toml.load(f)
+        if "project" in data and "version" in data["project"]:
+            return data["project"]["version"]
+        else:
+            return None
+    except FileNotFoundError:
+        return None
+    except (toml.TomlDecodeError, tomllib.TOMLDecodeError):
+        return None
+
+
+file_path = "pyproject.toml"
+version = read_toml_version(file_path)
+
+
+def test_version():
+    """Test version is set in project src code and pyproject.toml"""
+    assert __version__ == version
+
+
+def test_config_env():
+    """Test the config env is set to test for pytest"""
+    assert config.env == "test"
+
+
+@pytest.mark.asyncio
+async def test_config_env_async():
+    """Test the config env is set to test for async pytest"""
+    assert config.env == "test"