Jarvis AI Assistant

Python Version License: MIT PRs Welcome Stars Forks CodeQL

A production-ready voice assistant with facial recognition authentication, built on modern Python architecture and web technologies.

Features • Installation • Usage • Documentation • Contributing

Overview

Core Capabilities

Python OpenCV SQLite NumPy

HTML5 CSS3 JavaScript Bootstrap

Hugging Face TensorFlow

Git VS Code Docker

Prerequisites

Installation

Step 1: Clone Repository

git clone https://github.com/vannu07/jarvis.git
cd jarvis

Step 2: Setup Virtual Environment

Step 3: Install Dependencies

pip install -r requirements.txt

Step 4: Configure Environment

# API Keys
HUGGINGFACE_TOKEN=your_token_here
PORCUPINE_ACCESS_KEY=your_key_here
NEWSAPI_KEY=your_newsapi_key
OPENWEATHERMAP_API_KEY=your_openweathermap_api_key
# Voice Settings
TTS_RATE=150
TTS_VOICE=0
# Recognition Settings
FACE_CONFIDENCE_THRESHOLD=50
HOTWORD_SENSITIVITY=0.5

Step 5: Train Face Recognition (Optional)

python backend/auth/trainer.py

python run.py

Jarvis will launch at http://localhost:8000

Usage

Voice Commands

Keyboard Shortcuts

Wake Words

Weather Feature

Setup OpenWeatherMap API

Weather Commands

Jarvis, weather in London
Jarvis, what's the weather in Tokyo
Jarvis, weather for New York

Jarvis, forecast for Paris
Jarvis, forecast in Mumbai
Jarvis, weather forecast for Berlin

Features

Standalone Usage

python weather_fetcher.py

Testing

python -m testing.weather_test

Project Structure

jarvis/
├── backend/
│ ├── auth/
│ │ ├── haarcascade_frontalface_default.xml
│ │ ├── recognize.py # Face recognition
│ │ ├── trainer.py # Model training
│ │ └── trainer/ # Trained models
│ ├── command.py # Command parser
│ ├── config.py # Configuration
│ ├── db.py # Database ops
│ ├── feature.py # Feature handlers
│ └── helper.py # Utilities
├── frontend/
│ ├── assets/
│ │ ├── audio/ # Sound files
│ │ ├── img/ # Images & icons
│ │ └── vendor/ # Third-party libs
│ ├── index.html # Main UI
│ ├── style.css # Styles
│ ├── script.js # Particle effects
│ ├── main.js # Core logic
│ └── controller.js # Event handlers
├── main.py # Entry point
├── run.py # Launcher
├── weather_fetcher.py # Weather module
├── requirements.txt # Dependencies
├── testing/
│ ├── weather_test.py # Weather tests
│ └── text_test.py # Command parser tests
└── jarvis.db # SQLite DB

Development

Adding Custom Commands

def parse_command(query: str) -> dict:
 if "my custom action" in query.lower():
 return {
 "action": "custom_action",
 "params": {"param1": "value1"}
 }

def handle_custom_action(params: dict) -> str:
 result = do_something(params)
 return f"Action completed: {result}"

COMMAND_HANDLERS = {
 "custom_action": handle_custom_action,
 # ... other handlers
}

Database Schema

-- Contacts Table
CREATE TABLE contacts (
 id INTEGER PRIMARY KEY AUTOINCREMENT,
 name TEXT NOT NULL,
 phone TEXT,
 whatsapp TEXT,
 email TEXT,
 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
-- Applications Table
CREATE TABLE apps (
 id INTEGER PRIMARY KEY AUTOINCREMENT,
 name TEXT NOT NULL,
 path TEXT NOT NULL,
 keywords TEXT,
 icon TEXT,
 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);
-- Web Commands Table
CREATE TABLE web_commands (
 id INTEGER PRIMARY KEY AUTOINCREMENT,
 command TEXT NOT NULL,
 url TEXT NOT NULL,
 description TEXT,
 created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
);

Testing

# Run all tests
pytest tests/ -v
# Run with coverage
pytest --cov=backend --cov-report=html tests/
# Run specific test file
pytest tests/test_command.py -v
# Linting
black backend/ frontend/ --check
flake8 backend/
pylint backend/

Docker Deployment

FROM python:3.10-slim
WORKDIR /app
# Install system dependencies
RUN apt-get update && apt-get install -y \
 portaudio19-dev \
 python3-pyaudio \
 libopencv-dev \
 && rm -rf /var/lib/apt/lists/*
# Copy and install Python dependencies
COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt
# Copy application
COPY . .
EXPOSE 8000
CMD ["python", "run.py"]

docker build -t jarvis-ai .
docker run -p 8000:8000 -v $(pwd)/jarvis.db:/app/jarvis.db jarvis-ai

Benchmarked on Windows 11, Intel i5-10400, 16GB RAM

Troubleshooting

PyAudio Installation Fails

pip install pipwin
pipwin install pyaudio

sudo apt-get install portaudio19-dev python3-pyaudio
pip install pyaudio

brew install portaudio
pip install pyaudio

Face Recognition Not Working

Voice Commands Unresponsive

Module Import Errors

pip install --upgrade --force-reinstall -r requirements.txt

Enable Debug Mode

# Windows
set JARVIS_DEBUG=1
python run.py
# Linux/Mac
export JARVIS_DEBUG=1
python run.py

We welcome contributions from the community

Contribution Guidelines

Commit Convention

type(scope): subject
[optional body]
[optional footer]

git commit -m "feat(voice): add support for multiple languages"
git commit -m "fix(face): improve recognition accuracy in low light"
git commit -m "docs(readme): update installation instructions"

Code Style

Roadmap

This project is licensed under the MIT License

License: MIT

See LICENSE file for details

Special thanks to these amazing projects:

OpenCV Google Hugging Face Bootstrap

Project Link: github.com/vannu07/jarvis

For issues, questions, or feature requests, please open an issue on GitHub

If you find this project helpful, please consider starring the repository

Star History Chart

Made with Python

Copyright 2025