Metadata-Version: 2.4
Name: whisper-scribe
Version: 4.0.1
Summary: Professional Knowledge Hub - Capture, organize, and discover knowledge from videos, PDFs, and documents
Project-URL: Homepage, https://pypi.org/project/whisper-scribe/
Author: Issam Alameh
Maintainer: Issam Alameh
License-Expression: MIT
License-File: LICENSE
Keywords: ai,audio,documents,insights,knowledge-base,openai,pdf,speech-to-text,transcription,video,whisper,youtube
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Multimedia :: Video
Requires-Python: >=3.9
Requires-Dist: fastapi>=0.109.0
Requires-Dist: httpx>=0.26.0
Requires-Dist: openai>=1.10.0
Requires-Dist: pydub>=0.25.1
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: reportlab>=4.0.0
Requires-Dist: uvicorn[standard]>=0.27.0
Requires-Dist: yt-dlp>=2024.3.10
Provides-Extra: all
Requires-Dist: dropbox>=11.0.0; extra == 'all'
Requires-Dist: google-api-python-client>=2.0.0; extra == 'all'
Requires-Dist: google-auth-oauthlib>=1.0.0; extra == 'all'
Provides-Extra: cloud
Requires-Dist: dropbox>=11.0.0; extra == 'cloud'
Requires-Dist: google-api-python-client>=2.0.0; extra == 'cloud'
Requires-Dist: google-auth-oauthlib>=1.0.0; extra == 'cloud'
Provides-Extra: dev
Requires-Dist: httpx>=0.26.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.24.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# Whisper Scribe

**Professional Knowledge Hub** - Capture, organize, and discover knowledge from videos, PDFs, and documents.

## What is Whisper Scribe?

Whisper Scribe transforms your content into actionable knowledge. Import YouTube videos, PDFs, and documents, then let AI extract insights, entities, and connections across your entire knowledge base.

## Features

### Content Import
- **YouTube Videos** - Transcribe and analyze any YouTube video
- **PDF Documents** - Extract and analyze PDF content (coming soon)
- **Web Pages** - Import articles and web content (coming soon)
- **Documents** - Import markdown, text, and other files (coming soon)

### AI-Powered Analysis
- **Insights Extraction** - Key takeaways, summaries, and actionable items
- **Entity Recognition** - People, organizations, technologies, products, places, concepts
- **Topic Mapping** - Automatic categorization and tagging
- **Cross-Content Connections** - Discover relationships across your knowledge base

### Knowledge Management
- **Unified Library** - All your content in one searchable place
- **Global Search** - Find anything across all your content
- **Custom Notes** - Add your own annotations and thoughts
- **Star & Organize** - Mark important items for quick access

### Modern Interface
- **Professional Design** - Clean, corporate SaaS-style UI
- **Sidebar Navigation** - Quick access to all features
- **Dark Mode** - Easy on the eyes
- **Responsive** - Works on desktop and mobile

## Installation

```bash
pip install whisper-scribe
```

### Prerequisites

- Python 3.9 or higher
- FFmpeg (required for video processing)
- API keys for AI services (Eden AI or OpenAI)

#### Installing FFmpeg

**macOS:**
```bash
brew install ffmpeg
```

**Ubuntu/Debian:**
```bash
sudo apt update && sudo apt install ffmpeg
```

**Windows:**
```bash
choco install ffmpeg
```

## Quick Start

1. **Start the server:**
   ```bash
   whisper-scribe
   ```

2. **Open your browser:**
   The app opens at http://localhost:8000

3. **Configure API keys:**
   Click Settings and enter your API keys

4. **Add content:**
   Click "Add New" and paste a YouTube URL to get started

## Command Line Options

```bash
whisper-scribe --help                 # Show all options
whisper-scribe --port 9000            # Use custom port
whisper-scribe --host 0.0.0.0         # Listen on all interfaces
whisper-scribe --no-browser           # Don't open browser automatically
```

## Configuration

Settings are stored in `~/.whisper-scribe/`:

- **API Keys** - Eden AI or OpenAI for AI analysis
- **Custom Prompts** - Customize extraction prompts
- **Output Directory** - Where files are saved

## API

REST API available at `/api`:

| Endpoint | Method | Description |
|----------|--------|-------------|
| `/api/content` | GET | List all content |
| `/api/content/{id}` | GET | Get content details |
| `/api/project/{id}/extract/insights` | POST | Extract insights |
| `/api/project/{id}/extract/entities` | POST | Extract entities |
| `/api/dashboard/stats` | GET | Dashboard statistics |
| `/api/search` | GET | Search content |

## License

MIT License - see [LICENSE](LICENSE) for details.

## Author

Created by Issam Alameh
