KaraTube

KaraTube is a YouTube search application that allows you to control the playback of YouTube videos from an other window.

Table of Contents

• Installation
• Usage
• Developer Instructions
• Building the Application
• License

Installation

Clone the repository:

git clone https://github.com/yourusername/KaraTube.git
cd KaraTube

Install the required dependencies:

Using pip:

pip install -r requirements.txt

Using uv (faster):

uv sync

Using PDM:

pdm sync

Usage

1. Set up your YouTube API token (see Developer Instructions)
2. Run the application:

Using Python directly:

python server.py

Using uv:

uv run karatube

Using PDM:

pdm run karatube

3. Go to http://localhost:8080 in your web browser.

Developer Instructions

Setting Up YouTube API

1. Go to the Google Developers Console
2. Create a new project
3. Enable the YouTube Data API v3
4. Create credentials (API Key)
5. Create a .env file in the root directory of the project
6. Add your YouTube API token to the .env file:

YOUTUBE_API_KEY=your_api_key_here

Development Setup

Make sure you have all dependencies installed using your preferred package manager:

Using uv:

uv sync

Using PDM:

pdm sync

Using pip:

pip install -r requirements.txt

Run the development server:

python server.py

Navigate to the URL shown in the console (http://localhost:8080).

Building the Application

To create a standalone executable, you can use either PyInstaller directly or through your package manager:

Using PyInstaller directly:

pyinstaller server.spec

Using uv:

uv run pyinstaller server.spec

Using PDM:

pdm run pyinstaller server.spec

The executable will be available in the dist folder.

Configuration

This project is configured using pyproject.toml with support for multiple package managers:

• pip: Traditional Python package manager
• uv: Fast, Rust-based package manager
• PDM: Python Dependency Manager

All dependencies and development tools are defined in pyproject.toml.

License

MIT