Getting Started

• Sources or PIP Install?
  • PIP Install the Easy Way
    • When
    • How
  • Sources for Developers
    • When
    • How

PIP Install or Download Source?

PIP Install the Easy Way

When

You just want an easy life and don't need to modify any code or get improvements that are being developed but not yet ready for release.

How

For Raspberry Pi 2 and 3

python3 -m pip install -U pip
python3 -m pip install picframe

If you see something like:

"The script picframe is installed in '/home/pi/.local/bin' which is not on PATH."

Reboot: sudo reboot

For Raspberry Pi 4

Unfortunately, to be able to run picframe from startup or without the desktop running you have to install it as root:

sudo python3 -m pip install -U pip
sudo python3 -m pip install picframe

Downloading Source Code (for Developers)

When

You need to use the latest iteration of the code... or you are a programmer and can see a way to make it better!

How

The following commands will download the sources and install picframe in 'editable' mode. That means any changes to the code will have immediate effect. For Pi 2 and 3:

git clone https://github.com/helgeerbe/picframe.git
cd picframe
python3 -m pip install -U pip
python3 -m pip install -e .

or in the case of Raspberry Pi 4, as above, but using sudo

sudo python3 -m pip install -U pip
sudo python3 -m pip install -e .