jarvise 1.0.0__tar.gz

jarvise-1.0.0/.env.example

@@ -0,0 +1,45 @@
+# JARVIS Environment Configuration Template
+# Copy this file to .env and fill in your values
+
+# Ollama Configuration
+OLLAMA_HOST=http://localhost:11434
+OLLAMA_MODEL=llama3.2:latest
+
+# Voice Configuration
+WAKE_WORD=jarvis
+WHISPER_MODEL=base
+KOKORO_VOICE=af_sarah
+TTS_SPEED=1.0
+
+# Memory Configuration
+CHROMA_PERSIST_DIRECTORY=./data/chromadb
+MEMORY_FILE=./data/MEMORY.md
+
+# UI Configuration
+# Use 127.0.0.1 for local-only access (default, secure)
+# Use 0.0.0.0 for remote access (requires API_KEY)
+UI_HOST=127.0.0.1
+UI_PORT=8000
+
+# API Authentication (required for remote/destructive operations)
+# Generate a secure random key: python -c "import secrets; print(secrets.token_hex(32))"
+API_KEY=
+ALLOW_REMOTE_ACCESS=false
+
+# Token Encryption Key (for OAuth token storage)
+# Generate: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key().decode())"
+# Required for Google Calendar/Email integration to persist tokens
+JARVIS_TOKEN_KEY=
+
+# Google Calendar (optional)
+GOOGLE_CALENDAR_CREDS_PATH=
+
+# Google Email (optional)
+GOOGLE_EMAIL_CREDS_PATH=
+
+# Microsoft Outlook (optional)
+OUTLOOK_CREDS_PATH=
+
+# Logging
+LOG_LEVEL=INFO
+LOG_FILE=./data/jarvis.log

jarvise-1.0.0/HowToRun.md

@@ -0,0 +1,184 @@
+# How to Run JARVIS
+
+This guide explains how to run JARVIS on your local machine.
+
+---
+
+## Prerequisites
+
+- **Python 3.11+** - Download from python.org
+- **Ollama** - For local LLM inference
+  - Download from: https://ollama.com
+  - Must be running on `localhost:11434`
+- **Node.js 18+** (optional) - For CLI npm package
+
+---
+
+## Local Setup
+
+### 1. Clone the Repository
+
+```bash
+git clone <repository-url>
+cd JARVISE
+```
+
+### 2. Create Virtual Environment
+
+```bash
+# Windows
+python -m venv .venv
+.venv\Scripts\activate
+
+# Linux/Mac
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+### 3. Install Dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+### 4. Configure Environment
+
+Copy `.env.example` to `.env` and configure:
+
+```bash
+# Required: Ollama Configuration
+OLLAMA_HOST=http://localhost:11434
+OLLAMA_MODEL=llama3.2:latest
+
+# Optional: UI Configuration
+UI_HOST=127.0.0.1
+UI_PORT=8000
+```
+
+### 5. Start Ollama
+
+Ensure Ollama is running with your chosen model:
+
+```bash
+ollama serve
+ollama pull llama3.2
+```
+
+---
+
+## Running JARVIS
+
+### Option 1: Full Application (Recommended)
+
+Starts both backend API and web UI:
+
+```bash
+python main.py
+```
+
+Then open **http://localhost:8000** in your browser.
+
+---
+
+### Option 2: Backend Only
+
+For API-only access:
+
+```bash
+python -m backend.main
+```
+
+The API will be available at **http://localhost:8000**
+
+---
+
+### Option 3: CLI Shell
+
+Interactive terminal interface:
+
+```bash
+# Using installed package
+jarvis shell
+
+# Or using Python module
+python -m cli shell
+```
+
+Commands:
+- Type normally to chat
+- `:help` - Show help
+- `:stats` - System statistics
+- `:memory` - View memories
+- `:clear` - Clear conversation
+- `:quit` - Exit
+
+---
+
+### Option 4: One-liner Chat
+
+Send a single message:
+
+```bash
+jarvis chat "Hello, how are you?"
+```
+
+---
+
+## Running the Web UI (Alternative)
+
+The frontend is a React application. To run it separately:
+
+```bash
+# Navigate to UI directory
+cd ui
+
+# Install dependencies
+npm install
+
+# Build for production
+npm run build
+
+# The built files are served by the backend (main.py)
+```
+
+---
+
+## Troubleshooting
+
+### Ollama Not Running
+
+```bash
+# Check if Ollama is running
+ollama list
+
+# Start Ollama
+ollama serve
+```
+
+### Port Already in Use
+
+Change the port in `.env`:
+
+```bash
+UI_PORT=8001
+```
+
+### Memory Issues
+
+If you encounter VRAM issues, use a smaller model:
+
+```bash
+OLLAMA_MODEL=llama3.2:1b
+```
+
+---
+
+## Next Steps
+
+- See **README.md** for full feature documentation
+- Check **Docs/** folder for advanced topics
+- Configure API key for remote access in `.env`
+
+---
+
+*For more information, see README.md*

jarvise-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 J.A.R.V.I.S
+
+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.

jarvise-1.0.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include .env.example
+include HowToRun.md
+recursive-include ui/dist *
+recursive-exclude tests *
+recursive-exclude __pycache__ *
+recursive-exclude *.egg-info *

jarvise-1.0.0/PKG-INFO

@@ -0,0 +1,442 @@
+Metadata-Version: 2.4
+Name: jarvise
+Version: 1.0.0
+Summary: Privacy-first local AI assistant with voice, memory, and Ollama — JARVIS
+Author: J.A.R.V.I.S
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Ashutosh3021/JARVISE
+Project-URL: Documentation, https://github.com/Ashutosh3021/JARVISE/blob/main/HowToRun.md
+Project-URL: Repository, https://github.com/Ashutosh3021/JARVISE
+Project-URL: Issues, https://github.com/Ashutosh3021/JARVISE/issues
+Keywords: jarvis,ai-assistant,ollama,voice-assistant,chromadb,fastapi,local-ai,react-agent
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: psutil>=5.9.0
+Requires-Dist: requests>=2.31.0
+Requires-Dist: ollama>=0.1.0
+Requires-Dist: chromadb>=0.4.0
+Requires-Dist: sentence-transformers>=2.2.0
+Requires-Dist: fastapi>=0.109.0
+Requires-Dist: uvicorn[standard]>=0.27.0
+Requires-Dist: websockets>=12.0.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: aiofiles>=23.2.0
+Requires-Dist: httpx>=0.26.0
+Requires-Dist: duckduckgo-search>=6.0.0
+Requires-Dist: numpy>=1.24.0
+Requires-Dist: cryptography>=41.0.0
+Provides-Extra: voice
+Requires-Dist: faster-whisper>=1.0.0; extra == "voice"
+Requires-Dist: kokoro-onnx<0.5.0,>=0.4.0; extra == "voice"
+Requires-Dist: sounddevice>=0.4.0; extra == "voice"
+Requires-Dist: soundfile>=0.12.0; extra == "voice"
+Requires-Dist: webrtcvad-wheels>=2.0.10; extra == "voice"
+Requires-Dist: keyboard>=0.13.0; extra == "voice"
+Requires-Dist: librosa>=0.10.0; extra == "voice"
+Requires-Dist: nvidia-ml-py>=13.0.0; extra == "voice"
+Requires-Dist: gpu-list>=0.1.0; extra == "voice"
+Provides-Extra: google
+Requires-Dist: google-api-python-client>=2.100.0; extra == "google"
+Requires-Dist: google-auth-oauthlib>=1.0.0; extra == "google"
+Requires-Dist: google-auth-httplib2>=0.2.0; extra == "google"
+Provides-Extra: microsoft
+Requires-Dist: msgraph-sdk>=1.0.0; extra == "microsoft"
+Requires-Dist: azure-identity>=1.15.0; extra == "microsoft"
+Requires-Dist: msal>=1.24.0; extra == "microsoft"
+Provides-Extra: browser
+Requires-Dist: playwright>=1.40.0; extra == "browser"
+Provides-Extra: cli
+Requires-Dist: aiohttp>=3.9.0; extra == "cli"
+Requires-Dist: prompt-toolkit>=3.0.0; extra == "cli"
+Provides-Extra: all
+Requires-Dist: jarvise[browser,cli,google,microsoft,voice]; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<img src="https://img.shields.io/badge/JARVIS-v1.0.204-blueviolet?style=for-the-badge&logo=robot&logoColor=white" alt="JARVIS v1.0.204"/>
+
+# 👾 JARVIS
+### *Just A Rather Very Intelligent System*
+
+**A privacy-first, fully local AI assistant — voice, web UI, and CLI in one package.**
+
+<br/>
+
+[![Python Version](https://img.shields.io/badge/python-3.11+-3776AB?style=flat-square&logo=python&logoColor=white)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-backend-009688?style=flat-square&logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/)
+[![React](https://img.shields.io/badge/React-18-61DAFB?style=flat-square&logo=react&logoColor=black)](https://react.dev/)
+[![Ollama](https://img.shields.io/badge/Ollama-LLM-FF6600?style=flat-square)](https://ollama.com)
+[![ChromaDB](https://img.shields.io/badge/ChromaDB-memory-green?style=flat-square)](https://www.trychroma.com/)
+[![License](https://img.shields.io/badge/license-MIT-22c55e?style=flat-square)](LICENSE)
+[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20Linux%20%7C%20macOS-lightgrey?style=flat-square)]()
+
+<br/>
+
+> 🔒 **100% local. No cloud. No telemetry. Your data never leaves your machine.**
+
+<br/>
+
+[🚀 Quick Start](#-quick-start) · [✨ Features](#-features) · [🏗️ Architecture](#️-architecture) · [📁 Project Structure](#-project-structure) · [🛠️ Tech Stack](#️-tech-stack) · [📖 Docs](#-documentation)
+
+---
+
+</div>
+
+## Quick Start
+
+> **New to JARVIS?** Follow the setup guide first → **[HowToRun.md](HowToRun.md)**
+
+### Install from PyPI
+
+```bash
+# Core install (no voice)
+pip install jarvise
+
+# With voice support (Whisper STT + Kokoro TTS)
+pip install jarvise[voice]
+
+# Everything — voice, Google, Microsoft, browser, CLI
+pip install jarvise[all]
+```
+
+### Prerequisites
+
+1. **Ollama** must be installed and running before starting JARVIS:
+   ```bash
+   # Install Ollama: https://ollama.com/download
+   ollama serve
+   ollama pull llama3.2
+   ```
+
+2. **Configure your environment:**
+   ```bash
+   cp .env.example .env
+   # Edit .env and set OLLAMA_MODEL, BACKEND_PORT, etc.
+   ```
+
+3. **Run JARVIS:**
+   ```bash
+   jarvis
+   ```
+   Or from source: `python main.py`
+
+Open your browser at **`http://localhost:8000`** and start chatting.
+
+---
+
+## 🚀 Detailed Setup
+
+> **New to JARVIS?** Follow the setup guide first → **[HowToRun.md](HowToRun.md)**
+
+```bash
+# 1. Install from PyPI (recommended)
+pip install jarvise
+
+# Or clone and install from source
+git clone https://github.com/your-username/JARVISE.git && cd JARVISE
+pip install -e .
+
+# 2. Install dependencies (source / dev only)
+pip install -r requirements.txt
+
+# 3. Configure your environment
+cp .env.example .env
+
+# 4. Launch JARVIS
+python main.py
+```
+
+---
+
+## 🖼️ Preview
+
+<div align="center">
+
+**Startup — hardware detection & boot sequence**
+
+![JARVIS startup terminal showing ASCII logo, boot messages and hardware detection](Image\ss.png)
+
+
+*JARVIS boots in under a second, detects your hardware, initializes the logger, and serves the UI — all locally.*
+
+</div>
+
+---
+
+## ✨ Features
+
+<table>
+<tr>
+<td width="50%">
+
+### 🤖 Intelligent Chat
+Conversational AI powered by a **ReAct agent loop** — reasons step by step, uses tools, and responds with context awareness. No hallucinated shortcuts; it thinks before it speaks.
+
+### 🧠 Persistent Memory
+Remembers you across sessions. **ChromaDB** stores vector embeddings of your conversations, while `MEMORY.md` holds distilled facts — names, preferences, and key context.
+
+### 🎤 Voice Interface
+Speak naturally. **Faster-Whisper** transcribes your voice locally, and **Kokoro TTS** reads responses back. Fully offline — no API keys, no latency from the cloud.
+
+</td>
+<td width="50%">
+
+### 🌐 Web UI
+A polished **React + TypeScript** interface served at `localhost:8000`. Chat, view memory, manage settings — all in your browser.
+
+### 💻 CLI Shell
+Power users can interact via a rich **terminal interface** — ideal for scripting, piping, or when you just prefer the keyboard.
+
+### 🔌 REST API
+JARVIS exposes a clean `/api/*` REST interface so you can build integrations, trigger automations, or connect your own tools.
+
+### 📊 System Monitoring
+Ask JARVIS "how's my CPU?" — the built-in `system_monitor` tool reports CPU, RAM, and GPU stats in real time.
+
+</td>
+</tr>
+</table>
+
+---
+
+## 🏗️ Architecture
+
+### System Overview
+
+```mermaid
+graph TB
+    subgraph "🖥️ Interfaces"
+        UI[Web UI<br/>localhost:8000]
+        CLI[CLI Shell<br/>jarvis shell]
+        API[REST API<br/>/api/*]
+    end
+
+    subgraph "⚙️ JARVIS Core"
+        Backend[FastAPI Backend]
+        Agent[ReAct Agent<br/>brain/]
+        Memory[ChromaDB<br/>memory/]
+        Voice[Voice Pipeline<br/>voice/]
+        Tools[Tool Registry<br/>tools/]
+    end
+
+    subgraph "🤖 AI Layer"
+        Ollama[Ollama<br/>localhost:11434]
+        LLM[Llama 3.2]
+    end
+
+    UI -->|WebSocket + HTTP| Backend
+    CLI -->|HTTP| Backend
+    API -->|HTTP| Backend
+
+    Backend --> Agent
+    Agent --> Memory
+    Agent --> Voice
+    Agent --> Tools
+    Agent <-->|inference| Ollama
+    Ollama --- LLM
+```
+
+### Request Lifecycle
+
+```mermaid
+flowchart LR
+    subgraph "📥 Input"
+        MIC[🎙️ Microphone]
+        TXT[⌨️ Text / CLI]
+        WEB[🌐 Web UI]
+    end
+
+    subgraph "🔄 Processing"
+        STT[Whisper STT]
+        AGENT[ReAct Agent]
+        LLM[Ollama LLM]
+    end
+
+    subgraph "💾 Memory"
+        VEC[ChromaDB<br/>Vector Store]
+        FILE[MEMORY.md<br/>Key Facts]
+    end
+
+    subgraph "📤 Output"
+        TTS[Kokoro TTS 🔊]
+        RESP[Text Response 📝]
+        UI2[Web UI Update 🌐]
+    end
+
+    MIC --> STT --> AGENT
+    TXT --> AGENT
+    WEB --> AGENT
+
+    AGENT <--> VEC
+    AGENT <--> FILE
+    AGENT <-->|reason + act| LLM
+
+    AGENT --> TTS
+    AGENT --> RESP
+    AGENT --> UI2
+```
+
+---
+
+## 📁 Project Structure
+
+```
+JARVIS/
+│
+├── 🖥️  backend/           # FastAPI server, WebSocket handlers, routes
+├── 🧠  brain/             # ReAct agent, LangChain chains, prompt templates
+├── 💾  memory/            # ChromaDB vector store + MEMORY.md fact file
+├── 🛠️  tools/             # Tool modules: browser, code_exec, system_monitor, etc.
+├── 🎤  voice/             # STT (Faster-Whisper) + TTS (Kokoro) pipeline
+├── 🌐  ui/                # React 18 + TypeScript + Vite frontend
+├── 💻  cli/               # Python CLI package (argparse-based)
+│
+├── 📖  Docs/              # Extended documentation
+├── 🧪  tests/             # Test suites and bug regression tests
+│
+├── main.py               # 🚀 Application entry point
+├── HowToRun.md           # 📋 Step-by-step setup guide
+├── .env                  # ⚙️  Configuration (API endpoints, model names, etc.)
+└── requirements.txt      # 📦 Python dependencies
+```
+
+---
+
+## 🛠️ Tech Stack
+
+| Layer | Technology | Purpose |
+|-------|-----------|---------|
+| **Backend** | [FastAPI](https://fastapi.tiangolo.com/) + Python 3.11+ | REST API, WebSocket, async server |
+| **AI Inference** | [Ollama](https://ollama.com) (Llama 3.2) | Local LLM — no cloud needed |
+| **Agent Framework** | [LangChain](https://langchain.com/) | ReAct agent loop, chain orchestration |
+| **Memory / RAG** | [ChromaDB](https://www.trychroma.com/) | Vector embeddings, semantic recall |
+| **Speech-to-Text** | [Faster-Whisper](https://github.com/SYSTRAN/faster-whisper) | Offline voice transcription |
+| **Text-to-Speech** | [Kokoro](https://github.com/remsky/Kokoro-FastAPI) | Offline neural TTS |
+| **Frontend** | React 18 + TypeScript + Vite | Snappy, modern web interface |
+| **CLI** | Python (argparse) | Terminal interface |
+
+---
+
+## ⚙️ Configuration
+
+JARVIS is configured via a `.env` file in the project root:
+
+```env
+# Ollama
+OLLAMA_BASE_URL=http://localhost:11434
+OLLAMA_MODEL=llama3.2
+
+# Server
+BACKEND_PORT=8000
+BACKEND_HOST=0.0.0.0
+
+# Memory
+CHROMA_PERSIST_DIR=./memory/chroma
+MEMORY_FILE=./memory/MEMORY.md
+
+# Voice (optional)
+VOICE_ENABLED=true
+WHISPER_MODEL=base
+```
+
+---
+
+## 🧑‍💻 Development
+
+### Running Modes
+
+```bash
+# Full app — backend + web UI
+python main.py
+
+# Backend API only (no UI)
+python -m backend.main
+
+# CLI shell
+python -m cli shell
+
+# CLI — single query
+python -m cli ask "What's the weather like today?"
+```
+
+### Running Tests
+
+```bash
+# Full test suite
+pytest tests/
+
+# Specific bug regression test
+PYTHONIOENCODING=utf-8 python tests/Bugs_Testing/B1Test.py
+
+# Verbose output
+pytest tests/ -v --tb=short
+```
+
+### Adding a New Tool
+
+1. Create a new module in `tools/your_tool.py`
+2. Implement the tool interface (see `tools/README.md`)
+3. Register it in `brain/tool_registry.py`
+4. The ReAct agent will automatically discover and use it
+
+---
+
+## 📖 Documentation
+
+| Document | Description |
+|----------|-------------|
+| [HowToRun.md](HowToRun.md) | Prerequisites, installation, and first-run walkthrough |
+| [Docs/](Docs/) | Architecture deep-dives, API reference, tool guides |
+
+---
+
+## 🗺️ Roadmap
+
+- [ ] Multi-model support (swap LLMs without restart)
+- [ ] Plugin system for third-party tools
+- [ ] Mobile-responsive web UI improvements
+- [ ] Long-term memory summarization
+- [ ] Wake-word detection for hands-free activation
+
+---
+
+## 🤝 Contributing
+
+Contributions are welcome! Please open an issue first to discuss what you'd like to change. For bug fixes, feel free to submit a PR directly.
+
+---
+
+## 📄 License
+
+MIT License — see [LICENSE](LICENSE) for full details.
+
+---
+
+<div align="center">
+
+**Built for privacy. Designed for speed. Made to be yours.**
+
+*🤖 JARVIS — Your Personal AI Assistant*
+
+</div>