Skip to main content

NOTE: In progress!! Come back later!

PiPlayer

A relatively easy-to-use utility to set up one or more RaspberryPi's as a video player.

PiPlayer will install vlc on your Pi(s), transfer videos, and set them to play on startup.

Installation

You should have one or more Pi's on your local network. The Pi's should have:

  • the latest raspbian with console only install
  • auto-login enabled
  • passwordless authentication with ssh keys

On your computer, install PiPlayer with:

pip install piplayer

Usage

Basic usage

You can send one or more videos directly to individual Pi's like so:

piplayer --host HOSTNAME --video VIDEONAME.mp4

This will transfer the video file(s) to the Pi, and make them play on startup in a loop. The --video option can take multiple video files.

Project file

For more complex scenarios, you can also create project instructions as a YAML file. Here's an example project file:

players:
  - host: player1.local
    videos: vid1.mp4
  - host: player2.local
    videos: ["vid2.mp4", "vid3.mp4"]

To use:

piplayer --project PROJECTFILE.yaml

Required settings:

players is an array, containing at minimum a host and video entry.

host: the hostname or ip of the Pi on the local network

videos: the local path(s) to video files to be sent to the Pi
This can be a single video, an array, or a glob pattern (like myvids/*.mp4).

Optional settings:

The following settings are optional:

loop: should the playlist loop?
Can be true or false. Defaults to true.

random: play the videos in random order
Can be true or false. Defaults to false.

user: the username on the Pi
Defaults to pi.

gap: (TODO!) time in seconds to pause between each video (shows a black screen)
Defaults to 0.0.

start_at: (TODO!) start the playlist at a specific time.
Defaults to 0.0.

If you want to apply the same settings to all the Pi's, add a settings dictionary like so:

settings:
    user: cooluser 
    random: true
    gap: 2

These settings will be sent to all the Pi's listed in the players section (but individual player settings have precedence).

Metadata

Release files for piplayer 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for piplayer 0.1.1
File Size Uploaded Provenance
piplayer-0.1.1.tar.gz 3.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for piplayer 0.1.1
File Interpreter ABI Platform
piplayer-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 8.3 kB

Release files / piplayer-0.1.1.tar.gz

Download URL piplayer-0.1.1.tar.gz
Size 3.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ccabb57c5cd9644702e8dcdc955440091d090ade1127e4eb376cba121826570e
BLAKE2b-256 checksum
How to use checksums
03bca18aec64a83b519970e7cd93ac4febb1efe84b0c0d4e0df455d5d796acc4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Darwin/22.5.0

Release files / piplayer-0.1.1-py3-none-any.whl

Download URL piplayer-0.1.1-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1e4e4ec1968546b85468773e9f34ab21ce44b9bfea29d8667d07eecc478dc99c
BLAKE2b-256 checksum
How to use checksums
8c3d8bd8beb39623073f88b28a3fa8060e4ae59d4d799721996179033f1ee44f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.11.3 Darwin/22.5.0

Security for piplayer 0.1.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page