Skip to main content

Video analysis lens for the modular assessment platform - extracts frames, transcripts, and quality metrics

Project description

DeepBrief

PyPI version Python 3.11+ License: MIT

A video analysis application that helps students, educators, and professionals analyze presentations by combining speech transcription, visual analysis, and AI-powered feedback.

Status: Phase 1 MVP in development. Core infrastructure complete, video processing pipeline in progress.

Features

  • Video Processing: Support for MP4, MOV, AVI, and WebM formats
  • Speech Analysis: Automatic transcription with speaking rate and filler word detection
  • Visual Analysis: Scene detection with frame captioning and quality assessment
  • AI Feedback: Actionable insights and recommendations for improvement
  • Professional Reports: Interactive HTML and structured JSON outputs

Installation

Prerequisites

  • Python 3.11 or higher
  • ffmpeg (for video processing)

Option 1: Install from PyPI (recommended for users)

pip install deep-brief

Option 2: Install from source (for development)

# Install uv (fast Python package manager)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Clone the repository
git clone https://github.com/michael-borck/deep-brief.git
cd deep-brief

# Create virtual environment and install
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
uv pip install -e ".[dev]"

Installing ffmpeg

macOS:

brew install ffmpeg

Ubuntu/Debian:

sudo apt update && sudo apt install ffmpeg

Windows: Download from https://ffmpeg.org/download.html

Quick Start

# Show available commands
deep-brief --help

# Check version
deep-brief version

# Launch web interface (coming soon)
deep-brief analyze

# Analyze a specific video (CLI mode - coming soon)
deep-brief analyze video.mp4 --output ./reports

Current Status: The CLI framework is complete. Video processing features are in active development.

Development

This project uses modern Python tooling and follows strict quality standards:

  • uv for fast package management
  • ruff for formatting and linting
  • basedpyright for strict type checking
  • pytest for testing with coverage
  • pyproject.toml for all configuration (no setup.py)

Development Setup

# Clone and setup
git clone https://github.com/michael-borck/deep-brief.git
cd deep-brief
uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"

# Verify setup
deep-brief --help
pytest -v

Code Quality Standards

# Format code
ruff format .

# Lint code  
ruff check .

# Type checking (strict mode)
basedpyright

# Run tests with coverage
pytest -v

# Run all quality checks
ruff format . && ruff check . && basedpyright && pytest -v

Project Structure

src/deep_brief/          # Main package
├── core/                # Video processing pipeline
├── analysis/            # Speech and visual analysis  
├── reports/             # Report generation
├── interface/           # Gradio web interface
└── utils/               # Configuration and utilities

tests/                   # Test suite (mirrors src structure)
docs/                    # Documentation and specs
tasks/                   # Development task tracking
config/                  # Configuration files

Current Development Phase

  • Phase 0: Project setup, packaging, PyPI publication
  • 🚧 Phase 1: Core video processing pipeline (in progress)
  • 📋 Phase 2: Enhanced analysis features
  • 📋 Phase 3: Advanced AI features

See tasks/tasks-prd-phase1-mvp.md for detailed task tracking.

Links

License

MIT License - see LICENSE file for details.

Contributing

Contributions are welcome! Please read the development guidelines in CLAUDE.md for our coding standards and toolchain requirements.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

video_lens-0.5.8.tar.gz (221.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

video_lens-0.5.8-py3-none-any.whl (149.5 kB view details)

Uploaded Python 3

File details

Details for the file video_lens-0.5.8.tar.gz.

File metadata

  • Download URL: video_lens-0.5.8.tar.gz
  • Upload date:
  • Size: 221.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for video_lens-0.5.8.tar.gz
Algorithm Hash digest
SHA256 f9786474be7fc44b1acfd86ec1b4ef1dfbea73f00fd396137f456eadbf6a40e8
MD5 0d9bd42a1f6da3398b4bb2166060383f
BLAKE2b-256 b0ad9c380fdfc3b0ec8ae9f1feeb612c01c6124f60d9c9fe9dcecf82a9ecef68

See more details on using hashes here.

File details

Details for the file video_lens-0.5.8-py3-none-any.whl.

File metadata

  • Download URL: video_lens-0.5.8-py3-none-any.whl
  • Upload date:
  • Size: 149.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.0

File hashes

Hashes for video_lens-0.5.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a1c8bfd20c08521b88f54175ebbd145f63ad6e0f10ba7552416b56eb0aeae053
MD5 cc038e5945a3a3042f4c92e4d25efed7
BLAKE2b-256 7770a709945db638d23a1ebd08b98efc33bb2f4d50228232118c691cb16746d4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page