yt-study 0.1.1__tar.gz

yt_study-0.1.1/.env.example

@@ -0,0 +1,16 @@
+# Environment Variables Template
+# Copy this to .env and fill in your API keys
+
+# Required: At least one LLM API key (Gemini is the default provider)
+GEMINI_API_KEY=your_gemini_key_here
+
+# Optional: Other LLM Providers
+# OPENAI_API_KEY=your_openai_key_here
+# ANTHROPIC_API_KEY=your_anthropic_key_here
+# GROQ_API_KEY=your_groq_key_here
+# XAI_API_KEY=your_xai_key_here
+# MISTRAL_API_KEY=your_mistral_key_here
+
+# Custom API Endpoints (if using custom providers)
+# CUSTOM_API_BASE=https://your-custom-endpoint.com/v1
+# CUSTOM_API_KEY=your_custom_key_here

yt_study-0.1.1/.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+      with:
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: Set up Python ${{ matrix.python-version }}
+      run: uv python install ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        uv sync --all-extras --dev
+
+    - name: Run tests
+      run: |
+        uv run pytest

yt_study-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build-n-publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # For creating GitHub Release
+      id-token: write  # For PyPI OIDC (optional, using token for now)
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v2
+
+    - name: Set up Python
+      run: uv python install 3.10
+
+    - name: Build package
+      run: |
+        uv build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}
+
+    - name: Create GitHub Release
+      uses: softprops/action-gh-release@v1
+      if: startsWith(github.ref, 'refs/tags/')
+      with:
+        generate_release_notes: true

yt_study-0.1.1/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.env

yt_study-0.1.1/.python-version

@@ -0,0 +1 @@
+3.13

yt_study-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 yt-study contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

yt_study-0.1.1/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: yt-study
+Version: 0.1.1
+Summary: Convert YouTube videos into AI-powered study notes with chapter support
+Author-email: whoisjayd <email@example.com>
+License: MIT
+License-File: LICENSE
+Keywords: ai,education,llm,notes,study,transcript,youtube
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Education
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.10
+Requires-Dist: aiohttp>=3.11.11
+Requires-Dist: litellm>=1.81.1
+Requires-Dist: pytubefix>=10.3.6
+Requires-Dist: rich>=13.9.4
+Requires-Dist: tiktoken>=0.8.0
+Requires-Dist: typer>=0.21.1
+Requires-Dist: youtube-transcript-api>=1.2.3
+Description-Content-Type: text/markdown
+
+# 🎓 yt-study
+
+[![PyPI version](https://badge.fury.io/py/yt-study.svg)](https://badge.fury.io/py/yt-study)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![CI Status](https://github.com/whoisjayd/yt-study/actions/workflows/ci.yml/badge.svg)](https://github.com/whoisjayd/yt-study/actions)
+
+> **Convert YouTube videos and playlists into comprehensive, academic-grade study notes using AI.**
+
+`yt-study` is a powerful CLI tool that transforms educational video content into structured, high-quality study materials. It supports massive videos (10h+), playlists, and multiple languages, using state-of-the-art LLMs.
+
+---
+
+## ✨ Features
+
+- **🧠 Multi-Model Support**: Works with Gemini 1.5/2.0, GPT-4o, Claude 3.5, Groq, and more via LiteLLM.
+- **📚 Chapter-Aware**: Automatically detects chapters in long videos (>1hr) and creates separate, detailed notes for each.
+- **🧩 Smart Chunking**:  Robustly handles transcripts of any length (even 20k+ tokens) without losing context.
+- **🌍 Auto-Translation**: Processes videos in any language (e.g., Hindi, Spanish) and generates notes in **English**.
+- **💻 SQL & Code Preservation**: Specifically tuned to preserve code blocks, SQL schemas, and technical syntax.
+- **⚡ Async Pipeline**: Process playlists concurrently for maximum speed.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Installation
+
+```bash
+pip install yt-study
+```
+
+### 2. Setup (One-time)
+
+Run the interactive wizard to configure your preferred LLM and API keys:
+
+```bash
+yt-study setup
+```
+
+### 3. Generate Notes
+
+**Single Video:**
+```bash
+yt-study process "https://youtube.com/watch?v=VIDEO_ID"
+```
+
+**Entire Playlist:**
+```bash
+yt-study process "https://youtube.com/playlist?list=PLAYLIST_ID"
+```
+
+---
+
+## 🛠 CLI Reference
+
+**Primary Command:**
+`yt-study [COMMAND] [OPTIONS]`
+
+| Command | Description | Usage Example |
+| :--- | :--- | :--- |
+| **`process`** | Generate notes from URL | `yt-study process "URL"` |
+| **`setup`** | Configure API keys & model | `yt-study setup` |
+| **`config-path`** | Show config file location | `yt-study config-path` |
+| **`version`** | Show version info | `yt-study version` |
+
+### **`process` Options**
+
+| Option | Description |
+| :--- | :--- |
+| `--model <name>` / `-m` | Override default model (e.g. `gpt-4o`) |
+| `--language <code>` / `-l` | Preferred transcript language (default: `en`). Can be used multiple times. |
+| `--output <path>` / `-o` | Custom output directory |
+| `--help` | Show help message |
+
+**Example with options:**
+```bash
+yt-study process "URL" --model anthropic/claude-3-5-sonnet-20241022 --output ./my-course-notes
+```
+
+---
+
+## 📂 Output Structure
+
+Organized automatically for easy navigation.
+
+**📺 Single Video**
+```
+output/
+└── Video Title/
+    └── Video Title.md  # Comprehensive notes
+```
+
+**📖 Long Video (Chaptered)**
+```
+output/
+└── Complete DBMS Course/
+    ├── 01_Introduction.md
+    ├── 02_ER_Diagrams.md
+    └── 03_Normalization.md
+```
+
+**📑 Playlist**
+```
+output/
+└── Playlist Name/
+    ├── Video 1.md
+    ├── Video 2.md
+    └── Video 3.md
+```
+
+---
+
+## ⚙️ Configuration
+
+Config is stored in `~/.yt-study/config.env`.
+
+**Supported Providers:**
+- **Google Gemini** (Recommended for free tier)
+- **OpenAI**
+- **Anthropic**
+- **Groq**
+- **Mistral**
+- **xAI (Grok)**
+
+To re-run setup:
+```bash
+yt-study setup --force
+```
+
+---
+
+## 👨‍💻 Development
+
+Requirements: Python 3.10+
+
+```bash
+# Clone repo
+git clone https://github.com/whoisjayd/yt-study.git
+cd yt-study
+
+# Install dependencies (using uv is recommended)
+pip install uv
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run locally
+uv run yt-study --help
+```

yt_study-0.1.1/README.md

@@ -0,0 +1,151 @@
+# 🎓 yt-study
+
+[![PyPI version](https://badge.fury.io/py/yt-study.svg)](https://badge.fury.io/py/yt-study)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![CI Status](https://github.com/whoisjayd/yt-study/actions/workflows/ci.yml/badge.svg)](https://github.com/whoisjayd/yt-study/actions)
+
+> **Convert YouTube videos and playlists into comprehensive, academic-grade study notes using AI.**
+
+`yt-study` is a powerful CLI tool that transforms educational video content into structured, high-quality study materials. It supports massive videos (10h+), playlists, and multiple languages, using state-of-the-art LLMs.
+
+---
+
+## ✨ Features
+
+- **🧠 Multi-Model Support**: Works with Gemini 1.5/2.0, GPT-4o, Claude 3.5, Groq, and more via LiteLLM.
+- **📚 Chapter-Aware**: Automatically detects chapters in long videos (>1hr) and creates separate, detailed notes for each.
+- **🧩 Smart Chunking**:  Robustly handles transcripts of any length (even 20k+ tokens) without losing context.
+- **🌍 Auto-Translation**: Processes videos in any language (e.g., Hindi, Spanish) and generates notes in **English**.
+- **💻 SQL & Code Preservation**: Specifically tuned to preserve code blocks, SQL schemas, and technical syntax.
+- **⚡ Async Pipeline**: Process playlists concurrently for maximum speed.
+
+---
+
+## 🚀 Quick Start
+
+### 1. Installation
+
+```bash
+pip install yt-study
+```
+
+### 2. Setup (One-time)
+
+Run the interactive wizard to configure your preferred LLM and API keys:
+
+```bash
+yt-study setup
+```
+
+### 3. Generate Notes
+
+**Single Video:**
+```bash
+yt-study process "https://youtube.com/watch?v=VIDEO_ID"
+```
+
+**Entire Playlist:**
+```bash
+yt-study process "https://youtube.com/playlist?list=PLAYLIST_ID"
+```
+
+---
+
+## 🛠 CLI Reference
+
+**Primary Command:**
+`yt-study [COMMAND] [OPTIONS]`
+
+| Command | Description | Usage Example |
+| :--- | :--- | :--- |
+| **`process`** | Generate notes from URL | `yt-study process "URL"` |
+| **`setup`** | Configure API keys & model | `yt-study setup` |
+| **`config-path`** | Show config file location | `yt-study config-path` |
+| **`version`** | Show version info | `yt-study version` |
+
+### **`process` Options**
+
+| Option | Description |
+| :--- | :--- |
+| `--model <name>` / `-m` | Override default model (e.g. `gpt-4o`) |
+| `--language <code>` / `-l` | Preferred transcript language (default: `en`). Can be used multiple times. |
+| `--output <path>` / `-o` | Custom output directory |
+| `--help` | Show help message |
+
+**Example with options:**
+```bash
+yt-study process "URL" --model anthropic/claude-3-5-sonnet-20241022 --output ./my-course-notes
+```
+
+---
+
+## 📂 Output Structure
+
+Organized automatically for easy navigation.
+
+**📺 Single Video**
+```
+output/
+└── Video Title/
+    └── Video Title.md  # Comprehensive notes
+```
+
+**📖 Long Video (Chaptered)**
+```
+output/
+└── Complete DBMS Course/
+    ├── 01_Introduction.md
+    ├── 02_ER_Diagrams.md
+    └── 03_Normalization.md
+```
+
+**📑 Playlist**
+```
+output/
+└── Playlist Name/
+    ├── Video 1.md
+    ├── Video 2.md
+    └── Video 3.md
+```
+
+---
+
+## ⚙️ Configuration
+
+Config is stored in `~/.yt-study/config.env`.
+
+**Supported Providers:**
+- **Google Gemini** (Recommended for free tier)
+- **OpenAI**
+- **Anthropic**
+- **Groq**
+- **Mistral**
+- **xAI (Grok)**
+
+To re-run setup:
+```bash
+yt-study setup --force
+```
+
+---
+
+## 👨‍💻 Development
+
+Requirements: Python 3.10+
+
+```bash
+# Clone repo
+git clone https://github.com/whoisjayd/yt-study.git
+cd yt-study
+
+# Install dependencies (using uv is recommended)
+pip install uv
+uv sync
+
+# Run tests
+uv run pytest
+
+# Run locally
+uv run yt-study --help
+```

yt_study-0.1.1/pyproject.toml

@@ -0,0 +1,74 @@
+[project]
+name = "yt-study"
+version = "0.1.1"
+description = "Convert YouTube videos into AI-powered study notes with chapter support"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "whoisjayd", email = "email@example.com"}
+]
+keywords = ["youtube", "study", "notes", "ai", "llm", "education", "transcript"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Education",
+    "Intended Audience :: End Users/Desktop",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Education",
+    "Topic :: Multimedia :: Video",
+]
+dependencies = [
+    "youtube-transcript-api>=1.2.3",
+    "pytubefix>=10.3.6",
+    "litellm>=1.81.1",
+    "typer>=0.21.1",
+    "rich>=13.9.4",
+    "aiohttp>=3.11.11",
+    "tiktoken>=0.8.0",
+]
+
+[project.optional-dependencies]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.0",
+    "pytest-cov>=6.0.0",
+    "pytest-asyncio>=1.3.0",
+    "pytest-mock>=3.14.0",
+]
+
+[project.scripts]
+yt-study = "yt_study.cli:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+
+[tool.coverage.run]
+source = ["src/yt_study"]
+omit = ["*/tests/*", "*/__pycache__/*"]
+concurrency = ["thread", "gevent"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "async def",
+]

yt_study-0.1.1/src/yt_study/__init__.py

@@ -0,0 +1,3 @@
+"""YouTube Study Material Pipeline - Main package."""
+
+__version__ = "0.1.0"