Merge pull request #7 from yprez/codex/identify-codebase-improvement-opportunities

Entry point

Author: yprez

README.md

@@ -46,7 +46,13 @@ uv sync
 
 ## Running
 
-Run the synth with:
+Run the synth with the packaged GUI entry script:
+
+```bash
+uv run qwertysynth
+```
+
+You can also continue using the legacy entry point if you prefer:
 
 ```bash
 uv run python main.py
@@ -57,7 +63,7 @@ Then press keys on the keyboard to play or use the GUI controls. Press ESC to qu
 ## Command line options
 
 ```bash
-uv run python main.py [OPTIONS]
+uv run qwertysynth [OPTIONS]
 ```
 
 - `--midi FILE` - Load MIDI file on startup
@@ -66,7 +72,7 @@ uv run python main.py [OPTIONS]
 
 Example:
 ```bash
-uv run python main.py --midi song.mid --play --patch "Bass"
+uv run qwertysynth --midi song.mid --play --patch "Bass"
 ```
 
 ## Input methods

main.py

@@ -1,34 +1,11 @@
-"""QWERTY Synth - A simple software synthesizer controlled by your keyboard."""
+"""Backward-compatible entry point for running the QWERTY Synth GUI."""
 
-import argparse
-
-from qwerty_synth import gui_qt as gui
+from qwerty_synth.entry import main as _launch_gui
 
 
 def main():
-    """Start the QWERTY Synth application."""
-    parser = argparse.ArgumentParser(description='QWERTY Synth - Software synthesizer')
-    parser.add_argument('--midi', type=str, help='MIDI file to load on startup')
-    parser.add_argument('--play', action='store_true', help='Automatically play the MIDI file')
-    parser.add_argument('--patch', type=str, help='Patch name to load on startup')
-    args = parser.parse_args()
-
-    print('QWERTY Synth: Play keys A-K, W,E,T,Y,U,O,P etc.')
-    print('Use Z / X to shift octave down / up')
-    print('Press ESC to quit')
-
-    if args.midi:
-        print(f'MIDI file will be loaded: {args.midi}')
-        if args.play:
-            print('Auto-play enabled')
-
-    if args.patch:
-        print(f'Patch will be loaded: {args.patch}')
-
-    print('Starting GUI...')
-
-    # Start the GUI (which handles audio stream and keyboard input)
-    gui.start_gui(midi_file=args.midi, auto_play=args.play, patch_name=args.patch)
+    """Launch the QWERTY Synth application."""
+    _launch_gui()
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "qwerty-synth"
+name = "qwertysynth"
 version = "0.1.0"
 description = "A minimalist real-time synthesizer with QWERTY keyboard input"
 readme = "README.md"
@@ -20,6 +20,12 @@ dependencies = [
     "soundfile>=0.13.1",
 ]
 
+[project.scripts]
+qwertysynth = "qwerty_synth.entry:main"
+
+[tool.uv]
+package = true
+
 [dependency-groups]
 dev = [
     "pytest>=8.3.5",

qwerty_synth/entry.py

@@ -0,0 +1,34 @@
+"""Entry point for launching the QWERTY Synth GUI."""
+
+import argparse
+
+from qwerty_synth import gui_qt as gui
+
+
+def main():
+    """Parse command-line arguments and start the synthesizer GUI."""
+    parser = argparse.ArgumentParser(description='QWERTY Synth - Software synthesizer')
+    parser.add_argument('--midi', help='MIDI file to load on startup')
+    parser.add_argument('--play', action='store_true', help='Automatically play the MIDI file')
+    parser.add_argument('--patch', help='Patch name to load on startup')
+    args = parser.parse_args()
+
+    print('QWERTY Synth: Play keys A-K, W,E,T,Y,U,O,P etc.')
+    print('Use Z / X to shift octave down / up')
+    print('Press ESC to quit')
+
+    if args.midi:
+        print(f'MIDI file will be loaded: {args.midi}')
+        if args.play:
+            print('Auto-play enabled')
+
+    if args.patch:
+        print(f'Patch will be loaded: {args.patch}')
+
+    print('Starting GUI...')
+
+    gui.start_gui(midi_file=args.midi, auto_play=args.play, patch_name=args.patch)
+
+
+if __name__ == "__main__":
+    main()