jupyter-whisper 0.1.3

AI-Powered Chat Interface for Jupyter Notebooks

JupyterWhisper - AI-Powered Chat Interface for Jupyter Notebooks

JupyterWhisper transforms your Jupyter notebook environment by seamlessly integrating Claude AI capabilities. This extension enables natural chat interactions, intelligent code execution, and voice command features to enhance your notebook workflow.

✨ Key Features

• 🤖 Native integration with Claude 3.5 Sonnet
• 🎯 Intelligent code execution and cell management
• 🔍 Advanced search capabilities powered by Perplexity AI
• 🎙️ Voice command support using OpenAI Whisper
• 📝 Context-aware text processing and formatting
• 💬 Comprehensive chat history management
• ⚡ Real-time streaming responses

🚀 Installation

pip install jupyter_whisper

📋 Requirements

• Python 3.7+
• JupyterLab 4.0+ (important: this extension is designed for JupyterLab, not classic Notebook)
• Jupyter Notebook 7.0+ (if using Notebook instead of Lab)
• Required API keys:
  • Anthropic API key (for Claude integration)
  • OpenAI API key (optional, for voice features)
  • Perplexity API key (for advanced search capabilities)

Installation Steps

1. Install JupyterLab if you haven't already:

pip install jupyterlab>=4.0.0

2. Install Jupyter Whisper:

pip install jupyter_whisper

3. Start JupyterLab:

jupyter lab

Important Note About Server Management

Jupyter Whisper runs a local FastAPI server (on port 5000) to handle features like audio transcription and text processing. The server is shared between notebooks for efficiency.

Important Notes:

• The server persists between notebook sessions
• Configuration changes (like API keys) only take effect when the server restarts
• You'll be notified if you're using an older server version

To manually refresh the server and apply new configurations:

from jupyter_whisper import refresh_jupyter_whisper
refresh_jupyter_whisper()  # Warning: affects all active notebooks

When to refresh:

• After updating API keys
• After upgrading the package
• If you encounter configuration issues

Note: Refreshing the server will impact all notebooks currently using it. You may need to restart kernels in affected notebooks.

JupyterLab Compatibility

JupyterWhisper is specifically designed and tested for JupyterLab 4.0+. While it may work in classic Jupyter Notebook (7.0+), we recommend using JupyterLab for the best experience and full feature support.

Key compatibility notes:

• Voice features require a modern browser
• WebSocket support is required for real-time streaming
• Some features may require JupyterLab extensions to be enabled
• Port 5000 must be available for the local server

🏁 Quick Start

1. Configure API Keys

The easiest way to set up your API keys is using the built-in configuration tool:

from jupyter_whisper import setup_jupyter_whisper
setup_jupyter_whisper()

This will:

• Guide you through entering your API keys
• Securely store them in ~/.jupyter_whisper/config.json
• Make them available for all future sessions

Alternative configuration methods:

Environment Variables (Linux/MacOS)

# Add to ~/.bashrc or ~/.zshrc
echo 'export ANTHROPIC_API_KEY="your-key-here"' >> ~/.bashrc
echo 'export OPENAI_API_KEY="your-key-here"' >> ~/.bashrc  # Optional for voice features
echo 'export PERPLEXITY_API_KEY="your-key-here"' >> ~/.bashrc  # For search features
source ~/.bashrc

Environment Variables (Windows)

# Run in PowerShell as administrator
[Environment]::SetEnvironmentVariable("ANTHROPIC_API_KEY", "your-key-here", "User")
[Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "your-key-here", "User")
[Environment]::SetEnvironmentVariable("PERPLEXITY_API_KEY", "your-key-here", "User")

Direct Python Configuration

import os

# Set environment variables programmatically
os.environ["ANTHROPIC_API_KEY"] = "your-key-here"
os.environ["OPENAI_API_KEY"] = "your-key-here"      # Optional for voice
os.environ["PERPLEXITY_API_KEY"] = "your-key-here"  # For search

2. Import and Use

import jupyter_whisper as jw

💡 Usage

Basic Chat

Interact with the AI using the %%user magic command:

%%user
How do I read a CSV file using pandas?

Online Search

Access web information directly within your notebook:

style = "Be precise and concise"
question = "What's new in Python 3.12?"
search_online(style, question)

Voice Commands

Leverage voice input capabilities:

• Control recording with keyboard shortcuts
• Automatic speech-to-text conversion
• Seamless chat interface integration

History Management

Access your conversation history:

hist()  # Display formatted chat history

🛠️ Advanced Features

Magic Commands

• %%user [index] - Initiate a user message
• %%assistant [index] - Include assistant response
• Multi-language support (Python, R, SQL, etc.)

Smart Processing

• Automatic code detection and execution
• Dynamic cell type conversion
• Live markdown rendering
• Syntax highlighting support

🔧 Development

Setup Development Environment

git clone https://github.com/yourusername/jupyter_whisper.git
cd jupyter_whisper
pip install -e ".[dev]"

Running Tests

python -m pytest tests/

🤝 Contributing

We welcome contributions! Please submit your Pull Requests.

📄 License

MIT License - see LICENSE for details

🙏 Credits

Powered by:

• Claude by Anthropic
• OpenAI Whisper
• Perplexity AI

---

Made with ❤️ by Maxime

Note: This project is independent and not affiliated with Anthropic, OpenAI, or Perplexity AI.