gui: add pip/pipx/uvx support; fix docker in huggingface; fix ci

Author: songyz2019

.github/workflows/docker-build.yml

@@ -0,0 +1,28 @@
+name: Build Docker
+
+on:
+  workflow_dispatch:
+
+# jobs:
+#   build:
+#     runs-on: ubuntu-latest
+
+#     steps:
+#       - name: Checkout code
+#         uses: actions/checkout@v4
+
+#       - name: Set up Docker Buildx
+#         uses: docker/setup-buildx-action@v2
+
+#       - name: Log in to DockerHub
+#         uses: docker/login-action@v2
+#         with:
+#           username: ${{ secrets.DOCKER_USERNAME }}
+#           password: ${{ secrets.DOCKER_PASSWORD }}
+
+#       - name: Build and push Docker image
+#         uses: docker/build-push-action@v4
+#         with:
+#           context: ./gui/docker-compose
+#           push: true
+#           tags: ${{ secrets.DOCKER_USERNAME }}/hsi2rgb:latest

.github/workflows/uv-test.yml

@@ -20,7 +20,8 @@ jobs:
         python-version: "3.12"
     - name: astral-sh/setup-uv
       uses: astral-sh/[email protected]
-    - run: cd core
-    - run: uv sync
-    - run: uv build
-    - run: uv run tests/test1.py
+    - run: |
+        cd core
+        uv sync
+        uv build
+        uv run tests/test.py

README.md

@@ -7,7 +7,7 @@
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hsi2rgb.svg)](https://pypi.org/project/hsi2rgb)
 
 Easily convert a hyperspectral image to an RGB image. hsi2rgb is:
-1. A python package that supports numpy, torch and jax, with gamma correction, automatically convertions, XYZ and RGB colorspace suppots, etc.
+1. A python package that easily integrates with numpy, torch and jax, with gamma correction, batch converting, automatically formats convertions, XYZ and RGB colorspace suppots, etc.
 2. A docker container that can be easily deployed as a GUI application
 
 ![ui-demo.jpg](asset/ui-demo.jpg)
@@ -26,28 +26,45 @@ rgb = hsi2rgb(hsi) # rgb: (3, 11, 11)
 3. More examples can be found in [test.py](core/tests/test.py)
 
 
-## GUI
-[Online HuggingFace Demo](https://huggingface.co/spaces/songyz2019/hsi2rgb)
-
+## GUI with Docker
+<!-- [Online HuggingFace Demo](https://huggingface.co/spaces/songyz2019/hsi2rgb) -->
 1. Run the container: `docker run -it -p 7860:7860 songyz2019/hsi2rgb`
 2. Open `http://localhost:7860` in your browser
 3. Upload your HSI image (`.mat` or `.tif`)
 4. Set the wave length range
 5. Submit and see the result
 
+## GUI with pip/pipx/uvx
+Don't like docker? You can try use the GUI with pip, pipx, or uvx
+
+```bash
+# For pip:
+pip install hsi2rgb_gui
+hsi2rgb_gui
+
+# For uv, run:
+uvx hsi2rgb_gui
+
+# For pipx:
+pip install hsi2rgb_gui
+hsi2rgb_gui
+```
+
+
 # Build
-## uv
+## Python Package
 1. Install [uv](https://docs.astral.sh/uv/)
 2. Simply sync dependicies and build
 ```bash
+cd core
 uv sync
 uv build
 ```
 
-## Docker
-> The docker app is under refactor, please use [this branch](https://github.com/songyz2019/hsi2rgb/tree/f2c76629b49659e7d16ec62958c8a972e97fde3c) to build currently.
-1. Build the container: `docker compose build`
-2. Run the container: `docker compose up -d`
+## Docker GUI
+1. Open the `gui` folder: `cd gui`
+2. Build the container: `docker compose build`
+3. Run the container: `docker compose up -d`
 
 # License
 ```text

gui/Dockerfile

@@ -7,7 +7,9 @@ WORKDIR /app
 ADD ./ /app/
 # Avoid unnecessary uv sync
 RUN rm -rf /app/src 
-RUN uv sync --frozen --no-cache
+# The --no-cache for uv make huggingface buggy, with errors like permission denied for /uv/.cache
+RUN uv sync --frozen
+
 
 # Use these commands in alphine linux since there's no manylinux musl for scikit-image
 # The image size of alphine can be reduced to 650MB without aggressive optimization. 
@@ -25,4 +27,4 @@ EXPOSE 7860
 ENV GRADIO_SERVER_NAME="0.0.0.0"
 
 # We should make Dockerfile less coupled with the project and focusing on environment setup
-CMD ["uv", "run", "start"]
+CMD ["uv", "run", "hsi2rgb_gui"]

gui/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "hsi2rgb-gui"
-version = "1.2.0"
+version = "1.2.2"
 description = "Easily convert a hyperspectral image to an RGB image."
 readme = "README.md"
 requires-python = ">=3.13"
@@ -15,8 +15,12 @@ dependencies = [
 ]
 license = { file = "LICENSE" }
 classifiers = [
-    "Private :: Do Not Upload",
-    "Development Status :: 4 - Beta",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: Implementation :: CPython",
 ]
 
 [build-system]
@@ -32,6 +36,6 @@ dev = [
 ]
 
 [project.scripts]
-start = "hsi2rgb_gui.web:main"
+hsi2rgb_gui = "hsi2rgb_gui.web:main"