narrative-ai-framework 0.1.0__tar.gz

narrative_ai_framework-0.1.0/LICENSE

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

narrative_ai_framework-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+recursive-include narrative_ai *.yaml
+recursive-include narrative_ai *.json
+recursive-include narrative_ai *.txt
+recursive-include config *.yml
+recursive-include config *.txt
+include README.md
+include LICENSE
+include requirements*.txt

narrative_ai_framework-0.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: narrative-ai-framework
+Version: 0.1.0
+Summary: AI-powered voice diary framework: STT, TTS, LLM, RAG, and voice-agent engines
+Author: Narrative AI Team
+License: MIT
+Keywords: ai,voice,diary,stt,tts,llm,rag,arabic
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.1
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.5.0
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: requests>=2.28.0
+Requires-Dist: shortuuid>=1.0.11
+Requires-Dist: pyngrok>=7.0.0
+Requires-Dist: nest-asyncio>=1.5.8
+Requires-Dist: sympy>=1.12
+Provides-Extra: stt
+Requires-Dist: soundfile>=0.12.1; extra == "stt"
+Requires-Dist: scipy>=1.11.0; extra == "stt"
+Requires-Dist: webrtcvad>=2.0.10; extra == "stt"
+Requires-Dist: numpy>=1.24.0; extra == "stt"
+Requires-Dist: elevenlabs>=0.2.0; extra == "stt"
+Requires-Dist: yt-dlp>=2023.11.0; extra == "stt"
+Requires-Dist: pydub>=0.25.1; extra == "stt"
+Requires-Dist: transformers>=4.36.0; extra == "stt"
+Requires-Dist: accelerate>=0.25.0; extra == "stt"
+Requires-Dist: torch>=2.1.0; extra == "stt"
+Requires-Dist: ctranslate2>=4.0.0; extra == "stt"
+Requires-Dist: faster-whisper>=1.0.0; extra == "stt"
+Provides-Extra: tts
+Requires-Dist: aiohttp>=3.9.0; extra == "tts"
+Requires-Dist: numpy>=1.24.0; extra == "tts"
+Provides-Extra: ocr
+Requires-Dist: opencv-python>=4.8.0; extra == "ocr"
+Requires-Dist: scikit-image>=0.21.0; extra == "ocr"
+Requires-Dist: pdf2image>=1.16.3; extra == "ocr"
+Requires-Dist: python-docx>=1.1.0; extra == "ocr"
+Requires-Dist: einops>=0.6.1; extra == "ocr"
+Requires-Dist: torch>=2.0.1; extra == "ocr"
+Requires-Dist: torchvision>=0.15.2; extra == "ocr"
+Requires-Dist: transformers>=4.45.0; extra == "ocr"
+Requires-Dist: accelerate>=0.26.0; extra == "ocr"
+Requires-Dist: qwen-vl-utils>=0.0.4; extra == "ocr"
+Requires-Dist: timm>=0.9.2; extra == "ocr"
+Requires-Dist: basicsr>=1.4.2; extra == "ocr"
+Requires-Dist: realesrgan>=0.3.0; extra == "ocr"
+Provides-Extra: llm
+Requires-Dist: google-generativeai>=0.3.0; extra == "llm"
+Requires-Dist: google-genai>=0.3.0; extra == "llm"
+Requires-Dist: openai>=1.3.0; extra == "llm"
+Requires-Dist: anthropic>=0.18.0; extra == "llm"
+Requires-Dist: tiktoken>=0.5.0; extra == "llm"
+Provides-Extra: voice
+Requires-Dist: livekit>=0.11.0; extra == "voice"
+Requires-Dist: livekit-api>=0.4.0; extra == "voice"
+Requires-Dist: livekit-agents>=0.7.0; extra == "voice"
+Requires-Dist: livekit-plugins-silero>=0.6.0; extra == "voice"
+Requires-Dist: livekit-plugins-elevenlabs>=1.3.0; extra == "voice"
+Requires-Dist: livekit-plugins-turn-detector>=1.3.0; extra == "voice"
+Requires-Dist: livekit-plugins-noise-cancellation>=0.2.0; extra == "voice"
+Requires-Dist: sounddevice>=0.5.0; extra == "voice"
+Provides-Extra: db
+Requires-Dist: SQLAlchemy>=2.0.0; extra == "db"
+Requires-Dist: asyncpg>=0.29.0; extra == "db"
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "db"
+Requires-Dist: alembic>=1.13.0; extra == "db"
+Requires-Dist: redis>=5.0.0; extra == "db"
+Provides-Extra: security
+Requires-Dist: redis>=5.0.0; extra == "security"
+Requires-Dist: SQLAlchemy>=2.0.0; extra == "security"
+Requires-Dist: cryptography>=41.0.0; extra == "security"
+Requires-Dist: PyJWT>=2.8.0; extra == "security"
+Requires-Dist: bcrypt>=4.0.0; extra == "security"
+Provides-Extra: api
+Requires-Dist: fastapi>=0.109.0; extra == "api"
+Requires-Dist: uvicorn[standard]>=0.27.0; extra == "api"
+Requires-Dist: python-multipart>=0.0.6; extra == "api"
+Requires-Dist: email-validator>=2.1.0; extra == "api"
+Provides-Extra: rag
+Requires-Dist: sentence-transformers>=2.2.2; extra == "rag"
+Requires-Dist: FlagEmbedding>=1.3.5; extra == "rag"
+Requires-Dist: pillow>=10.0.0; extra == "rag"
+Requires-Dist: psutil>=5.9.0; extra == "rag"
+Requires-Dist: unstructured[all-docs]>=0.10.0; extra == "rag"
+Requires-Dist: python-magic>=0.4.27; extra == "rag"
+Requires-Dist: pytesseract>=0.3.10; extra == "rag"
+Requires-Dist: pgvector>=0.2.5; extra == "rag"
+Requires-Dist: qdrant-client>=1.7.0; extra == "rag"
+Provides-Extra: web
+Requires-Dist: ddgs>=9.0.0; extra == "web"
+Provides-Extra: vlm
+Requires-Dist: pillow>=10.0.0; extra == "vlm"
+Requires-Dist: numpy>=1.24.0; extra == "vlm"
+Requires-Dist: ollama>=0.1.0; extra == "vlm"
+Provides-Extra: all
+Requires-Dist: soundfile>=0.12.1; extra == "all"
+Requires-Dist: scipy>=1.11.0; extra == "all"
+Requires-Dist: webrtcvad>=2.0.10; extra == "all"
+Requires-Dist: numpy>=1.24.0; extra == "all"
+Requires-Dist: elevenlabs>=0.2.0; extra == "all"
+Requires-Dist: yt-dlp>=2023.11.0; extra == "all"
+Requires-Dist: pydub>=0.25.1; extra == "all"
+Requires-Dist: transformers>=4.36.0; extra == "all"
+Requires-Dist: accelerate>=0.25.0; extra == "all"
+Requires-Dist: torch>=2.1.0; extra == "all"
+Requires-Dist: ctranslate2>=4.0.0; extra == "all"
+Requires-Dist: faster-whisper>=1.0.0; extra == "all"
+Requires-Dist: aiohttp>=3.9.0; extra == "all"
+Requires-Dist: google-generativeai>=0.3.0; extra == "all"
+Requires-Dist: google-genai>=0.3.0; extra == "all"
+Requires-Dist: openai>=1.3.0; extra == "all"
+Requires-Dist: anthropic>=0.18.0; extra == "all"
+Requires-Dist: tiktoken>=0.5.0; extra == "all"
+Requires-Dist: livekit>=0.11.0; extra == "all"
+Requires-Dist: livekit-api>=0.4.0; extra == "all"
+Requires-Dist: livekit-agents>=0.7.0; extra == "all"
+Requires-Dist: livekit-plugins-silero>=0.6.0; extra == "all"
+Requires-Dist: livekit-plugins-elevenlabs>=1.3.0; extra == "all"
+Requires-Dist: livekit-plugins-turn-detector>=1.3.0; extra == "all"
+Requires-Dist: livekit-plugins-noise-cancellation>=0.2.0; extra == "all"
+Requires-Dist: sounddevice>=0.5.0; extra == "all"
+Requires-Dist: SQLAlchemy>=2.0.0; extra == "all"
+Requires-Dist: asyncpg>=0.29.0; extra == "all"
+Requires-Dist: psycopg2-binary>=2.9.0; extra == "all"
+Requires-Dist: alembic>=1.13.0; extra == "all"
+Requires-Dist: redis>=5.0.0; extra == "all"
+Requires-Dist: cryptography>=41.0.0; extra == "all"
+Requires-Dist: PyJWT>=2.8.0; extra == "all"
+Requires-Dist: bcrypt>=4.0.0; extra == "all"
+Requires-Dist: fastapi>=0.109.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.27.0; extra == "all"
+Requires-Dist: python-multipart>=0.0.6; extra == "all"
+Requires-Dist: email-validator>=2.1.0; extra == "all"
+Requires-Dist: ddgs>=9.0.0; extra == "all"
+Requires-Dist: opencv-python>=4.8.0; extra == "all"
+Requires-Dist: scikit-image>=0.21.0; extra == "all"
+Requires-Dist: pdf2image>=1.16.3; extra == "all"
+Requires-Dist: python-docx>=1.1.0; extra == "all"
+Requires-Dist: einops>=0.6.1; extra == "all"
+Requires-Dist: qwen-vl-utils>=0.0.4; extra == "all"
+Requires-Dist: pgvector>=0.2.5; extra == "all"
+Requires-Dist: qdrant-client>=1.7.0; extra == "all"
+Requires-Dist: ollama>=0.1.0; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.4.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: httpx>=0.25.0; extra == "dev"
+Requires-Dist: mypy>=1.7.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Dynamic: license-file
+
+# Narrative AI SDK 🚀
+
+A powerful, production-ready AI framework designed for developers to build multi-engine AI applications with ease. Supporting LLM, OCR, STT, TTS, RAG, and more.
+
+## 🌟 Features
+
+- **Unified API**: Control multiple AI engines (OpenAI, Gemini, Anthropic, ElevenLabs, etc.) through a single interface.
+- **Arabic-Aware**: Specialized support for Arabic text processing and speech.
+- **Multimodal**: Seamlessly integrate Voice, Text, Images, and Web data.
+- **Production-Ready**: Includes rate limiting, audit logging, and robust error handling.
+
+## 📦 Installation
+
+```bash
+pip install narrative-ai-framework
+```
+
+To install specific engine requirements (e.g., STT and TTS):
+```bash
+pip install "narrative-ai-framework[stt,tts]"
+```
+
+## 🚀 Quick Start
+
+```python
+import narrative_ai as nai
+import asyncio
+
+async def main():
+    # 1. Setup your API keys
+    nai.llm.set_api_key("your-openai-key", provider="openai")
+    
+    # 2. Simple Generation
+    response = await nai.llm.generate("Tell me a story about a helpful robot.")
+    print(response.text)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## ⛓️ Supported Integration Workflows
+
+The SDK allows you to easily chain multiple engines together:
+
+| Workflow Name | Engines Involved | Description |
+| :--- | :--- | :--- |
+| **Voice Chat** | STT ➡️ LLM ➡️ TTS | Full voice-to-voice interaction. |
+| **Doc Analysis** | Input ➡️ OCR ➡️ LLM | Summarize and analyze PDF/Images. |
+| **Smart Memory** | Input ➡️ RAG ➡️ LLM | Knowledge base and Q&A. |
+| **AI Research** | Web ➡️ LLM | Search the web and synthesize reports. |
+| **Visual Chat** | VLM ➡️ LLM | Chat about image contents. |
+
+## 🛡️ License
+
+This project is licensed under the MIT License.

narrative_ai_framework-0.1.0/README.md

@@ -0,0 +1,55 @@
+# Narrative AI SDK 🚀
+
+A powerful, production-ready AI framework designed for developers to build multi-engine AI applications with ease. Supporting LLM, OCR, STT, TTS, RAG, and more.
+
+## 🌟 Features
+
+- **Unified API**: Control multiple AI engines (OpenAI, Gemini, Anthropic, ElevenLabs, etc.) through a single interface.
+- **Arabic-Aware**: Specialized support for Arabic text processing and speech.
+- **Multimodal**: Seamlessly integrate Voice, Text, Images, and Web data.
+- **Production-Ready**: Includes rate limiting, audit logging, and robust error handling.
+
+## 📦 Installation
+
+```bash
+pip install narrative-ai-framework
+```
+
+To install specific engine requirements (e.g., STT and TTS):
+```bash
+pip install "narrative-ai-framework[stt,tts]"
+```
+
+## 🚀 Quick Start
+
+```python
+import narrative_ai as nai
+import asyncio
+
+async def main():
+    # 1. Setup your API keys
+    nai.llm.set_api_key("your-openai-key", provider="openai")
+    
+    # 2. Simple Generation
+    response = await nai.llm.generate("Tell me a story about a helpful robot.")
+    print(response.text)
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## ⛓️ Supported Integration Workflows
+
+The SDK allows you to easily chain multiple engines together:
+
+| Workflow Name | Engines Involved | Description |
+| :--- | :--- | :--- |
+| **Voice Chat** | STT ➡️ LLM ➡️ TTS | Full voice-to-voice interaction. |
+| **Doc Analysis** | Input ➡️ OCR ➡️ LLM | Summarize and analyze PDF/Images. |
+| **Smart Memory** | Input ➡️ RAG ➡️ LLM | Knowledge base and Q&A. |
+| **AI Research** | Web ➡️ LLM | Search the web and synthesize reports. |
+| **Visual Chat** | VLM ➡️ LLM | Chat about image contents. |
+
+## 🛡️ License
+
+This project is licensed under the MIT License.

narrative_ai_framework-0.1.0/config/__init__.py

@@ -0,0 +1,31 @@
+"""
+Configuration module for Narrative AI Framework.
+
+This module provides centralized configuration management for all
+providers and services.
+"""
+
+from .providers import (
+    ProvidersConfig,
+    ProviderInfo,
+    ProviderType,
+    get_providers_config,
+    get_llm_provider,
+    get_stt_provider,
+    get_tts_provider,
+    get_web_provider,
+)
+
+__all__ = [
+    # Classes
+    "ProvidersConfig",
+    "ProviderInfo",
+    "ProviderType",
+    
+    # Functions
+    "get_providers_config",
+    "get_llm_provider",
+    "get_stt_provider",
+    "get_tts_provider",
+    "get_web_provider",
+]

narrative_ai_framework-0.1.0/config/env.example.txt

@@ -0,0 +1,96 @@
+# =============================================================================
+# NARRATIVE AI - ENVIRONMENT VARIABLES
+# =============================================================================
+#
+# Instructions:
+#   1. Copy this file to .env in the project root (the directory that contains
+#      framework/ and config/). The API loads .env from the project root.
+#   2. Fill in your API keys
+#   3. The providers.yml file references these variables
+#
+# =============================================================================
+
+# =============================================================================
+# LLM PROVIDERS
+# =============================================================================
+
+# ------------- GEMINI (Google) - FREE -------------
+# Get your key: https://aistudio.google.com/apikey
+GEMINI_API_KEY=your_gemini_api_key_here
+
+# ------------- OPENAI (GPT) - Paid -------------
+# Get your key: https://platform.openai.com/api-keys
+OPENAI_API_KEY=your_openai_api_key_here
+OPENAI_ORG_ID=                                    # Optional
+
+# ------------- WEB INTELLIGENCE (Optional) -------------
+# Default provider is DuckDuckGo (no key required)
+WEB_INTEL_ENABLED=1
+WEB_INTEL_MODE=auto                               # off | auto | force
+# For Google Custom Search (optional)
+# GOOGLE_SEARCH_API_KEY=your_google_search_api_key
+# GOOGLE_SEARCH_CX=your_google_search_engine_id
+
+# ------------- ANTHROPIC (Claude) - Paid -------------
+# Get your key: https://console.anthropic.com/
+ANTHROPIC_API_KEY=your_anthropic_api_key_here
+
+# =============================================================================
+# STT/TTS PROVIDERS
+# =============================================================================
+
+# ------------- ELEVENLABS - FREE tier: 10K chars/month -------------
+# Get your key: https://elevenlabs.io/app/settings/api-keys
+ELEVENLABS_API_KEY=your_elevenlabs_api_key_here
+ELEVENLABS_VOICE_ID=                              # Optional: Custom voice ID
+
+# ------------- GOOGLE CLOUD (Optional) -------------
+# Download credentials JSON from Google Cloud Console
+GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
+
+# =============================================================================
+# REAL-TIME (LIVEKIT)
+# =============================================================================
+
+# ------------- LIVEKIT - FREE tier available -------------
+# Get credentials: https://cloud.livekit.io
+LIVEKIT_URL=wss://your-project.livekit.cloud
+LIVEKIT_API_KEY=your_livekit_api_key
+LIVEKIT_API_SECRET=your_livekit_api_secret
+
+# =============================================================================
+# CUSTOM/LOCAL MODELS
+# =============================================================================
+
+# Fine-tuned Whisper server
+WHISPER_MODEL_PATH=                               # Local path or HuggingFace ID
+WHISPER_SERVER_URL=http://localhost:8000          # If using server mode
+
+# Fine-tuned Conformer model
+CONFORMER_MODEL_PATH=                             # Local path or HuggingFace ID
+
+# Custom TTS server
+CUSTOM_TTS_SERVER_URL=http://localhost:8001
+
+# =============================================================================
+# INFRASTRUCTURE
+# =============================================================================
+
+# Database (PostgreSQL)
+DATABASE_URL=postgresql://narrative:narrative_dev_password@localhost:5432/narrative_ai
+
+# Redis (Caching & Rate Limiting)
+REDIS_URL=redis://localhost:6379/0
+
+# Environment
+ENV=development                                   # development, staging, production
+
+# =============================================================================
+# SECURITY
+# =============================================================================
+
+# JWT Secret (generate with: openssl rand -hex 32)
+JWT_SECRET=your_jwt_secret_here
+
+# Encryption Key (generate with: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())")
+ENCRYPTION_KEY=your_encryption_key_here