Skip to main content

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

Project description

Video Lens

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 video-lens

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/video-lens.git
cd video-lens

# 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
video-lens --help

# Check version
video-lens version

# Launch web interface (coming soon)
video-lens analyze

# Analyze a specific video (CLI mode - coming soon)
video-lens 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/video-lens.git
cd video-lens
uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"

# Verify setup
video-lens --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/video_lens/          # 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_analyser-0.5.17.tar.gz (228.3 kB view details)

Uploaded Source

Built Distribution

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

video_analyser-0.5.17-py3-none-any.whl (153.5 kB view details)

Uploaded Python 3

File details

Details for the file video_analyser-0.5.17.tar.gz.

File metadata

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

File hashes

Hashes for video_analyser-0.5.17.tar.gz
Algorithm Hash digest
SHA256 ecc05de3e29a0c6e4fafc63966ec94ce148268b3e388af144fdca35d04a6989c
MD5 85dc4b8e26fbdb59973460504c67fd16
BLAKE2b-256 fff8bd8f39bb3a675ffec498aabd6957437d04be22f5b74d9f7cd64ec2071468

See more details on using hashes here.

File details

Details for the file video_analyser-0.5.17-py3-none-any.whl.

File metadata

File hashes

Hashes for video_analyser-0.5.17-py3-none-any.whl
Algorithm Hash digest
SHA256 ca20c9151ae34ab852b5307d30405def25dadd768d9e5845b2b181cbbd0e0ea8
MD5 8142252763994b5f2e4d85a0a33785f4
BLAKE2b-256 10f368a958929f32b2971507732a20017e315dbe86180f1e6cc1505cfebab892

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