feat: restructure code (#30)

Author: Wazzabeee

README.md

@@ -64,11 +64,11 @@ usage: movie-barcodes [-h] -i INPUT_VIDEO_PATH [-d [DESTINATION_PATH]] [-t {hori
 # Examples
 ## Sequential Processing
 ```python
-python -m src.main -i "path/to/video" --width 200 -w 1
+python -m movie_barcodes -i "path/to/video" --width 200 -w 1
 ```
 ## Parallel Processing
 ```python
-python -m src.main -i "path/to/video" --width 200 -w 8
+python -m movie_barcodes -i "path/to/video" --width 200 -w 8
 ```
 
 # Development Setup
@@ -94,7 +94,7 @@ $ uv pip install pytest pytest-cov
 $ uv run pytest tests/
 
 # Run package locally
-$ uv run python -m src.main -i "path_to_video.mp4"
+$ uv run python -m movie_barcodes -i "path_to_video.mp4"
 ```
 
 # Todo

pyproject.toml

@@ -45,7 +45,14 @@ Homepage = "https://github.com/Wazzabeee/movie-barcodes"
 Repository = "https://github.com/Wazzabeee/movie-barcodes"
 
 [project.scripts]
-movie-barcodes = "src.main:main"
+movie-barcodes = "movie_barcodes.cli:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
 
 [tool.setuptools_scm]
 version_scheme = "guess-next-dev"

src/movie_barcodes/__init__.py

@@ -0,0 +1,20 @@
+"""Public API for movie_barcodes.
+
+This package provides CLI and library functions to generate movie color barcodes.
+"""
+
+from . import barcode_generation as barcode
+from . import barcode_generation as barcode_generation
+from . import color_extraction
+from . import video_processing
+from .cli import main as main
+from . import utility
+
+__all__ = [
+    "barcode",
+    "barcode_generation",
+    "color_extraction",
+    "video_processing",
+    "utility",
+    "main",
+]

src/movie_barcodes/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    main()

src/barcode_generation.py src/movie_barcodes/barcode_generation.pysrc/barcode_generation.py renamed to src/movie_barcodes/barcode_generation.py

@@ -30,14 +30,14 @@ def get_dominant_color_kmeans(frame: np.ndarray, k: int = 3) -> np.ndarray:
     Gets the dominant color of a frame using KMeans clustering.
 
     :param np.ndarray frame: The frame as a NumPy array.
-    :param int k: Number of clusters for KMeans algorithm. Defaults to 1.
+    :param int k: Number of clusters for KMeans algorithm. Defaults to 3.
     :return: Dominant color as a NumPy array.
     """
     # Reshape the frame to be a list of pixels
     pixels = frame.reshape(-1, 3)
 
     # Apply KMeans clustering
-    kmeans = KMeans(n_clusters=k, n_init=10)
+    kmeans = KMeans(n_clusters=k, n_init=10, random_state=0)
     kmeans.fit(pixels)
 
     # Get the RGB values of the cluster centers

src/main.py src/movie_barcodes/cli.pysrc/main.py renamed to src/movie_barcodes/cli.py

@@ -57,19 +57,13 @@ def validate_args(args: argparse.Namespace, frame_count: int, MAX_PROCESSES: int
         if args.width <= 0:
             raise ValueError("Width must be greater than 0.")
         if args.width > frame_count:
-            raise ValueError(
-                f"Specified width ({args.width}) cannot be greater than the number of frames ({frame_count}) in the "
-                f"video."
-            )
+            raise ValueError("Width must be less than or equal to the number of frames.")
 
     if args.height is not None:
         if args.height <= 0:
             raise ValueError("Height must be greater than 0.")
         if args.height > frame_count:
-            raise ValueError(
-                f"Specified height ({args.height}) cannot be greater than the number of frames ({frame_count}) in the "
-                f"video."
-            )
+            raise ValueError("Height must be less than or equal to the number of frames.")
 
     if frame_count < MIN_FRAME_COUNT:
         raise ValueError(f"The video must have at least {MIN_FRAME_COUNT} frames.")
@@ -142,7 +136,8 @@ def save_barcode_image(barcode: np.ndarray, base_name: str, args: argparse.Names
     :param str method: The method used for color extraction.
     """
     current_dir = path.dirname(path.abspath(__file__))
-    project_root = path.dirname(current_dir)  # Go up one directory to get to the project root
+    # Go up two directories to reach the repository root (…/src/movie_barcodes -> …/src -> repo root)
+    project_root = path.dirname(path.dirname(current_dir))
     # If destination_path isn't specified, construct one based on the video's name
     if not args.destination_path:
         barcode_dir = path.join(project_root, "barcodes")
@@ -159,9 +154,10 @@ def save_barcode_image(barcode: np.ndarray, base_name: str, args: argparse.Names
 
         destination_path = path.join(barcode_dir, destination_name)
     else:
-        # In case a destination_path is provided, consider appending the method
-        # or managing as per your requirement
-        destination_path = path.join(project_root, args.destination_path)
+        # Use absolute path as-is; if relative, make it relative to project root
+        destination_path = args.destination_path
+        if not path.isabs(destination_path):
+            destination_path = path.join(project_root, destination_path)
 
     if barcode.shape[2] == 4:  # If the image has an alpha channel (RGBA)
         image = Image.fromarray(barcode, "RGBA")

src/color_extraction.py src/movie_barcodes/color_extraction.pysrc/color_extraction.py renamed to src/movie_barcodes/color_extraction.py

@@ -0,0 +1,10 @@
+import os
+import sys
+
+
+# Ensure the src/ directory is on sys.path so 'movie_barcodes' is importable in tests
+_THIS_DIR = os.path.dirname(__file__)
+_REPO_ROOT = os.path.abspath(os.path.join(_THIS_DIR, ".."))
+_SRC_DIR = os.path.join(_REPO_ROOT, "src")
+if _SRC_DIR not in sys.path:
+    sys.path.insert(0, _SRC_DIR)