A gui to control and manage snapcast written in python with PySide6
Table of Contents
Head to the releases page on github and download the preferred binary for your platform. There are binaries for Windows and Linux
- Arch Linux
- Debian
- Windows 10
- Windows 11
- MacOs (Not tested but should work, Open an issue if you find any issues)
Python Minimum Version >=3.9 only tested on 3.11 and 3.12
Python Dependencies
- snapcast
- py_notify
- PySide6
- platformdirs
System Dependencies
Arch Linux and derivates
The package is available on the aur so it can be installed with an aur helper like yay or manually
yay -Sy snapcast-gui-git (Note: the package is not in the aur yet so it will not work)git clone https://github.com/chicco-carone/Snapcast-Gui.git
cd Snapcast-Gui
makepkg -siThere is also on the releases page a prebuilt arch package that can be installed with pacman
sudo pacman -U snapcast-gui.x.x.x-1-any.pkg.tar.zstDebian and Ubuntu Derivates
On the releases page of the project there is a deb package that can be installed
sudo dpkg -i snapcast-gui-x.x.x.deb- Clone the Repository:
git clone https://github.com/chicco-carone/Snapcast-Gui.git
cd Snapcast-Gui- Create and Activate a Virtual Environment:
python -m venv venv
source venv/bin/activate- Build the project
pip install setuptools wheel
python setup.py sdist bdist_wheel- Install package on venv
pip install dist/snapcast_gui-x.x.x.tar.gz- Clone the Repository:
git clone https://github.com/chicco-carone/Snapcast-Gui.git
cd Snapcast-Gui- Create and Activate a Virtual Environment:
On Linux
python -m venv venv
venv/bin/activateOn Windows
python -m venv venv
.\venv\Scripts\activate.ps1- Install Dependencies:
pip install -r requirements.txt
pip install pyinstaller- Create the executable
For Linux
pyinstaller --onefile --name "snapcast-gui" --add-data "icons/Snapcast.png:icons" --add-data "icons/Github.png:icons" main.py
-onefile --add-data "snapcast_gui/icons:icons"For Windows
pyinstaller --onefile --name "snapcast-gui" --add-data "icons/Snapcast.png;icons" --add-data "icons/Github.png;icons" --uac-admin main.py- Clone the Repository:
git clone https://github.com/chicco-carone/Snapcast-Gui.git
cd Snapcast-Gui- Create and Activate a Virtual Environment:
On Linux
python -m venv venv
venv/bin/activateOn Windows
python -m venv venv
.\venv\Scripts\activate.ps1- Install the required dependencies
pip install -r requirements.txt- Run the Project:
You can run the project directly with python from the terminal or using an ide. For developing i only used visual studio code with the python extension pack from microsoft so i can't be certain that it works with other ide.
python snapcast_gui/main.pySee the planned features for a list of planned features.
See the known issues for a full list of known issues.
If you are having issues, please open an issue on the issues page
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Before doing anything always check the known issues and the planned features because something might already be there. Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the GPL-3 License. See LICENSE.txt for more information.
Francesco - chiccocarone@gmail.com
Project Link: https://github.com/chicco-carone/Snapcast-Gui