distant-frames 0.2.0__tar.gz → 0.2.2__tar.gz

{distant_frames-0.2.0 → distant_frames-0.2.2}/.github/workflows/publish.yml

@@ -2,8 +2,8 @@ name: Publish to PyPI
 
 on:
   push:
-    tags:
-      - 'v*.*.*'
+    branches:
+      - main
 
 jobs:
   build-and-publish:

{distant_frames-0.2.0 → distant_frames-0.2.2}/PKG-INFO

@@ -1,10 +1,11 @@
 Metadata-Version: 2.4
 Name: distant-frames
-Version: 0.2.0
+Version: 0.2.2
 Summary: Smart video frame extraction tool
 Project-URL: Homepage, https://github.com/yubraaj11/distant-frames
 Project-URL: Repository, https://github.com/yubraaj11/distant-frames
 Project-URL: Issues, https://github.com/yubraaj11/distant-frames/issues
+Project-URL: ReleaseNotes, https://github.com/yubraaj11/distant-frames/blob/main/RELEASE_NOTES.md
 Author-email: Yubraj Sigdel <yubrajsigdel1@gmail.com>
 License: GPL-3.0-or-later
 License-File: LICENSE
@@ -21,6 +22,12 @@ Requires-Dist: opencv-python>=4.10.0
 Requires-Dist: typer>=0.9.0
 Description-Content-Type: text/markdown
 
+![PyPI - Version](https://img.shields.io/pypi/v/distant-frames)
+![PyPI - Status](https://img.shields.io/pypi/status/distant-frames)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/distant-frames)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/distant-frames)
+![GitHub License](https://img.shields.io/github/license/yubraaj11/distant-frames)
+
 # Distant Frames
 
 **Distant Frames** is a smart video frame extraction tool designed to capture distinct visual moments from video files. Instead of simply saving every Nth frame, it analyzes the visual similarity between consecutive potential frames and only saves those that are sufficiently different.
@@ -68,11 +75,12 @@ For development or to use the latest unreleased features:
 
 ## 💻 Usage
 
-### Basic Command
-Run the script by providing the path to your video file:
+### Command Line Interface
+
+Once installed, you can use the `distant-frames` command from anywhere:
 
 ```bash
-uv run distant_frames/cli.py path/to/your/video.mp4
+distant-frames path/to/video.mp4 -o path/to/output -t 0.75
 ```
 
 ### Options
@@ -80,24 +88,19 @@ uv run distant_frames/cli.py path/to/your/video.mp4
 | Argument | Description | Default |
 |----------|-------------|---------|
 | `video_path` | Path to the input video file (Required). | N/A |
-| `--output` | Directory to save the extracted frames. | `extracted_frames` |
-| `--threshold` | Similarity threshold (0.0 to 1.0). Frames with similarity **higher** than this value compared to the last saved frame will be **dropped**. | `0.65` |
+| `--output`, `-o` | Directory to save the extracted frames. | `extracted_frames` |
+| `--threshold`, `-t` | Defines the similarity score threshold (0.0 to 1.0) between frames. If the similarity score is **higher** than this value, the frame will be discarded. | `0.65` |
 
 ### Examples
 
 **Extract frames with default settings:**
 ```bash
-uv run distant_frames/cli.py my_vacation.mp4
-```
-
-**Save to a custom folder with a stricter similarity check (fewer frames):**
-```bash
-uv run distant_frames/cli.py my_vacation.mp4 --output best_shots --threshold 0.95
+distant-frames my_vacation.mp4
 ```
 
-**Save more frames (looser similarity check):**
+**Save to a custom folder with a stricter similarity check:**
 ```bash
-uv run distant_frames/cli.py my_vacation.mp4 --output all_shots --threshold 0.6
+distant-frames my_vacation.mp4 -o best_shots -t 0.95
 ```
 
 ## 🔍 How It Works

{distant_frames-0.2.0 → distant_frames-0.2.2}/README.md

@@ -1,3 +1,9 @@
+![PyPI - Version](https://img.shields.io/pypi/v/distant-frames)
+![PyPI - Status](https://img.shields.io/pypi/status/distant-frames)
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/distant-frames)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/distant-frames)
+![GitHub License](https://img.shields.io/github/license/yubraaj11/distant-frames)
+
 # Distant Frames
 
 **Distant Frames** is a smart video frame extraction tool designed to capture distinct visual moments from video files. Instead of simply saving every Nth frame, it analyzes the visual similarity between consecutive potential frames and only saves those that are sufficiently different.
@@ -45,11 +51,12 @@ For development or to use the latest unreleased features:
 
 ## 💻 Usage
 
-### Basic Command
-Run the script by providing the path to your video file:
+### Command Line Interface
+
+Once installed, you can use the `distant-frames` command from anywhere:
 
 ```bash
-uv run distant_frames/cli.py path/to/your/video.mp4
+distant-frames path/to/video.mp4 -o path/to/output -t 0.75
 ```
 
 ### Options
@@ -57,24 +64,19 @@ uv run distant_frames/cli.py path/to/your/video.mp4
 | Argument | Description | Default |
 |----------|-------------|---------|
 | `video_path` | Path to the input video file (Required). | N/A |
-| `--output` | Directory to save the extracted frames. | `extracted_frames` |
-| `--threshold` | Similarity threshold (0.0 to 1.0). Frames with similarity **higher** than this value compared to the last saved frame will be **dropped**. | `0.65` |
+| `--output`, `-o` | Directory to save the extracted frames. | `extracted_frames` |
+| `--threshold`, `-t` | Defines the similarity score threshold (0.0 to 1.0) between frames. If the similarity score is **higher** than this value, the frame will be discarded. | `0.65` |
 
 ### Examples
 
 **Extract frames with default settings:**
 ```bash
-uv run distant_frames/cli.py my_vacation.mp4
-```
-
-**Save to a custom folder with a stricter similarity check (fewer frames):**
-```bash
-uv run distant_frames/cli.py my_vacation.mp4 --output best_shots --threshold 0.95
+distant-frames my_vacation.mp4
 ```
 
-**Save more frames (looser similarity check):**
+**Save to a custom folder with a stricter similarity check:**
 ```bash
-uv run distant_frames/cli.py my_vacation.mp4 --output all_shots --threshold 0.6
+distant-frames my_vacation.mp4 -o best_shots -t 0.95
 ```
 
 ## 🔍 How It Works

{distant_frames-0.2.0 → distant_frames-0.2.2}/RELEASE_NOTES.md

@@ -1,6 +1,12 @@
 # Release Notes
 
-## Version 0.2.0 (Upcoming)
+## Version 0.2.1
+
+### Updated File Name
+
+- **Concise Filenames**: Extracted frames now use a shortened 8-character UUID (e.g., `_frame_a1b2c3d4.jpg`) instead of the full 32-character UUID. This ensures uniqueness while keeping filenames cleaner and easier to manage.
+
+## Version 0.2.0 
 
 ### 🎨 Enhanced CLI Interface
 

{distant_frames-0.2.0 → distant_frames-0.2.2}/distant_frames/core.py

@@ -1,5 +1,7 @@
 import cv2
 import os
+from pathlib import Path
+import uuid
 
 def calculate_similarity(frame1, frame2):
     """Calculates similarity between two frames using Histogram Correlation.
@@ -62,7 +64,8 @@ def extract_frames(video_path, output_folder, threshold=0.65):
     if not os.path.exists(output_folder):
         os.makedirs(output_folder)
 
-    cap = cv2.VideoCapture(video_path)
+    video_file_name = Path(video_path).stem
+    cap = cv2.VideoCapture(str(video_path))
     if not cap.isOpened():
         print("Error: Could not open video.")
         return
@@ -129,7 +132,7 @@ def extract_frames(video_path, output_folder, threshold=0.65):
                 skip_reference_timestamp = last_saved_timestamp
 
         if should_save:
-            output_filename = os.path.join(output_folder, f"frame_{timestamp:.2f}.jpg")
+            output_filename = os.path.join(output_folder, f"{video_file_name}_frame_{uuid.uuid4().hex[:8]}.jpg")
             cv2.imwrite(output_filename, frame)
             
             # Update last saved frame

{distant_frames-0.2.0 → distant_frames-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "distant-frames"
-version = "0.2.0"
+version = "0.2.2"
 description = "Smart video frame extraction tool"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -27,6 +27,7 @@ dependencies = [
 Homepage = "https://github.com/yubraaj11/distant-frames"
 Repository = "https://github.com/yubraaj11/distant-frames"
 Issues = "https://github.com/yubraaj11/distant-frames/issues"
+ReleaseNotes = "https://github.com/yubraaj11/distant-frames/blob/main/RELEASE_NOTES.md"
 
 [project.scripts]
 distant-frames = "distant_frames.cli:app"

{distant_frames-0.2.0 → distant_frames-0.2.2}/uv.lock

@@ -25,7 +25,7 @@ wheels = [
 
 [[package]]
 name = "distant-frames"
-version = "0.2.0"
+version = "0.2.2"
 source = { editable = "." }
 dependencies = [
     { name = "opencv-python" },