Installation
Prerequisites
Before installing pypixelcolor, ensure you have the following prerequisites:
- Python 3.9 or higher
- pip (Python package installer)
- Bluetooth adapter on your machine
Installation
Via PyPI (pip)
You can install pypixelcolor using pip:
pip install pypixelcolor
Optional features
You can install optional features depending on your needs:
- Enhanced CLI:
pip install "pypixelcolor[cli]" - WebSocket server bridge:
pip install "pypixelcolor[server]" - HEIF/HEIC image format support:
pip install "pypixelcolor[heif]" - Complete installation with all features:
pip install "pypixelcolor[all]"
To verify that the installation was successful, you can check the installed version:
pypixelcolor --version
Via Arch Linux (AUR)
If you are using Arch Linux or an Arch-based distribution, pypixelcolor is available on the AUR:
Stable release:
paru -S python-pypixelcolor
Development version (latest Git main):
paru -S python-pypixelcolor-git
Installation from source
If you prefer to install pypixelcolor from the source code, follow these steps:
- Clone the repository from GitHub:
git clone https://github.com/lucagoc/pypixelcolor.git
- Navigate to the cloned directory:
cd pypixelcolor
- Install the package using pip:
pip install .
Post-installation
After installation, you may want to set up your Bluetooth adapter to ensure it works correctly with pypixelcolor. Make sure your Bluetooth is enabled and that your device is discoverable.
You can now start using pypixelcolor to control your iPixel Color LED matrix devices!