Obsidian Index Service

🚀 Obsidian索引服務

Obsidian索引服務可監控Obsidian保險庫目錄，將Markdown文件的元數據與全文內容索引至SQLite數據庫。該服務最初為mcp-server項目構建，後轉向使用Obsidian插件API實現。不過，它作為通用的無主見索引工具或同步工具仍頗具價值，因此在此發佈。

✨ 主要特性

此服務會跟蹤Obsidian保險庫中的文件更改（創建、修改、刪除），並將所有內容存儲在SQLite中，可通過Docker捲進行訪問。它能捕獲以下信息：

• 路徑：文件路徑（唯一標識符）
• 標題：來自文件名
• 父文件夾：相對於保險庫根目錄
• 標籤：從YAML前端元數據獲取
• 創建日期：文件系統時間戳
• 修改日期：文件系統時間戳
• 內容：筆記的全文
• 狀態：處理結果（成功/錯誤）
• 錯誤信息：處理失敗時的詳細信息

📦 安裝指南

先決條件

• Python 3.12或更高版本
• Docker和Docker Compose（用於容器化使用）
• uv（可選，但推薦）

安裝步驟

1. 克隆倉庫：

   git clone https://github.com/pmmvr/obsidian-index-service.git
   cd obsidian-index-service
   

2. 設置虛擬環境：

   • 使用uv（推薦）：

     uv venv
     source .venv/bin/activate # Linux/macOS
     .venv\Scripts\activate # Windows
     

   • 使用python（標準方法）：

     python -m venv .venv
     source .venv/bin/activate  # Linux/macOS
     .venv\Scripts\activate     # Windows
     

3. 安裝依賴項：

   • 使用uv（推薦）：

     uv sync  # 從uv.lock安裝
     uv pip install pytest pytest-bdd pytest-mock  # 用於測試
     

   • 使用pip：

     pip install -e .
     pip install pytest pytest-bdd pytest-mock  # 用於測試
     

💻 使用示例

基礎用法

在本地運行測試：

pytest

📚 詳細文檔

項目狀態

• 已完成：核心索引（元數據+內容）、Docker設置、文件監視、數據庫CRUD。
• 下一步計劃：原本計劃創建API，但轉而採用插件方法。

未來步驟（作為同步工具的潛力）

通過一些重構，該服務可作為同步工具使用，具體如下：

• 遠程後端：添加對雲存儲（例如Dropbox）或服務器的支持。
• 同步邏輯：推送本地更改（內容+元數據）到遠程，拉取遠程更新，處理衝突（例如最後寫入者獲勝）。
• 數據庫調整：添加sync_status和remote_id列。
• 文件監視器更新：排隊更改以進行同步，而不僅僅是索引。
• CLI選項：添加--sync以手動觸發或持續運行。
• 錯誤處理：重試網絡失敗，記錄問題。