← Whispering

fix: Rename ui package to whispering_ui to avoid NiceGUI conflict

2fd77f0135b97c442c84108c96f3438a419e046c · Claude · Dec 1, 2025 20:13

The package name 'ui' conflicted with NiceGUI's ui module, causing
RuntimeWarning and unpredictable behavior. Renamed to 'whispering_ui'
for clarity and to avoid module name conflicts.

Updated:
- Renamed src/ui/ to src/whispering_ui/
- Updated all launcher scripts to use whispering_ui.main
- Updated documentation with note about naming

+11 −11 · 10 files changed

• scripts/run_nicegui.py +1 −1
• scripts/run_nicegui.sh +1 −1
• src/{ui => whispering_ui}/README.md +8 −8
• src/{ui => whispering_ui}/__init__.py +1 −1
• src/{ui => whispering_ui}/bridge.py +0 −0
• src/{ui => whispering_ui}/components/__init__.py +0 −0
• src/{ui => whispering_ui}/components/output.py +0 −0
• src/{ui => whispering_ui}/components/sidebar.py +0 −0
• src/{ui => whispering_ui}/main.py +0 −0
• src/{ui => whispering_ui}/state.py +0 −0

diff --git a/scripts/run_nicegui.py b/scripts/run_nicegui.py
index c5cc297..225de5b 100755
--- a/scripts/run_nicegui.py
+++ b/scripts/run_nicegui.py
@@ -23,5 +23,5 @@ except ImportError:
 
 # Launch the NiceGUI application
 print("Starting Whispering with NiceGUI interface...")
-from ui.main import main
+from whispering_ui.main import main
 main()
diff --git a/scripts/run_nicegui.sh b/scripts/run_nicegui.sh
index 9e660d4..487145f 100755
--- a/scripts/run_nicegui.sh
+++ b/scripts/run_nicegui.sh
@@ -32,4 +32,4 @@ export PYTHONPATH="$PROJECT_DIR/src:$PYTHONPATH"
 # Change to src directory and run
 cd "$PROJECT_DIR/src"
 echo "Starting Whispering with NiceGUI interface..."
-python3 -m ui.main "$@"
+python3 -m whispering_ui.main "$@"
diff --git a/src/ui/README.md b/src/whispering_ui/README.md
similarity index 88%
rename from src/ui/README.md
rename to src/whispering_ui/README.md
index 9e51a6c..d3c45b7 100644
--- a/src/ui/README.md
+++ b/src/whispering_ui/README.md
@@ -1,7 +1,9 @@
-# NiceGUI UI Module
+# Whispering NiceGUI UI Module
 
 This directory contains the modular NiceGUI-based user interface for Whispering.
 
+**Note:** This package is named `whispering_ui` (not `ui`) to avoid conflicts with NiceGUI's own `ui` module.
+
 ## Architecture
 
 The UI is organized into separate concerns:
@@ -39,14 +41,12 @@ The UI is organized into separate concerns:
 To run the NiceGUI version:
 
 ```bash
-cd src
-python -m ui.main
-```
+# Use the launcher script
+./scripts/run_nicegui.sh
 
-Or from the project root:
-
-```bash
-python src/ui/main.py
+# Or from src directory:
+cd src
+python -m whispering_ui.main
 ```
 
 ## Key Differences from tkinter Version
diff --git a/src/ui/__init__.py b/src/whispering_ui/__init__.py
similarity index 71%
rename from src/ui/__init__.py
rename to src/whispering_ui/__init__.py
index ef7efd6..4787f2b 100644
--- a/src/ui/__init__.py
+++ b/src/whispering_ui/__init__.py
@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """
-NiceGUI UI Package
+Whispering NiceGUI UI Package
 """
 
 from .main import main
diff --git a/src/ui/bridge.py b/src/whispering_ui/bridge.py
similarity index 100%
rename from src/ui/bridge.py
rename to src/whispering_ui/bridge.py
diff --git a/src/ui/components/__init__.py b/src/whispering_ui/components/__init__.py
similarity index 100%
rename from src/ui/components/__init__.py
rename to src/whispering_ui/components/__init__.py
diff --git a/src/ui/components/output.py b/src/whispering_ui/components/output.py
similarity index 100%
rename from src/ui/components/output.py
rename to src/whispering_ui/components/output.py
diff --git a/src/ui/components/sidebar.py b/src/whispering_ui/components/sidebar.py
similarity index 100%
rename from src/ui/components/sidebar.py
rename to src/whispering_ui/components/sidebar.py
diff --git a/src/ui/main.py b/src/whispering_ui/main.py
similarity index 100%
rename from src/ui/main.py
rename to src/whispering_ui/main.py
diff --git a/src/ui/state.py b/src/whispering_ui/state.py
similarity index 100%
rename from src/ui/state.py
rename to src/whispering_ui/state.py