Spleech

Spleech (SpeechLeech) is a Flask-based web application that extracts and returns YouTube video transcripts using the YouTube Transcript API. It is designed to be hosted on Fly.io.

Features

• Extracts transcripts from YouTube videos using video IDs or URLs.
• Provides a clean and concatenated transcript text.
• Includes CLI and REST API endpoints for interaction.
• Custom request session headers for better compatibility.

Table of Contents

1. Requirements
2. Setup
3. Usage
   • API Endpoints
   • CLI Usage
4. Testing
5. Deployment

Requirements

• Python 3.8+
• Docker (for deployment)
• Fly.io CLI

Setup

1. Clone the repository:

   git clone <repository-url>
   cd spleech

2. Install dependencies:

   pip install -r requirements.txt

3. Set up Fly.io:

   • Run flyctl launch and follow the prompts.
   • Ensure the fly.toml file is correctly configured.

4. Run the application locally:

   python app.py

Usage

API Endpoints

1. Status Endpoint

• URL: /
• Method: GET
• Response:

  {
      "status": "App is running",
      "app_name": "spleech-rough-wildflower-5228"
  }

2. Health Check

• URL: /health
• Method: GET
• Response:

  {
      "status": "healthy"
  }

3. Transcript Endpoint

• URL: /transcript
• Method: POST
• Request Body:

  {
      "video_id": "<YouTube Video ID>"
  }

• Response:

  {
      "transcript": "<Transcript Text>"
  }

CLI Usage

Run the application in CLI mode to fetch a YouTube video transcript directly:

python app.py cli <video_id>

Example:

python app.py cli dQw4w9WgXcQ

Testing

1. Run tests locally:

   ./run_test_locally.sh

2. Run tests in the deployment environment:

   ./run_test.sh

Deployment

1. Build the Docker image:

   docker build -t spleech .

2. Deploy the app using Fly.io:

   ./deploy.sh

3. Verify the app status:

   fly status

File Descriptions

• app.py: Core application logic.
• Dockerfile: Docker configuration for containerizing the app.
• fly.toml: Configuration for Fly.io deployment.
• cookies.txt: Placeholder for cookies (if required by YouTube API).
• deploy.sh: Script for deployment.
• run_test.sh: Script for testing in the deployment environment.
• run_test_locally.sh: Script for testing locally.
• startup.sh: Initialization script for app startup.
• test.py: Contains test cases for the app.

Contributing

Feel free to fork the repository and make contributions. Submit a pull request with a detailed explanation of the changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.

---

Happy transcripting with Spleech!