Merge pull request #6 from agfianf/fix/naming-package

Fix/naming package

Author: agfianf

.coveragerc

@@ -1,6 +1,6 @@
 
 [run]
-source = color_correction_asdfghjkl
+source = color_correction
 omit =
     tests/*
 

.github/workflows/publish.yml

@@ -1,4 +1,4 @@
-name: Publish Python Package to PyPI
+name: 📦 Publish Python Package to PyPI
 
 on:
   push:
@@ -9,26 +9,25 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - name: Clone repository
+      - name: 📥 Checkout repository
         uses: actions/checkout@v4
-      
-      - name: Install uv and set the python version
+
+      - name: 🐍 Install uv and set the python version
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.5.23"
           enable-cache: true
           cache-dependency-glob: "uv.lock"
           python-version: 3.12
 
-      - name: Extract version from Git tag
+      - name: 🏷️ Extract version from Git tag
         id: get_version
         run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV
-    
-      - name: Clear directory
+
+      - name: 🧹 Clear directory
         run: rm -rf dist
 
-      - name: Build package
+      - name: 🔨 Build package
         run: uv build
 
-      - name: Publish to PyPI
+      - name: 🚀 Publish to PyPI
         run: uv publish --token ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/tests.yml

@@ -1,12 +1,20 @@
-name: Test
+name: 🧪 Test
 
 on:
   pull_request:
     branches: [ main ]
+    paths-ignore:
+      - '**.md'
+      - 'docs/**'
+      - 'LICENSE'
+      - '.gitignore'
+      - '.pre-commit-config.yaml'
+      - 'mkdocs.yml'
+      - 'docs_requirements.txt'
 
 jobs:
   test:
-    name: Test
+    name: 🧪 Test
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
@@ -17,23 +25,23 @@ jobs:
           - "3.12"
 
     steps:
-      - uses: actions/checkout@v4
+      - name: 📥 Checkout repository
+        uses: actions/checkout@v4
 
-      - name: Install uv and set the python version
+      - name: 🐍 Install uv and set the python version
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.5.24"
           enable-cache: true
           cache-dependency-glob: "uv.lock"
           python-version: ${{ matrix.python-version }}
 
-      - name: Install the project
+      - name: 📦 Install the project
         run: uv sync --all-groups --no-group dev-model
 
-      - name: Checking linter and formatting
+      - name: 🔍 Checking linter and formatting
         run: uvx ruff check
 
-      - name: Run tests with Coverage
+      - name: 📊 Run tests with Coverage
         run: |
-          uv run pytest --cov-report=term-missing --cov=color_correction_asdfghjkl tests/
+          uv run pytest --cov-report=term-missing --cov=color_correction tests/
           uv run coverage report --fail-under=35

.gitignore

@@ -20,4 +20,4 @@ wheels/
 
 tmp/
 zzz/
-color_correction_asdfghjkl/asset/images/
+color_correction/asset/images/

Makefile

@@ -1,6 +1,6 @@
 yolo-export-onnx:
 	yolo export \
-	model=color_correction_asdfghjkl/asset/.model/yv8-det.pt \
+	model=color_correction/asset/.model/yv8-det.pt \
 	format=onnx \
 	device=mps \
 	simplify=True \

README.md

@@ -1,14 +1,24 @@
 
-# 🎨 Color Correction
+<div align="center">
 
-> **Note:** The "asdfghjkl" is just a placeholder due to some naming difficulties.
+# Color Correction
+
+<br>
+
+[![version](https://badge.fury.io/py/color-correction.svg)](https://badge.fury.io/py/color-correction)
+[![downloads](https://img.shields.io/pypi/dm/color-correction)](https://pypistats.org/packages/color-correction)
+[![python-version](https://img.shields.io/pypi/pyversions/color-correction)](https://badge.fury.io/py/color-correction)
+
+</div>
+
+> _Package formerly published as [`color-correction-asdfghjkl`](https://pypi.org/project/color-correction-asdfghjkl/) on PyPI. The name has been simplified for better accessibility and professional recognition._
 
 This package is designed to perform color correction on images using the Color Checker Classic 24 Patch card. It provides a robust solution for ensuring accurate color representation in your images.
 
 ## 📦 Installation
 
 ```bash
-pip install color-correction-asdfghjkl
+pip install color-correction
 ```
 
 ## 🏋️‍♀️ How it works
@@ -18,6 +28,8 @@ pip install color-correction-asdfghjkl
 ## ⚡ How to use
 
 ```python
+from color_correction import ColorCorrection
+
 # Step 1: Define the path to the input image
 image_path = "asset/images/cc-19.png"
 
@@ -49,31 +61,40 @@ corrected_image = color_corrector.predict(
 eval_result = color_corrector.calc_color_diff_patches()
 print(eval_result)
 ```
-- Output evaluation result:
-    ```json
-    {
-        "initial": {
-            "min": 2.254003059526461,
-            "max": 13.461066402633447,
-            "mean": 8.3072755187654,
-            "std": 3.123962754767539,
-        },
-        "corrected": {
-            "min": 0.30910031798755183,
-            "max": 5.422311999126372,
-            "mean": 1.4965478752947827,
-            "std": 1.2915738724958112,
-        },
-        "delta": {
-            "min": 1.9449027415389093,
-            "max": 8.038754403507074,
-            "mean": 6.810727643470616,
-            "std": 1.8323888822717276,
-        },
-    }
-    ```
-- Sample output debug image (polynomial degree=2):
-    ![Sample Output](assets/sample-output-debug.jpg)
+
+<details>
+<summary>Sample Evaluation Output</summary>
+
+```json
+{
+    "initial": {
+        "min": 2.254003059526461,
+        "max": 13.461066402633447,
+        "mean": 8.3072755187654,
+        "std": 3.123962754767539,
+    },
+    "corrected": {
+        "min": 0.30910031798755183,
+        "max": 5.422311999126372,
+        "mean": 1.4965478752947827,
+        "std": 1.2915738724958112,
+    },
+    "delta": {
+        "min": 1.9449027415389093,
+        "max": 8.038754403507074,
+        "mean": 6.810727643470616,
+        "std": 1.8323888822717276,
+    },
+}
+```
+</details>
+
+<details>
+<summary>Sample Output Debug Image</summary>
+
+![Sample Output](assets/sample-output-debug.jpg)
+
+</details>
 
 ## 📈 Benefits
 - **Consistency**: Ensure uniform color correction across multiple images.
@@ -89,6 +110,7 @@ print(eval_result)
 - [ ] Add more analysis and evaluation metrics (Still thinking...)
 
 <!-- write reference -->
+
 ## 📚 References
 - [Color Checker Classic 24 Patch Card](https://www.xrite.com/categories/calibration-profiling/colorchecker-classic)
 - [Color Correction Tool ML](https://github.com/collinswakholi/ML_ColorCorrection_tool/tree/Pip_package)