Metadata-Version: 2.1
Name: vidtoolbox
Version: 0.1.3
Summary: A Python toolbox for managing and processing videos efficiently.
Home-page: https://github.com/nkliu1772/vidtoolbox
Author: nkliu1772
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Multimedia :: Video
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# **VidToolbox**

## 📌 Introduction
**VidToolbox** is a video processing tool that supports:
- 🔍 **Retrieving video information** (resolution, duration, file size)
- 📝 **Generating YouTube chapter timestamps** (`timestamps.txt`)
- 🎬 **Merging multiple video files**
- 🏷️ **Automatically naming output files based on the folder name**

This tool works on **macOS** and **Linux**, utilizing `ffmpeg` for video processing.

---

## ⚡ Installation

### 1️⃣ **Install `ffmpeg`** (if not installed)
```bash
brew install ffmpeg  # macOS (Homebrew)
sudo apt install ffmpeg  # Ubuntu / Debian
```

### 2️⃣ **Install VidToolbox using `pipx` (Recommended)**
```bash
pipx install --force git+https://github.com/nkliu1772/vidtoolbox.git
```

If `pipx` is not installed, run:

```bash
# For macOS (using Homebrew)
brew install pipx
pipx ensurepath

# For other systems
python3 -m pip install --user pipx
python3 -m pipx ensurepath
```

---

## 🚀 Usage

### **1️⃣ Get Video Information**
```bash
vid-info /path/to/video_folder
```
🔹 Displays resolution, duration, and file size.

### **2️⃣ Generate YouTube Chapter Timestamps**
```bash
vid-timestamps /path/to/video_folder
```
🔹 Creates `timestamps.txt` and prompts user for confirmation.

### **3️⃣ Merge Videos**
```bash
vid-merge /path/to/video_folder
```
🔹 Confirms timestamps before merging videos.

🔹 The default output file name is **the folder name**, but you can specify an output file with `-o`:
```bash
vid-merge /path/to/video_folder -o output.mp4
```

---

## 📌 TODO
- [ ] Add `--output` parameter to allow specifying the output directory
- [ ] Add an option to merge videos in all subdirectories automatically.
- [ ] Add `bumpversion` for automatic versioning and changelog management
- [ ] Add en/zh language setting
- [ ] Add `.srt` merge support (auto shift)
- [ ] Add Windows support
- [ ] Improve CLI usability
- [ ] Add GUI for better user experience

---

## 🛠️ License
This project is licensed under the MIT License.
