Skip to content

rui-costa/open-clip

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Open-Clip

An automated video clipping and processing engine.

License: AGPL v3

Overview

Open-Clip is an automated video processing system designed to manage and clip video projects efficiently. It provides a full-stack solution featuring a Python based backend for processing and a web based frontend for project management.

Why This Exists

Managing and clipping long form video content is tedious and time consuming. Open-Clip streamlines this workflow by providing a central dashboard to organize projects, manage metadata, and handle the heavy lifting of video processing.

Quick Start

Ensure you have Docker and Docker Compose installed on your machine.

  1. Clone the repository:

    git clone <your-repository-url>
    cd open-clip
  2. Create an .env file from the example:

    cp .env.example .env
  3. Start the development environment:

    docker-compose up --build
  4. Learn how to use the application in our User Guide →

  5. Access the services:

Features

  • Project Management: Organize, view, and track your video projects.
  • Automated Clipping: Efficient video splitting and processing.
  • Metadata Management: Track project details via JSON metadata.
  • Containerized Workflow: Simple setup using Docker.

Project Structure

  • /backend: Python API and processing logic.
  • /frontend: TypeScript and React web interface.
  • /projects: Local storage for project data and media.

Development and Testing

Backend

Navigate to the backend directory. The project uses pytest for testing.

# Example
./.venv/bin/pytest tests/unit/

Frontend

Navigate to the frontend directory. The project uses playwright for end to end testing and npm for scripts.

npm install
npm run test

Contributing

We welcome contributions. Please check CONTRIBUTING.md if available, or submit a pull request with a detailed description of your changes.

Security

Please report any security vulnerabilities by opening a private GitHub Security Advisory in this repository.

License

AGPL v3 © The Open-Clip Authors

Star History

Star History Chart

About

Open-Clip is an automated clipper that create short clips from long format video. Can be executed via CLI or UI.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors