Metadata-Version: 2.4
Name: video_summary_a3b2c1
Version: 0.1.0
Summary: A pipeline for extracting summaries from videos using audio and visual context.
Author: A3B2C1
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: opencv-python
Requires-Dist: faster-whisper
Requires-Dist: langchain
Requires-Dist: langchain-openai
Requires-Dist: anyio
Requires-Dist: pydantic
Requires-Dist: python-dotenv
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# Video Summary

A Python package for extracting comprehensive summaries from videos using both audio (transcription) and visual (keyframe description) context.

## Features

- **Audio Transcription**: Uses `faster-whisper` for efficient and accurate transcription.
- **Visual Context**: Extracts keyframes from important segments and describes them using GPT-4o Vision.
- **Intelligent Synthesis**: Combines audio and visual descriptions into a final, coherent summary.
- **Modular Design**: Easy to integrate into any Python project.

## Installation

```bash
pip install video_summary
```

_Note: Requires `ffmpeg` to be installed on your system._

## Quick Start

```python
import asyncio
from video_summary import VideoSummaryPipeline

async def main():
    # Initialize the pipeline
    pipeline = VideoSummaryPipeline()

    # Run on a video file
    summary = await pipeline.run("path/to/your/video.mp4")

    print("Video Summary:")
    print(summary)

if __name__ == "__main__":
    asyncio.run(main())
```

## Configuration

The package relies on OpenAI or Azure OpenAI for LLM-based analysis. Set the following environment variables:

- `OPENAI_API_KEY`: Your OpenAI API key.
- _Optional (for Azure)_: `AZURE_OPENAI_API_KEY`, `AZURE_OPENAI_ENDPOINT`, `AZURE_DEPLOYMENT_NAME`.

## Requirements

- Python 3.9+
- ffmpeg
- OpenCV
- faster-whisper
- LangChain
