codegraphcontext 0.4.16__tar.gz → 0.4.18__tar.gz

{codegraphcontext-0.4.16/src/codegraphcontext.egg-info → codegraphcontext-0.4.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codegraphcontext
-Version: 0.4.16
+Version: 0.4.18
 Summary: An MCP server that indexes local code into a graph database to provide context to AI assistants.
 Author-email: Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
 License: MIT License
@@ -96,7 +96,7 @@ Dynamic: license-file
 - 🇯🇵 [日本語](docs/translations/README.ja.md)
 - 🇪🇸 Español (Soon)
 
-🌍 **Help translate CodeGraphContext to your language by raising an issue & PR on https://github.com/Shashankss1205/CodeGraphContext/issues!**
+🌍 **Help translate CodeGraphContext to your language by raising an issue & PR on [GitHub Issues](https://github.com/Shashankss1205/CodeGraphContext/issues)!**
 
 <p align="center">
   <br>
@@ -156,6 +156,8 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 
 ## 📍 Quick Navigation
 * [🚀 Quick Start](#-installation--quick-start) 
+* [📋 Prerequisites](#-prerequisites)
+* [🏃 How to Run the Project Locally](#-how-to-run-the-project-locally)
 * [🌐 Supported Programming Languages](#supported-programming-languages) 
 * [🛠️ CLI Toolkit](#for-cli-toolkit-mode) 
 * [🤖 MCP Server](#-for-mcp-server-mode) 
@@ -183,7 +185,7 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 ---
 
 ## Project Details
-- **Version:** 0.4.16
+- **Version:** 0.4.18
 - **Authors:** Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
 - **License:** MIT License (See [LICENSE](LICENSE) for details)
 - **Website:** [CodeGraphContext](http://codegraphcontext.vercel.app/)
@@ -212,7 +214,7 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 -   **Code Indexing:** Analyzes code and builds a knowledge graph of its components.
 -   **Relationship Analysis:** Query for callers, callees, class hierarchies, call chains and more.
 -   **Pre-indexed Bundles:** Load famous repositories instantly with `.cgc` bundles - no indexing required! ([Learn more](docs/BUNDLES.md))
--   **Live File Watching:** Watch directories for changes and automatically update the graph in real-time (`codegraphcontext watch`).
+-   **Live File Watching:** Watch directories for changes and automatically update the graph in real-time (`cgc watch`).
 -   **Interactive Setup:** A user-friendly command-line wizard for easy setup.
 -   **Dual Mode:** Works as a standalone **CLI toolkit** for developers and as an **MCP server** for AI agents.
 -   **Multi-Language Support:** Full support for 22 programming languages.
@@ -246,7 +248,7 @@ CodeGraphContext supports multiple graph database backends to suit your environm
 
 | Feature | KuzuDB | LadybugDB | FalkorDB Lite | Neo4j / Nornic DB |
 | :--- | :--- | :--- | :--- | :--- |
-| **Typical default** | **Standard Default** (embedded, powered by KuzuDB) | **Specialized Embedded** (similar to Kuzu) | **Unix** (Python 3.12+, when `falkordblite` works) | When explicitly configured |
+| **Typical default** | Cross-platform fallback when FalkorDB Lite is unavailable | Optional embedded backend | **Default on Unix** (Python 3.12+, when `falkordblite` is installed) | When explicitly configured via `cgc config db` |
 | **Setup** | Zero-config / Embedded | Zero-config / Embedded | Zero-config / In-process | Docker / External |
 | **Platform** | **All (Windows Native, macOS, Linux)** | **All (Windows Native, macOS, Linux)** | Unix-only (Linux/macOS/WSL) | All Platforms |
 | **Use Case** | Desktop, IDE, Local development | Custom research projects | Specialized Unix development | Enterprise, Massive graphs |
@@ -326,6 +328,84 @@ _If you’re using CodeGraphContext in your project, feel free to open a PR and
 
 ---
 
+## 📋 Prerequisites
+
+Before installing CodeGraphContext, ensure you have:
+
+* Python 3.10 or later
+* pip package manager
+* Git (optional, for cloning repositories)
+
+Verify your Python installation:
+
+```bash
+python --version
+```
+
+---
+
+## 🚀 Step-by-Step Setup Guide
+
+### Step 1: Install CodeGraphContext
+
+```bash
+pip install codegraphcontext
+```
+
+This command installs CodeGraphContext and all required dependencies.
+
+### Step 2: Verify Installation
+
+```bash
+codegraphcontext --help
+```
+
+If the command displays the available CLI commands, the installation was successful.
+
+### Step 3: Database Setup
+
+CodeGraphContext automatically uses an embedded database by default, so no additional configuration is required for most users.
+
+---
+
+## 🏃 How to Run the Project Locally
+
+### Index a Repository
+
+```bash
+codegraphcontext index .
+```
+
+This scans the current project and creates a searchable code graph.
+
+### View Indexed Repositories
+
+```bash
+codegraphcontext list
+```
+
+Displays all repositories currently indexed by CodeGraphContext.
+
+### Analyze Code
+
+```bash
+codegraphcontext analyze dead-code
+```
+
+Finds potentially unused code in the indexed repository.
+
+---
+
+## ✅ Verify Everything Works
+
+After indexing a repository, run:
+
+```bash
+codegraphcontext list
+```
+
+If the command executes successfully and displays indexed repositories, your setup is complete and CodeGraphContext is ready to use.
+
 ### For CLI Toolkit Mode
 
 **Start using immediately with CLI commands:**

{codegraphcontext-0.4.16 → codegraphcontext-0.4.18}/README.md

@@ -11,7 +11,7 @@
 - 🇯🇵 [日本語](docs/translations/README.ja.md)
 - 🇪🇸 Español (Soon)
 
-🌍 **Help translate CodeGraphContext to your language by raising an issue & PR on https://github.com/Shashankss1205/CodeGraphContext/issues!**
+🌍 **Help translate CodeGraphContext to your language by raising an issue & PR on [GitHub Issues](https://github.com/Shashankss1205/CodeGraphContext/issues)!**
 
 <p align="center">
   <br>
@@ -71,6 +71,8 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 
 ## 📍 Quick Navigation
 * [🚀 Quick Start](#-installation--quick-start) 
+* [📋 Prerequisites](#-prerequisites)
+* [🏃 How to Run the Project Locally](#-how-to-run-the-project-locally)
 * [🌐 Supported Programming Languages](#supported-programming-languages) 
 * [🛠️ CLI Toolkit](#for-cli-toolkit-mode) 
 * [🤖 MCP Server](#-for-mcp-server-mode) 
@@ -98,7 +100,7 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 ---
 
 ## Project Details
-- **Version:** 0.4.16
+- **Version:** 0.4.18
 - **Authors:** Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
 - **License:** MIT License (See [LICENSE](LICENSE) for details)
 - **Website:** [CodeGraphContext](http://codegraphcontext.vercel.app/)
@@ -127,7 +129,7 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
 -   **Code Indexing:** Analyzes code and builds a knowledge graph of its components.
 -   **Relationship Analysis:** Query for callers, callees, class hierarchies, call chains and more.
 -   **Pre-indexed Bundles:** Load famous repositories instantly with `.cgc` bundles - no indexing required! ([Learn more](docs/BUNDLES.md))
--   **Live File Watching:** Watch directories for changes and automatically update the graph in real-time (`codegraphcontext watch`).
+-   **Live File Watching:** Watch directories for changes and automatically update the graph in real-time (`cgc watch`).
 -   **Interactive Setup:** A user-friendly command-line wizard for easy setup.
 -   **Dual Mode:** Works as a standalone **CLI toolkit** for developers and as an **MCP server** for AI agents.
 -   **Multi-Language Support:** Full support for 22 programming languages.
@@ -161,7 +163,7 @@ CodeGraphContext supports multiple graph database backends to suit your environm
 
 | Feature | KuzuDB | LadybugDB | FalkorDB Lite | Neo4j / Nornic DB |
 | :--- | :--- | :--- | :--- | :--- |
-| **Typical default** | **Standard Default** (embedded, powered by KuzuDB) | **Specialized Embedded** (similar to Kuzu) | **Unix** (Python 3.12+, when `falkordblite` works) | When explicitly configured |
+| **Typical default** | Cross-platform fallback when FalkorDB Lite is unavailable | Optional embedded backend | **Default on Unix** (Python 3.12+, when `falkordblite` is installed) | When explicitly configured via `cgc config db` |
 | **Setup** | Zero-config / Embedded | Zero-config / Embedded | Zero-config / In-process | Docker / External |
 | **Platform** | **All (Windows Native, macOS, Linux)** | **All (Windows Native, macOS, Linux)** | Unix-only (Linux/macOS/WSL) | All Platforms |
 | **Use Case** | Desktop, IDE, Local development | Custom research projects | Specialized Unix development | Enterprise, Massive graphs |
@@ -241,6 +243,84 @@ _If you’re using CodeGraphContext in your project, feel free to open a PR and
 
 ---
 
+## 📋 Prerequisites
+
+Before installing CodeGraphContext, ensure you have:
+
+* Python 3.10 or later
+* pip package manager
+* Git (optional, for cloning repositories)
+
+Verify your Python installation:
+
+```bash
+python --version
+```
+
+---
+
+## 🚀 Step-by-Step Setup Guide
+
+### Step 1: Install CodeGraphContext
+
+```bash
+pip install codegraphcontext
+```
+
+This command installs CodeGraphContext and all required dependencies.
+
+### Step 2: Verify Installation
+
+```bash
+codegraphcontext --help
+```
+
+If the command displays the available CLI commands, the installation was successful.
+
+### Step 3: Database Setup
+
+CodeGraphContext automatically uses an embedded database by default, so no additional configuration is required for most users.
+
+---
+
+## 🏃 How to Run the Project Locally
+
+### Index a Repository
+
+```bash
+codegraphcontext index .
+```
+
+This scans the current project and creates a searchable code graph.
+
+### View Indexed Repositories
+
+```bash
+codegraphcontext list
+```
+
+Displays all repositories currently indexed by CodeGraphContext.
+
+### Analyze Code
+
+```bash
+codegraphcontext analyze dead-code
+```
+
+Finds potentially unused code in the indexed repository.
+
+---
+
+## ✅ Verify Everything Works
+
+After indexing a repository, run:
+
+```bash
+codegraphcontext list
+```
+
+If the command executes successfully and displays indexed repositories, your setup is complete and CodeGraphContext is ready to use.
+
 ### For CLI Toolkit Mode
 
 **Start using immediately with CLI commands:**

{codegraphcontext-0.4.16 → codegraphcontext-0.4.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "codegraphcontext"
-version = "0.4.16"
+version = "0.4.18"
 description = "An MCP server that indexes local code into a graph database to provide context to AI assistants."
 authors = [{ name = "Shashank Shekhar Singh", email = "shashankshekharsingh1205@gmail.com" }]
 readme = "README.md"

{codegraphcontext-0.4.16 → codegraphcontext-0.4.18}/src/codegraphcontext/api/app.py

@@ -24,6 +24,11 @@ def create_app() -> FastAPI:
 
     app.include_router(router, prefix="/api/v1")
 
+    @app.get("/health")
+    async def health():
+        """Liveness probe for load balancers and k8s."""
+        return {"status": "ok"}
+
     # MCP-over-SSE Endpoints
     app.add_api_route("/api/v1/mcp/sse", handle_sse, methods=["GET"])
     app.add_api_route("/api/v1/mcp/messages", handle_messages, methods=["POST"])

{codegraphcontext-0.4.16 → codegraphcontext-0.4.18}/src/codegraphcontext/api/router.py

@@ -13,6 +13,8 @@ from .schemas import (
 )
 from codegraphcontext.server import MCPServer
 
+import socket
+
 router = APIRouter()
 
 # Global server instance (initialized on startup)
@@ -25,9 +27,19 @@ def get_server() -> MCPServer:
         _server_instance = MCPServer(cwd=Path.cwd())
     return _server_instance
 
+def raise_service_unavailable(exc: Exception):
+    raise HTTPException(
+        status_code=503,
+        detail="Database service unavailable",
+    ) from exc
+
 @router.get("/status", response_model=ApiResponse)
 async def get_status(server: MCPServer = Depends(get_server)):
-    status = server.db_manager.is_connected()
+    try:
+        status = server.db_manager.is_connected()
+    except (OSError, socket.error) as exc:
+        raise_service_unavailable(exc)
+
     return ApiResponse(
         status="ok",
         message="Connected" if status else "Disconnected",
@@ -43,16 +55,35 @@ async def list_tools(server: MCPServer = Depends(get_server)):
 
 @router.post("/tools/call", response_model=ApiResponse)
 async def call_tool(
-    request: ToolCallRequest, 
+    request: ToolCallRequest,
     server: MCPServer = Depends(get_server)
 ):
     try:
-        result = await server.handle_tool_call(request.name, request.arguments)
+        result = await server.handle_tool_call(
+            request.name,
+            request.arguments
+        )
+
         if "error" in result:
-            return ApiResponse(status="error", error=result["error"])
-        return ApiResponse(status="ok", data=result)
+            return ApiResponse(
+                status="error",
+                error=result["error"]
+            )
+
+        return ApiResponse(
+            status="ok",
+            data=result
+        )
+
+    except (OSError, socket.error) as exc:
+        raise_service_unavailable(exc)
+
     except Exception as e:
-        return ApiResponse(status="error", error=str(e))
+        return ApiResponse(
+            status="error",
+            error=str(e)
+        )
+    
 
 @router.post("/index", response_model=ApiResponse)
 async def index_repository(
@@ -60,21 +91,27 @@ async def index_repository(
     background_tasks: BackgroundTasks,
     server: MCPServer = Depends(get_server)
 ):
-    # Map to add_code_to_graph tool
     args = {
         "path": request.path,
         "repo_name": request.repo_name,
         "branch": request.branch,
         "force": request.force
     }
-    
-    # We call handle_tool_call which is async
-    # But add_code_to_graph starts a background job anyway
-    result = await server.handle_tool_call("add_code_to_graph", args)
-    
+
+    try:
+        result = await server.handle_tool_call(
+            "add_code_to_graph",
+            args
+        )
+    except (OSError, socket.error) as exc:
+        raise_service_unavailable(exc)
+
     if "error" in result:
-        raise HTTPException(status_code=400, detail=result["error"])
-        
+        raise HTTPException(
+            status_code=400,
+            detail=result["error"]
+        )
+
     return ApiResponse(
         status="ok",
         message="Indexing job started",
@@ -86,17 +123,35 @@ async def execute_query(
     request: QueryRequest,
     server: MCPServer = Depends(get_server)
 ):
-    result = await server.handle_tool_call("execute_cypher_query", {
-        "cypher_query": request.query,
-        "params": request.params
-    })
-    
+    try:
+        result = await server.handle_tool_call(
+            "execute_cypher_query",
+            {
+                "cypher_query": request.query,
+                "params": request.params,
+            },
+        )
+    except (OSError, socket.error) as exc:
+        raise_service_unavailable(exc)
+
     if "error" in result:
         return ApiResponse(status="error", error=result["error"])
-        
+
     return ApiResponse(status="ok", data=result)
 
 @router.get("/repositories", response_model=ApiResponse)
-async def list_repositories(server: MCPServer = Depends(get_server)):
-    result = await server.handle_tool_call("list_indexed_repositories", {})
-    return ApiResponse(status="ok", data=result)
+async def list_repositories(
+    server: MCPServer = Depends(get_server)
+):
+    try:
+        result = await server.handle_tool_call(
+            "list_indexed_repositories",
+            {}
+        )
+    except (OSError, socket.error) as exc:
+        raise_service_unavailable(exc)
+
+    return ApiResponse(
+        status="ok",
+        data=result
+    )