chatcortex 0.1.0__tar.gz

chatcortex-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Siddharth Saraswat
+
+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.

chatcortex-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: chatcortex
+Version: 0.1.0
+Summary: A privacy-first, local document chatbot engine
+Author: Siddharth Saraswat
+License: MIT
+Project-URL: Homepage, https://github.com/siddharth1012/chatCortex
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ChatCortex
+
+ChatCortex is a **privacy-first, local document chatbot engine** designed to be embedded into any application.  
+It enables teams to build document-aware conversational systems **without relying on cloud services**, while keeping all data within their own infrastructure.
+
+ChatCortex is **library-first**, **API-agnostic**, and designed for production and enterprise use cases.
+
+---
+
+## Overview
+
+Most document-based chat systems are tightly coupled to user interfaces, depend on external cloud services, or are difficult to integrate into existing platforms.
+
+ChatCortex focuses exclusively on the **core infrastructure layer**, allowing developers to integrate document chat capabilities into their own systems with minimal overhead.
+
+---
+
+## Core Principles
+
+- **Privacy-first**: All ingestion, retrieval, and inference occur locally  
+- **Library-first design**: Use directly as a Python SDK or wrap with custom APIs  
+- **Frontend-agnostic**: Compatible with any UI or client application  
+- **Backend-oriented**: Built as infrastructure, not a demo application  
+- **Simple and stable API**: Small public surface area intended for long-term stability  
+
+---
+
+## Use Cases
+
+ChatCortex can be used to build:
+
+- Internal enterprise document chatbots  
+- Knowledge base assistants  
+- Policy, HR, and legal document Q&A systems  
+- On-premise or air-gapped AI assistants  
+- Custom chat APIs for proprietary frontends  
+
+---
+
+## Quick Start
+
+```bash
+pip install chatcortex
+
+from chatcortex import ChatCortexEngine
+
+engine = ChatCortexEngine()
+
+# Ingest documents (v0.1 supports .txt files)
+engine.ingest("./docs")
+
+# Ask a question
+response = engine.chat("What is covered in these documents?")
+print(response)
+```
+--- 
+
+## Public API (v0.1)
+
+```
+ChatCortexEngine(
+    config: ChatCortexConfig | None = None
+)
+
+engine.ingest(source: str)
+engine.chat(message: str, session_id: Optional[str] = None) -> str
+engine.reset_session(session_id: str)
+```
+---
+
+## Configuration
+
+```
+from chatcortex.config import ChatCortexConfig
+from chatcortex import ChatCortexEngine
+
+config = ChatCortexConfig(
+    chunk_size=500,
+    chunk_overlap=100
+)
+
+engine = ChatCortexEngine(config)
+```
+
+---
+
+## Design Philosophy
+
+ChatCortex enforces a clear separation of responsibilities:
+
+| Layer       | Responsibility                                    |
+| ----------- | ------------------------------------------------- |
+| Core Engine | Document ingestion, retrieval, session management |
+| API Layer   | Optional adapters (REST, gRPC, etc.)              |
+| Frontend    | Fully owned by the integrator                     |
+
+
+You are free to:
+
+Use ChatCortex directly as a Python library
+
+Wrap it with your own API layer
+
+Integrate it into existing systems
+
+Ignore any optional adapters
+
+---
+
+## Roadmap
+v0.1 -> Core engine -> Local document ingestion -> Session handling
+
+## Planned
+
+PDF ingestion -> Embeddings and vector database support (FAISS, Chroma) -> Streaming responses -> External connectors (S3, SharePoint) -> Optional FastAPI service wrapper
+
+---
+
+## Development Setup
+```
+git clone https://github.com/yourusername/chatcortex
+cd chatcortex
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+---
+
+## License
+
+MIT License
+
+You are free to use, modify, and integrate ChatCortex into commercial and internal products.
+
+---
+
+## Project Goals
+
+ChatCortex is built as infrastructure, not a demo application.
+
+It is intended for teams that require a reusable, local-first document chatbot engine
+without repeatedly rebuilding the same backend components.

chatcortex-0.1.0/README.md

@@ -0,0 +1,143 @@
+# ChatCortex
+
+ChatCortex is a **privacy-first, local document chatbot engine** designed to be embedded into any application.  
+It enables teams to build document-aware conversational systems **without relying on cloud services**, while keeping all data within their own infrastructure.
+
+ChatCortex is **library-first**, **API-agnostic**, and designed for production and enterprise use cases.
+
+---
+
+## Overview
+
+Most document-based chat systems are tightly coupled to user interfaces, depend on external cloud services, or are difficult to integrate into existing platforms.
+
+ChatCortex focuses exclusively on the **core infrastructure layer**, allowing developers to integrate document chat capabilities into their own systems with minimal overhead.
+
+---
+
+## Core Principles
+
+- **Privacy-first**: All ingestion, retrieval, and inference occur locally  
+- **Library-first design**: Use directly as a Python SDK or wrap with custom APIs  
+- **Frontend-agnostic**: Compatible with any UI or client application  
+- **Backend-oriented**: Built as infrastructure, not a demo application  
+- **Simple and stable API**: Small public surface area intended for long-term stability  
+
+---
+
+## Use Cases
+
+ChatCortex can be used to build:
+
+- Internal enterprise document chatbots  
+- Knowledge base assistants  
+- Policy, HR, and legal document Q&A systems  
+- On-premise or air-gapped AI assistants  
+- Custom chat APIs for proprietary frontends  
+
+---
+
+## Quick Start
+
+```bash
+pip install chatcortex
+
+from chatcortex import ChatCortexEngine
+
+engine = ChatCortexEngine()
+
+# Ingest documents (v0.1 supports .txt files)
+engine.ingest("./docs")
+
+# Ask a question
+response = engine.chat("What is covered in these documents?")
+print(response)
+```
+--- 
+
+## Public API (v0.1)
+
+```
+ChatCortexEngine(
+    config: ChatCortexConfig | None = None
+)
+
+engine.ingest(source: str)
+engine.chat(message: str, session_id: Optional[str] = None) -> str
+engine.reset_session(session_id: str)
+```
+---
+
+## Configuration
+
+```
+from chatcortex.config import ChatCortexConfig
+from chatcortex import ChatCortexEngine
+
+config = ChatCortexConfig(
+    chunk_size=500,
+    chunk_overlap=100
+)
+
+engine = ChatCortexEngine(config)
+```
+
+---
+
+## Design Philosophy
+
+ChatCortex enforces a clear separation of responsibilities:
+
+| Layer       | Responsibility                                    |
+| ----------- | ------------------------------------------------- |
+| Core Engine | Document ingestion, retrieval, session management |
+| API Layer   | Optional adapters (REST, gRPC, etc.)              |
+| Frontend    | Fully owned by the integrator                     |
+
+
+You are free to:
+
+Use ChatCortex directly as a Python library
+
+Wrap it with your own API layer
+
+Integrate it into existing systems
+
+Ignore any optional adapters
+
+---
+
+## Roadmap
+v0.1 -> Core engine -> Local document ingestion -> Session handling
+
+## Planned
+
+PDF ingestion -> Embeddings and vector database support (FAISS, Chroma) -> Streaming responses -> External connectors (S3, SharePoint) -> Optional FastAPI service wrapper
+
+---
+
+## Development Setup
+```
+git clone https://github.com/yourusername/chatcortex
+cd chatcortex
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+---
+
+## License
+
+MIT License
+
+You are free to use, modify, and integrate ChatCortex into commercial and internal products.
+
+---
+
+## Project Goals
+
+ChatCortex is built as infrastructure, not a demo application.
+
+It is intended for teams that require a reusable, local-first document chatbot engine
+without repeatedly rebuilding the same backend components.

chatcortex-0.1.0/chatcortex/__init__.py

@@ -0,0 +1,5 @@
+from .engine import ChatCortexEngine
+
+__all__ = ["ChatCortexEngine"]
+
+__version__ = "0.1.0"

chatcortex-0.1.0/chatcortex/config.py

@@ -0,0 +1,13 @@
+#Configuration handling
+
+from dataclasses import dataclass
+from typing import Optional
+
+@dataclass
+class ChatCortexConfig:
+    embedding_model: str = "all-MiniLM-L6-v2"
+    vector_db: str = "faiss"
+    chunk_size: int = 500
+    chunk_overlap: int = 100
+    llm_model: str = "local"
+    persist_path: Optional[str] = None

chatcortex-0.1.0/chatcortex/engine.py

@@ -0,0 +1,48 @@
+#Core Engine (Public API)
+
+from typing import Dict, Optional
+
+from .config import ChatCortexConfig
+from .ingestion import DocumentIngestor
+from .retriever import Retriever
+from .session import ChatSession
+from .exceptions import SessionError
+
+
+class ChatCortexEngine:
+    def __init__(self, config: ChatCortexConfig | None = None):
+        self.config = config or ChatCortexConfig()
+        self.ingestor = DocumentIngestor()
+        self.retriever = Retriever()
+        self.sessions: Dict[str, ChatSession] = {}
+    
+    def ingest(self, source: str):
+        documents = self.ingestor.load_from_path(source)
+        self.retriever.index(documents)
+    
+    def chat(self, message: str, session_id: Optional[str] = None) -> str:
+        session = self._get_or_create_session(session_id)
+        session.add_user_message(message)
+
+        context = self.retriever.retrieve(message)
+        response = self._generate_response(message, context)
+
+        session.add_assistant_message(response)
+        return response, session.session_id
+
+    def reset_session(self, session_id: str):
+        if session_id not in self.sessions:
+            raise SessionError("Session not found")
+        self.sessions[session_id].clear()
+    
+    def _get_or_create_session(self, session_id: Optional[str]) -> ChatSession:
+        if session_id and session_id in self.sessions:
+            return self.sessions[session_id]
+        
+        session = ChatSession(session_id)
+        self.sessions[session.session_id] = session
+        return session
+    
+    def _generate_response(self, message: str, context: list[str]) -> str:
+        # v0.1 initial setup
+        return f"Answer Based on {len(context)} document(s)."

chatcortex-0.1.0/chatcortex/exceptions.py

@@ -0,0 +1,17 @@
+#Custom exceptions
+
+class ChatCortexError(Exception):
+    """Base exception for ChatCortex"""
+
+class ConfigurationError(ChatCortexError):
+    """Raised when configuration is invalid"""
+
+class IngestionError(ChatCortexError):
+    """Raised when document ingestion fails"""
+
+class RetrievalError(ChatCortexError):
+    """Raised when retrieval fails"""
+
+class SessionError(ChatCortexError):
+    """Raised for session-related issues"""
+

chatcortex-0.1.0/chatcortex/ingestion.py

@@ -0,0 +1,26 @@
+#Document ingestion
+
+from pathlib import Path
+from typing import List
+
+from .exceptions import IngestionError
+
+
+class DocumentIngestor:
+    def load_from_path(self, path: str) -> List[str]:
+        p = Path(path)
+
+        if not p.exists():
+            raise IngestionError(f"Path does exist: {path}")
+        
+        documents: List[str] = []
+
+        if p.is_file() and p.suffix == ".txt":
+            documents.append(p.read_text(encoding="utf-8"))
+        elif p.is_dir():
+            for file in p.rglob("*.txt"):
+                documents.append(file.read_text(encoding="utf-8"))
+        else:
+            raise IngestionError("Only .txt files are supported in v0.1")
+    
+        return documents

chatcortex-0.1.0/chatcortex/retriever.py

@@ -0,0 +1,15 @@
+#Vector retrieval
+
+from typing import List
+
+
+class Retriever:
+    def __init__(self):
+        self._documents: List[str] = []
+    
+    def index(self, documents: List[str]):
+        self._documents.extend(documents)
+    
+    def retrieve(self, query: str, k: int = 3) -> List[str]:
+        # v0.1: Simple retrievel
+        return self._documents[:k]

chatcortex-0.1.0/chatcortex/session.py

@@ -0,0 +1,19 @@
+#Chat session and memoy
+
+from typing import List, Dict
+from uuid import uuid4
+
+
+class ChatSession:
+    def __init__(self, session_id: str | None = None):
+        self.session_id = session_id or str(uuid4())
+        self.history: List[Dict[str, str]] = []
+
+    def add_user_message(self, message: str):
+        self.history.append({"role": "user", "content": message})
+    
+    def add_assistant_message(self, message: str):
+        self.history.append({"role": "assistant", "content": message})
+    
+    def clear(self):
+        self.history.clear()

chatcortex-0.1.0/chatcortex.egg-info/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: chatcortex
+Version: 0.1.0
+Summary: A privacy-first, local document chatbot engine
+Author: Siddharth Saraswat
+License: MIT
+Project-URL: Homepage, https://github.com/siddharth1012/chatCortex
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ChatCortex
+
+ChatCortex is a **privacy-first, local document chatbot engine** designed to be embedded into any application.  
+It enables teams to build document-aware conversational systems **without relying on cloud services**, while keeping all data within their own infrastructure.
+
+ChatCortex is **library-first**, **API-agnostic**, and designed for production and enterprise use cases.
+
+---
+
+## Overview
+
+Most document-based chat systems are tightly coupled to user interfaces, depend on external cloud services, or are difficult to integrate into existing platforms.
+
+ChatCortex focuses exclusively on the **core infrastructure layer**, allowing developers to integrate document chat capabilities into their own systems with minimal overhead.
+
+---
+
+## Core Principles
+
+- **Privacy-first**: All ingestion, retrieval, and inference occur locally  
+- **Library-first design**: Use directly as a Python SDK or wrap with custom APIs  
+- **Frontend-agnostic**: Compatible with any UI or client application  
+- **Backend-oriented**: Built as infrastructure, not a demo application  
+- **Simple and stable API**: Small public surface area intended for long-term stability  
+
+---
+
+## Use Cases
+
+ChatCortex can be used to build:
+
+- Internal enterprise document chatbots  
+- Knowledge base assistants  
+- Policy, HR, and legal document Q&A systems  
+- On-premise or air-gapped AI assistants  
+- Custom chat APIs for proprietary frontends  
+
+---
+
+## Quick Start
+
+```bash
+pip install chatcortex
+
+from chatcortex import ChatCortexEngine
+
+engine = ChatCortexEngine()
+
+# Ingest documents (v0.1 supports .txt files)
+engine.ingest("./docs")
+
+# Ask a question
+response = engine.chat("What is covered in these documents?")
+print(response)
+```
+--- 
+
+## Public API (v0.1)
+
+```
+ChatCortexEngine(
+    config: ChatCortexConfig | None = None
+)
+
+engine.ingest(source: str)
+engine.chat(message: str, session_id: Optional[str] = None) -> str
+engine.reset_session(session_id: str)
+```
+---
+
+## Configuration
+
+```
+from chatcortex.config import ChatCortexConfig
+from chatcortex import ChatCortexEngine
+
+config = ChatCortexConfig(
+    chunk_size=500,
+    chunk_overlap=100
+)
+
+engine = ChatCortexEngine(config)
+```
+
+---
+
+## Design Philosophy
+
+ChatCortex enforces a clear separation of responsibilities:
+
+| Layer       | Responsibility                                    |
+| ----------- | ------------------------------------------------- |
+| Core Engine | Document ingestion, retrieval, session management |
+| API Layer   | Optional adapters (REST, gRPC, etc.)              |
+| Frontend    | Fully owned by the integrator                     |
+
+
+You are free to:
+
+Use ChatCortex directly as a Python library
+
+Wrap it with your own API layer
+
+Integrate it into existing systems
+
+Ignore any optional adapters
+
+---
+
+## Roadmap
+v0.1 -> Core engine -> Local document ingestion -> Session handling
+
+## Planned
+
+PDF ingestion -> Embeddings and vector database support (FAISS, Chroma) -> Streaming responses -> External connectors (S3, SharePoint) -> Optional FastAPI service wrapper
+
+---
+
+## Development Setup
+```
+git clone https://github.com/yourusername/chatcortex
+cd chatcortex
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+---
+
+## License
+
+MIT License
+
+You are free to use, modify, and integrate ChatCortex into commercial and internal products.
+
+---
+
+## Project Goals
+
+ChatCortex is built as infrastructure, not a demo application.
+
+It is intended for teams that require a reusable, local-first document chatbot engine
+without repeatedly rebuilding the same backend components.

chatcortex-0.1.0/chatcortex.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+LICENSE
+README.md
+pyproject.toml
+chatcortex/__init__.py
+chatcortex/config.py
+chatcortex/engine.py
+chatcortex/exceptions.py
+chatcortex/ingestion.py
+chatcortex/retriever.py
+chatcortex/session.py
+chatcortex.egg-info/PKG-INFO
+chatcortex.egg-info/SOURCES.txt
+chatcortex.egg-info/dependency_links.txt
+chatcortex.egg-info/top_level.txt
+tests/test_engine.py

chatcortex-0.1.0/chatcortex.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

chatcortex-0.1.0/chatcortex.egg-info/top_level.txt

@@ -0,0 +1 @@
+chatcortex

chatcortex-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "chatcortex"
+version = "0.1.0"
+description = "A privacy-first, local document chatbot engine"
+authors = [{ name = "Siddharth Saraswat" }]
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+
+dependencies = []
+
+[project.urls]
+Homepage = "https://github.com/siddharth1012/chatCortex"

chatcortex-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+