Documentation Index
Fetch the complete documentation index at: https://mintlify.com/ShubhamPP04/Izzy/llms.txt
Use this file to discover all available pages before exploring further.
This guide walks you through setting up the Izzy Music Player development environment.
Clone the repository
First, clone the Izzy Music Player repository from GitHub:
git clone https://github.com/ShubhamPP04/Izzy.git
cd Izzy
Python environment setup
Izzy uses a Python virtual environment to manage its backend dependencies.
Run the setup script
Make the setup script executable and run it to create the Python virtual environment:chmod +x setup.sh
./setup.sh
music_env in the project directory. Install Python dependencies
Install the required Python packages:pip install -r requirements.txt
- ytmusicapi (>= 1.7.0)
- yt-dlp (>= 2023.12.30)
- requests (>= 2.31.0)
Verify installation
Activate the virtual environment and verify Python version:source music_env/bin/activate
python --version
Project structure
After cloning, your project directory will have the following structure:
Izzy/
├── Izzy/ # Main app source
│ ├── IzzyApp.swift # App entry point
│ ├── Views/ # SwiftUI views
│ ├── Managers/ # Business logic
│ ├── Models/ # Data models
│ ├── Services/ # External integrations
│ └── ytmusic_service.py # Python backend
├── build/ # Build outputs
├── releases/ # Release builds
├── requirements.txt # Python dependencies
├── setup.sh # Virtual environment setup
└── build_dmg.sh # DMG creation script
Opening the project
You can open the project in Xcode using either method:
Troubleshooting
Python environment issues
If you encounter issues with the Python virtual environment:
# Verify Python environment
cd /path/to/Izzy
source music_env/bin/activate
python --version
# Reinstall dependencies
pip install --upgrade -r requirements.txt
Permission issues
If you get permission errors when running scripts:
chmod +x setup.sh
chmod +x build_dmg.sh
Next steps
With your development environment set up, you’re ready to build the app.