obsidian-notes-rag 0.1.2__py3-none-any.whl

obsidian_notes_rag-0.1.2.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: obsidian-notes-rag
+Version: 0.1.2
+Summary: MCP server for semantic search over Obsidian notes using local RAG
+Project-URL: Homepage, https://github.com/ernestkoe/obsidian-rag
+Project-URL: Repository, https://github.com/ernestkoe/obsidian-rag
+Project-URL: Issues, https://github.com/ernestkoe/obsidian-rag/issues
+Author: Ernest Koe
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: chromadb>=0.4.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: openai>=1.0.0
+Requires-Dist: platformdirs>=3.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: tomli-w>=1.0.0
+Requires-Dist: watchdog>=3.0.0
+Description-Content-Type: text/markdown
+
+# obsidian-rag
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+MCP server for semantic search over your Obsidian vault. Uses OpenAI embeddings by default (or Ollama for local processing) with ChromaDB for vector storage.
+
+## What it does
+
+Ask natural language questions about your notes:
+- "What did I write about project planning?"
+- "Find notes similar to my meeting notes from last week"
+- "What's in my daily notes about the API refactor?"
+
+## Requirements
+
+- Python 3.11+
+- `OPENAI_API_KEY` environment variable (or [Ollama](https://ollama.ai/) for local embeddings)
+
+## Quick Start
+
+The easiest way to get started is with [uvx](https://docs.astral.sh/uv/guides/tools/) (no installation required):
+
+```bash
+# Run the setup wizard
+uvx obsidian-rag setup
+
+# Add to Claude Code
+claude mcp add obsidian-rag -- uvx obsidian-rag serve
+```
+
+### Alternative: Clone and install
+
+```bash
+git clone https://github.com/ernestkoe/obsidian-rag.git
+cd obsidian-rag
+uv sync
+
+uv run obsidian-rag setup
+claude mcp add obsidian-rag -- uv run --directory /path/to/obsidian-rag obsidian-rag serve
+```
+
+The setup wizard will:
+1. Ask for your embedding provider (OpenAI or Ollama)
+2. Configure your API key (for OpenAI)
+3. Set your Obsidian vault path
+4. Choose where to store the search index
+5. Optionally run the initial indexing
+
+### Manual Setup (alternative)
+
+```bash
+# Set your API key and index directly
+export OPENAI_API_KEY=sk-...
+uv run obsidian-rag index --vault /path/to/your/vault
+```
+
+### Using Ollama (local, offline)
+
+```bash
+# Install Ollama and pull the embedding model
+ollama pull nomic-embed-text
+
+# Run setup with Ollama, or index directly:
+uv run obsidian-rag --provider ollama index --vault /path/to/your/vault
+```
+
+## MCP Tools
+
+Once connected, these tools are available to Claude:
+
+| Tool | What it does |
+|------|--------------|
+| `search_notes` | Find notes matching a query |
+| `get_similar` | Find notes similar to a given note |
+| `get_note_context` | Get a note with related context |
+| `get_stats` | Show index statistics |
+| `reindex` | Update the index |
+
+## Keeping the Index Fresh
+
+### Option 1: Manual reindex
+
+```bash
+uv run obsidian-rag index
+```
+
+### Option 2: Watch for changes
+
+```bash
+uv run obsidian-rag watch
+```
+
+### Option 3: Auto-start on login (macOS)
+
+```bash
+uv run obsidian-rag install-service
+```
+
+## CLI Reference
+
+```bash
+obsidian-rag setup                # Interactive setup wizard
+obsidian-rag serve                # Start MCP server (for Claude Code)
+obsidian-rag index [--clear]      # Index vault (--clear to rebuild)
+obsidian-rag search "query"       # Search from command line
+obsidian-rag watch                # Watch for file changes
+obsidian-rag stats                # Show index stats
+obsidian-rag install-service      # Install macOS launchd service
+obsidian-rag uninstall-service    # Remove service
+obsidian-rag service-status       # Check service status
+```
+
+## Configuration
+
+Set your vault path and provider via CLI options or environment variables:
+
+```bash
+# CLI options
+uv run obsidian-rag --vault /path/to/vault index
+uv run obsidian-rag --provider ollama index
+
+# Environment variables
+export OBSIDIAN_RAG_VAULT=/path/to/vault
+export OBSIDIAN_RAG_PROVIDER=ollama  # or "openai" (default)
+```
+
+| Variable | Description |
+|----------|-------------|
+| `OPENAI_API_KEY` | OpenAI API key (required for default provider) |
+| `OBSIDIAN_RAG_PROVIDER` | Embedding provider: `openai` (default) or `ollama` |
+| `OBSIDIAN_RAG_VAULT` | Path to Obsidian vault |
+| `OBSIDIAN_RAG_DATA` | Where to store the index (default: `./data`) |
+| `OBSIDIAN_RAG_OLLAMA_URL` | Ollama API URL (default: `http://localhost:11434`) |
+| `OBSIDIAN_RAG_MODEL` | Override embedding model |
+
+## How it works
+
+1. Parses your markdown files and splits them by headings
+2. Generates embeddings using OpenAI API (or Ollama for local processing)
+3. Stores vectors in ChromaDB (local, persistent)
+4. MCP server provides semantic search to Claude
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup.
+
+## License
+
+MIT

obsidian_notes_rag-0.1.2.dist-info/RECORD

@@ -0,0 +1,12 @@
+obsidian_rag/__init__.py,sha256=t9xGwmsEw9905Z11CGQU8lKp7G61F1HDxlwCZO1uNGc,93
+obsidian_rag/cli.py,sha256=oapWNqTbTgbbylcfgds00FwKJ9pVUlJGCNiD-dOJHKU,16645
+obsidian_rag/config.py,sha256=2jUXUoZF7LbLawSB598RbmTuLZcBjleLuYSO4pY7QaA,4801
+obsidian_rag/indexer.py,sha256=xoGdklZRap3zDWWFKkNuJFjoXNvMBT85kjUta_Lp2QA,8559
+obsidian_rag/server.py,sha256=YQkjaMDUa99GbLzgzAVJfH9oVSgtcZFpUgm39ZHPFso,7620
+obsidian_rag/store.py,sha256=0T9wOFQI5N4PY5R2Gke5TYcLobdsHMN8SsqcRtVfpSk,5053
+obsidian_rag/watcher.py,sha256=vHyiBope_q_ZoBiriVgfK-IysnAljqbS3b3dCwd-fnw,10017
+obsidian_notes_rag-0.1.2.dist-info/METADATA,sha256=0MPYKd0jYXvPLntPpgiqmdRT0pp8o3k8s-U-W543Vyc,4859
+obsidian_notes_rag-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+obsidian_notes_rag-0.1.2.dist-info/entry_points.txt,sha256=-Kf5hOndApdppZVAS6boq6ZDu09Dx9ZmfV6MoQwyb14,61
+obsidian_notes_rag-0.1.2.dist-info/licenses/LICENSE,sha256=BGPR85ZPP4AVv8hzsabjfJRoJDbJcgSSIKO2HIFVebc,1067
+obsidian_notes_rag-0.1.2.dist-info/RECORD,,

obsidian_notes_rag-0.1.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

obsidian_notes_rag-0.1.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+obsidian-notes-rag = obsidian_rag.cli:main

obsidian_notes_rag-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ernest Koe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

obsidian_rag/__init__.py

@@ -0,0 +1,3 @@
+"""Obsidian Memory - Vector store for AI-assisted note management."""
+
+__version__ = "0.1.2"