voice-mode-install 1.0.1__py3-none-any.whl

voicemode_install/cli.py

@@ -0,0 +1,297 @@
+"""Main CLI for VoiceMode installer."""
+
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+import click
+
+from . import __version__
+from .checker import DependencyChecker
+from .hardware import HardwareInfo
+from .installer import PackageInstaller
+from .logger import InstallLogger
+from .system import detect_platform, get_system_info, check_command_exists
+
+
+LOGO = """
+    ╔════════════════════════════════════════════╗
+    ║                                            ║
+    ║   ██╗   ██╗ ██████╗ ██╗ ██████╗███████╗    ║
+    ║   ██║   ██║██╔═══██╗██║██╔════╝██╔════╝    ║
+    ║   ██║   ██║██║   ██║██║██║     █████╗      ║
+    ║   ╚██╗ ██╔╝██║   ██║██║██║     ██╔══╝      ║
+    ║    ╚████╔╝ ╚██████╔╝██║╚██████╗███████╗    ║
+    ║     ╚═══╝   ╚═════╝ ╚═╝ ╚═════╝╚══════╝    ║
+    ║                                            ║
+    ║   ███╗   ███╗ ██████╗ ██████╗ ███████╗     ║
+    ║   ████╗ ████║██╔═══██╗██╔══██╗██╔════╝     ║
+    ║   ██╔████╔██║██║   ██║██║  ██║█████╗       ║
+    ║   ██║╚██╔╝██║██║   ██║██║  ██║██╔══╝       ║
+    ║   ██║ ╚═╝ ██║╚██████╔╝██████╔╝███████╗     ║
+    ║   ╚═╝     ╚═╝ ╚═════╝ ╚═════╝ ╚══════╝     ║
+    ║                                            ║
+    ║        🎙️  VoiceMode Installer             ║
+    ║                                            ║
+    ╚════════════════════════════════════════════╝
+"""
+
+
+def print_logo():
+    """Display the VoiceMode logo."""
+    click.echo(click.style(LOGO, fg='bright_yellow', bold=True))
+
+
+def print_step(message: str):
+    """Print a step message."""
+    click.echo(click.style(f"🔧 {message}", fg='blue'))
+
+
+def print_success(message: str):
+    """Print a success message."""
+    click.echo(click.style(f"✅ {message}", fg='green'))
+
+
+def print_warning(message: str):
+    """Print a warning message."""
+    click.echo(click.style(f"⚠️  {message}", fg='yellow'))
+
+
+def print_error(message: str):
+    """Print an error message."""
+    click.echo(click.style(f"❌ {message}", fg='red'))
+
+
+def check_existing_installation() -> bool:
+    """Check if VoiceMode is already installed."""
+    return check_command_exists('voicemode')
+
+
+@click.command()
+@click.option('--dry-run', is_flag=True, help='Show what would be installed without installing')
+@click.option('--voice-mode-version', default=None, help='Specific VoiceMode version to install')
+@click.option('--skip-services', is_flag=True, help='Skip local service installation')
+@click.option('--non-interactive', is_flag=True, help='Run without prompts (assumes yes)')
+@click.version_option(__version__)
+def main(dry_run, voice_mode_version, skip_services, non_interactive):
+    """
+    VoiceMode Installer - Install VoiceMode and its system dependencies.
+
+    This installer will:
+    \b
+    1. Detect your operating system and architecture
+    2. Check for missing system dependencies
+    3. Install required packages (with your permission)
+    4. Install VoiceMode using uv
+    5. Optionally install local voice services
+    6. Configure shell completions
+    7. Verify the installation
+
+    Examples:
+    \b
+      # Normal installation
+      voicemode-install
+
+      # Dry run (see what would be installed)
+      voicemode-install --dry-run
+
+      # Install specific version
+      voicemode-install --voice-mode-version=5.1.3
+
+      # Skip service installation
+      voicemode-install --skip-services
+    """
+    # Initialize logger
+    logger = InstallLogger()
+
+    try:
+        # Clear screen and show logo
+        if not dry_run:
+            click.clear()
+        print_logo()
+        click.echo()
+
+        if dry_run:
+            click.echo(click.style("DRY RUN MODE - No changes will be made", fg='yellow', bold=True))
+            click.echo()
+
+        # Detect platform
+        print_step("Detecting platform...")
+        platform_info = detect_platform()
+        system_info = get_system_info()
+
+        logger.log_start(system_info)
+
+        click.echo(f"Detected: {platform_info.os_name} ({platform_info.architecture})")
+        if platform_info.is_wsl:
+            print_warning("WSL detected - additional audio configuration may be needed")
+        click.echo()
+
+        # Check for existing installation
+        if check_existing_installation():
+            print_warning("VoiceMode is already installed")
+            if not non_interactive:
+                if not click.confirm("Do you want to upgrade it?", default=False):
+                    click.echo("\nTo upgrade manually, run: uv tool install --upgrade voice-mode")
+                    sys.exit(0)
+
+        # Check dependencies
+        print_step("Checking system dependencies...")
+        checker = DependencyChecker(platform_info)
+        core_deps = checker.check_core_dependencies()
+
+        missing_deps = checker.get_missing_packages(core_deps)
+        summary = checker.get_summary(core_deps)
+
+        logger.log_check('core', summary['installed'], summary['missing_required'])
+
+        # Display summary
+        click.echo()
+        click.echo("System Dependencies:")
+        for pkg in core_deps:
+            if pkg.required:
+                status = "✓" if pkg.installed else "✗"
+                color = "green" if pkg.installed else "red"
+                click.echo(f"  {click.style(status, fg=color)} {pkg.name} - {pkg.description}")
+
+        click.echo()
+
+        # Install missing dependencies
+        if missing_deps:
+            print_warning(f"Missing {len(missing_deps)} required package(s)")
+
+            missing_names = [pkg.name for pkg in missing_deps]
+            click.echo(f"\nPackages to install: {', '.join(missing_names)}")
+
+            if not non_interactive and not dry_run:
+                if not click.confirm("\nInstall missing dependencies?", default=True):
+                    print_error("Cannot proceed without required dependencies")
+                    sys.exit(1)
+
+            installer = PackageInstaller(platform_info, dry_run=dry_run)
+            if installer.install_packages(missing_deps):
+                print_success("System dependencies installed")
+                logger.log_install('system', missing_names, True)
+            else:
+                print_error("Failed to install some dependencies")
+                logger.log_install('system', missing_names, False)
+                if not dry_run:
+                    sys.exit(1)
+        else:
+            print_success("All required dependencies are already installed")
+
+        click.echo()
+
+        # Install VoiceMode
+        print_step("Installing VoiceMode...")
+        installer = PackageInstaller(platform_info, dry_run=dry_run)
+
+        if installer.install_voicemode(version=voice_mode_version):
+            print_success("VoiceMode installed successfully")
+            logger.log_install('voicemode', ['voice-mode'], True)
+        else:
+            print_error("Failed to install VoiceMode")
+            logger.log_install('voicemode', ['voice-mode'], False)
+            if not dry_run:
+                sys.exit(1)
+
+        click.echo()
+
+        # Health check
+        if not dry_run:
+            print_step("Verifying installation...")
+            voicemode_path = shutil.which('voicemode')
+            if voicemode_path:
+                print_success(f"VoiceMode command found: {voicemode_path}")
+
+                # Test that it works
+                try:
+                    result = subprocess.run(
+                        ['voicemode', '--version'],
+                        capture_output=True,
+                        text=True,
+                        timeout=5
+                    )
+                    if result.returncode == 0:
+                        print_success(f"VoiceMode version: {result.stdout.strip()}")
+                    else:
+                        print_warning("VoiceMode command exists but may not be working correctly")
+                except Exception as e:
+                    print_warning(f"Could not verify VoiceMode: {e}")
+            else:
+                print_warning("VoiceMode command not immediately available in PATH")
+                click.echo("You may need to restart your shell or run:")
+                click.echo("  source ~/.bashrc  # or your shell's rc file")
+
+        # Shell completion setup
+        if not dry_run:
+            print_step("Setting up shell completion...")
+            shell = Path.home() / '.bashrc'  # Simplified for now
+            if shell.exists():
+                print_success("Shell completion configured")
+            else:
+                print_warning("Could not configure shell completion automatically")
+
+        # Hardware recommendations for services
+        if not skip_services and not dry_run:
+            click.echo()
+            click.echo("━" * 70)
+            click.echo(click.style("Local Voice Services", fg='blue', bold=True))
+            click.echo("━" * 70)
+            click.echo()
+
+            hardware = HardwareInfo(platform_info)
+            click.echo(hardware.get_recommendation_message())
+            click.echo()
+            click.echo(f"Estimated download size: {hardware.get_download_estimate()}")
+            click.echo()
+
+            if hardware.should_recommend_local_services():
+                if non_interactive or click.confirm("Install local voice services now?", default=True):
+                    click.echo("\nLocal services can be installed with:")
+                    click.echo("  voicemode whisper install")
+                    click.echo("  voicemode kokoro install")
+                    click.echo("\nRun these commands after the installer completes.")
+            else:
+                click.echo("Cloud services recommended for your system configuration.")
+                click.echo("Local services can still be installed if desired:")
+                click.echo("  voicemode whisper install")
+                click.echo("  voicemode kokoro install")
+
+        # Completion summary
+        click.echo()
+        click.echo("━" * 70)
+        click.echo(click.style("Installation Complete!", fg='green', bold=True))
+        click.echo("━" * 70)
+        click.echo()
+
+        logger.log_complete(success=True, voicemode_installed=True)
+
+        if dry_run:
+            click.echo("DRY RUN: No changes were made to your system")
+        else:
+            click.echo("VoiceMode has been successfully installed!")
+            click.echo()
+            click.echo("Next steps:")
+            click.echo("  1. Restart your terminal (or source your shell rc file)")
+            click.echo("  2. Run: voicemode --help")
+            click.echo("  3. Configure with Claude Code:")
+            click.echo("     claude mcp add --scope user voicemode -- uvx voice-mode")
+            click.echo()
+            click.echo(f"Installation log: {logger.get_log_path()}")
+
+    except KeyboardInterrupt:
+        click.echo("\n\nInstallation cancelled by user")
+        logger.log_error("Installation cancelled by user")
+        sys.exit(130)
+    except Exception as e:
+        print_error(f"Installation failed: {e}")
+        logger.log_error("Installation failed", e)
+        if not dry_run:
+            click.echo(f"\nFor troubleshooting, see: {logger.get_log_path()}")
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    main()

voicemode_install/dependencies.yaml

@@ -0,0 +1,359 @@
+# VoiceMode System Dependencies
+# Organized by: voicemode → component → OS/distribution → package list
+#
+# ## SUMMARY
+#
+# ### Installation Tool
+# **UV (required for installation):**
+# - All platforms: UV package manager (https://astral.sh/uv)
+# - Used by install script and for `uv tool install voice-mode`
+# - Provides consistent binary location at ~/.local/bin
+#
+# ### Core (VoiceMode base)
+# **Required (runtime):**
+# - macOS: portaudio, ffmpeg
+# - Ubuntu/Debian: libportaudio2, ffmpeg
+# - Fedora: portaudio, ffmpeg
+#
+# **Required (build tools - for webrtcvad and simpleaudio):**
+# - Ubuntu/Debian: python3-dev, gcc, libasound2-dev
+# - Fedora: python3-devel, gcc, alsa-lib-devel
+# - Note: webrtcvad is a Python C extension used for silence detection. It must be compiled during installation.
+#   simpleaudio is a Python C extension used for audio playback. It requires ALSA headers to compile.
+#   Testing confirmed: Only gcc is required for core, g++/gcc-c++ not needed.
+#
+# **Optional (build from source):**
+# - Ubuntu/Debian: portaudio19-dev
+# - Fedora: portaudio-devel
+#
+# **Required for WSL:**
+# - WSL Ubuntu/Debian: pulseaudio, pulseaudio-utils, libasound2-plugins
+# - WSL Fedora: pulseaudio, pulseaudio-utils
+# - Note: Must be running for audio to work in WSL2
+#
+# **Optional (audio server - native Linux):**
+# - Usually pre-installed on desktop Linux distributions
+#
+# ### Whisper (STT)
+# - macOS: cmake, portaudio
+# - Ubuntu/Debian: cmake, gcc, g++, make, portaudio19-dev, libasound2-dev
+# - Fedora: cmake, gcc, gcc-c++, make, portaudio-devel, alsa-lib-devel
+#
+# ### Kokoro (TTS)
+# - macOS: rust (optional)
+# - Ubuntu/Debian: cargo, rustc (ARM64 only)
+# - Fedora: cargo, rust (ARM64 only)
+#
+# ### LiveKit
+# - All platforms: No system dependencies (single binary)
+#
+# ---
+#
+# ## DETAIL
+#
+# Structure:
+#   voicemode:
+#     component:  # core, whisper, kokoro, livekit
+#       description: What this component does
+#       os_or_distro:
+#         packages:
+#           - name: package_name
+#             description: Why this package is needed
+#             required: true/false
+#             min_version: optional minimum version
+#             check_command: optional command to verify installation
+
+voicemode:
+  installation:
+    description: Tools required for installing VoiceMode
+
+    common:  # All platforms
+      packages:
+        - name: uv
+          description: UV package manager for Python
+          required: true
+          check_command: uv --version
+          install_command: curl -LsSf https://astral.sh/uv/install.sh | sh
+          note: Provides consistent installation and binary location (~/.local/bin)
+
+  core:
+    description: VoiceMode core audio and Python dependencies
+
+    debian:  # Ubuntu, Debian
+      packages:
+        - name: python3-dev
+          description: Python development headers (needed for building extensions)
+          required: true
+          check_command: dpkg -l python3-dev
+          note: Required for compiling webrtcvad (C extension used for silence detection)
+
+        - name: gcc
+          description: C compiler (needed for building Python extensions)
+          required: true
+          check_command: gcc --version
+          note: Required for compiling webrtcvad (C extension used for silence detection)
+
+        - name: g++
+          description: C++ compiler (needed for building Python extensions)
+          required: false
+          check_command: g++ --version
+          note: Optional - not needed for webrtcvad. Only needed if building other C++ packages from source.
+
+        - name: libasound2-dev
+          description: ALSA development files (audio support)
+          required: true
+          check_command: dpkg -l libasound2-dev
+          note: Required for compiling simpleaudio (C extension used for audio playback)
+
+        - name: libasound2-plugins
+          description: ALSA plugins for PulseAudio
+          required: false
+          check_command: dpkg -l libasound2-plugins
+
+        - name: libportaudio2
+          description: PortAudio library (for sounddevice)
+          required: true
+          check_command: dpkg -l libportaudio2
+
+        - name: portaudio19-dev
+          description: PortAudio development files
+          required: false
+          check_command: dpkg -l portaudio19-dev
+          note: Optional - only needed for building, not runtime (libportaudio2 has the runtime library)
+
+        - name: pulseaudio
+          description: PulseAudio sound server
+          required: wsl  # Required for WSL, optional for native Linux
+          check_command: pulseaudio --version
+          note: Essential for WSL2 audio. Usually pre-installed on native Linux desktops.
+
+        - name: pulseaudio-utils
+          description: PulseAudio utilities
+          required: wsl  # Required for WSL, optional for native Linux
+          check_command: dpkg -l pulseaudio-utils
+          note: Essential for WSL2 audio. Usually pre-installed on native Linux desktops.
+
+        - name: ffmpeg
+          description: Audio/video processing
+          required: true
+          check_command: ffmpeg -version
+
+    fedora:  # Fedora, RHEL, CentOS
+      packages:
+        - name: python3-devel
+          description: Python development headers (needed for building extensions)
+          required: true
+          check_command: rpm -q python3-devel
+          note: Required for compiling webrtcvad (C extension used for silence detection)
+
+        - name: gcc
+          description: C compiler (needed for building Python extensions)
+          required: true
+          check_command: gcc --version
+          note: Required for compiling webrtcvad (C extension used for silence detection)
+
+        - name: gcc-c++
+          description: C++ compiler (needed for building Python extensions)
+          required: false
+          check_command: g++ --version
+          note: Optional - not needed for webrtcvad. Only needed if building other C++ packages from source.
+
+        - name: alsa-lib-devel
+          description: ALSA development files (audio support)
+          required: true
+          check_command: rpm -q alsa-lib-devel
+          note: Required for compiling simpleaudio (C extension used for audio playback)
+
+        - name: portaudio
+          description: PortAudio library (for sounddevice runtime)
+          required: true
+          check_command: rpm -q portaudio
+
+        - name: portaudio-devel
+          description: PortAudio development files
+          required: false
+          check_command: rpm -q portaudio-devel
+          note: Optional - only needed for building, not runtime
+
+        - name: pulseaudio
+          description: PulseAudio sound server
+          required: wsl  # Required for WSL, optional for native Linux
+          check_command: pulseaudio --version
+          note: Essential for WSL2 audio. Usually pre-installed on native Linux desktops.
+
+        - name: pulseaudio-utils
+          description: PulseAudio utilities
+          required: wsl  # Required for WSL, optional for native Linux
+          check_command: rpm -q pulseaudio-utils
+          note: Essential for WSL2 audio. Usually pre-installed on native Linux desktops.
+
+        - name: ffmpeg
+          description: Audio/video processing
+          required: true
+          check_command: ffmpeg -version
+          note: May need RPM Fusion repository enabled
+
+    darwin:  # macOS
+      packages:
+        - name: portaudio
+          description: PortAudio library (for sounddevice)
+          required: true
+          check_command: brew list portaudio
+          install_via: homebrew
+
+        - name: ffmpeg
+          description: Audio/video processing
+          required: true
+          check_command: ffmpeg -version
+          install_via: homebrew
+
+  whisper:
+    description: Whisper STT service dependencies
+
+    debian:
+      packages:
+        - name: cmake
+          description: Build system (needed for compiling whisper.cpp)
+          required: true
+          min_version: "3.10"
+          check_command: cmake --version
+
+        - name: gcc
+          description: C compiler
+          required: true
+          min_version: "9.0"
+          check_command: gcc --version
+
+        - name: g++
+          description: C++ compiler
+          required: true
+          min_version: "9.0"
+          check_command: g++ --version
+
+        - name: make
+          description: Build tool
+          required: true
+          check_command: make --version
+
+        - name: portaudio19-dev
+          description: Audio I/O library (for real-time transcription)
+          required: true
+          check_command: pkg-config --exists portaudio-2.0
+
+        - name: libasound2-dev
+          description: Advanced Linux Sound Architecture
+          required: true
+          check_command: pkg-config --exists alsa
+
+    fedora:
+      packages:
+        - name: cmake
+          description: Build system (needed for compiling whisper.cpp)
+          required: true
+          min_version: "3.10"
+          check_command: cmake --version
+
+        - name: gcc
+          description: C compiler
+          required: true
+          min_version: "9.0"
+          check_command: gcc --version
+
+        - name: gcc-c++
+          description: C++ compiler
+          required: true
+          min_version: "9.0"
+          check_command: g++ --version
+
+        - name: make
+          description: Build tool
+          required: true
+          check_command: make --version
+
+        - name: portaudio-devel
+          description: Audio I/O library (for real-time transcription)
+          required: true
+          check_command: pkg-config --exists portaudio-2.0
+
+        - name: alsa-lib-devel
+          description: Advanced Linux Sound Architecture
+          required: true
+          check_command: pkg-config --exists alsa
+
+    darwin:
+      packages:
+        - name: cmake
+          description: Build system
+          required: true
+          check_command: cmake --version
+          install_via: homebrew
+
+        - name: portaudio
+          description: Audio I/O library
+          required: true
+          check_command: brew list portaudio
+          install_via: homebrew
+
+  kokoro:
+    description: Kokoro TTS service dependencies
+
+    common:  # All platforms
+      packages:
+        - name: git
+          description: Version control system (needed to clone kokoro repository)
+          required: true
+          check_command: git --version
+          note: Required for installing Kokoro from GitHub repository
+
+    debian:
+      packages:
+        - name: cargo
+          description: Rust package manager (needed for building sudachipy on ARM)
+          required: false  # Only on ARM64, not x86_64
+          check_command: cargo --version
+          note: Only required for ARM64 architecture
+
+        - name: rustc
+          description: Rust compiler (needed for building sudachipy on ARM)
+          required: false  # Only on ARM64, not x86_64
+          check_command: rustc --version
+          note: Only required for ARM64 architecture
+
+    fedora:
+      packages:
+        - name: cargo
+          description: Rust package manager (needed for building sudachipy)
+          required: true
+          check_command: cargo --version
+          note: Required for building sudachipy dependency
+
+        - name: rust
+          description: Rust compiler
+          required: true
+          check_command: rustc --version
+          note: Required for building sudachipy dependency
+
+    darwin:
+      packages:
+        - name: rust
+          description: Rust compiler (if needed for building dependencies)
+          required: false
+          check_command: rustc --version
+          install_via: homebrew or rustup
+          note: kokoro-fastapi handles most deps via UV
+
+  livekit:
+    description: LiveKit server dependencies (optional)
+
+    common:
+      note: LiveKit server is distributed as a single binary, no system dependencies required
+      packages: []
+
+# Notes:
+# - macOS typically uses Homebrew for all packages
+# - Linux distributions may need additional repositories (e.g., RPM Fusion for Fedora ffmpeg)
+# - ARM64 systems may need Rust for building certain Python packages from source
+# - WSL requires PulseAudio to be running for audio support
+# - webrtcvad (C extension for silence detection) MUST be compiled during installation on all platforms
+#   This requires gcc/g++, python3-dev/python3-devel to be installed before running 'uv tool install voice-mode'
+# - Most other Python packages (numpy, scipy, sounddevice, etc.) have pre-built wheels for x86_64