PuniPi Installation Instructions


1. System Setup (Ubuntu-based Systems)

Prior to installing the app you should download and run the install-deps.sh script. This script installs the necessary system libraries (e.g. GStreamer, Wayland, ...) for Ubuntu-based distributions required for the app to run.

  1. Download the script:
    install-deps.sh
  2. Run the script:
    chmod +x install-deps
    sudo ./install-deps.sh

2. Installing PuniPi

Make sure you have Python 3.12+ installed.

For the app installation you have 2 options:

2a. Installing the Binary from GitHub Releases

  1. Download the pre-built binary:

    Go to the PuniPi GitHub Releases page and download the latest punipi.tar.gz

  2. Extract and run:
    tar -xzf punipi.tar.gz
    chmod +x punipi
    ./punipi
    

2b. Installing via pip

Important: The official PyPI release is not yet available. In the meantime, you can install from TestPyPI for evaluation.

  1. Install PuniPi from TestPyPI:
    pip install --index-url https://test.pypi.org/simple punipi
  2. Run PuniPi:
    punipi

That's it! This app is still in an early development stage. So, please report any problems you might encounter.