Metadata-Version: 2.1
Name: pirateplayer
Version: 0.3.2
Summary: PiratePlayer is an offline player for Pirate Audio
Home-page: https://github.com/TestDotCom/pirateplayer
Author: TestDotCom
License: MIT
Keywords: raspberry,rpi,pirate audio,gstreamer,player
Platform: UNKNOWN
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Requires-Dist: rpi.gpio
Requires-Dist: gpiozero
Requires-Dist: spidev
Requires-Dist: numpy
Requires-Dist: st7789
Requires-Dist: pillow
Requires-Dist: mutagen
Requires-Dist: pygobject
Requires-Dist: pykka
Provides-Extra: lint
Requires-Dist: autopep8 ; extra == 'lint'
Provides-Extra: release
Requires-Dist: twine ; extra == 'release'
Requires-Dist: wheel ; extra == 'release'
Provides-Extra: test
Requires-Dist: pytest-xdist ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'

# PiratePlayer
While there are other good software for audio playing, none of them works fully offline (mopidy) or doesn't natively support GPIO buttons (omxplayer): PiratePlayer to the rescue!

![PiratePlayer demo](src/pirateplayer/assets/demo.png)

# HOW-TO use
while browsing menu:
>press A to scroll up  
>press B to scroll down  
>press X to select current file  
>press Y to go back  

while playing:
>press A to stop and go back to menu  
>press B to decrease volume  
>press X to play//pause  
>press Y to increase volume  

## Hardware needs
- Raspberry pi, a cheap model like the zero-w works fine
- Pimoroni's pirate-audio hat, or hack together some DIY
- (optional) 3.7v LiPo + 5v regulator or something like a LiPo shim

## Install deps
Install requirements for [gstreamer](https://gstreamer.freedesktop.org/documentation/installing/on-linux.html) and [hifiberry dac](https://www.hifiberry.com/docs/software/configuring-linux-3-18-x)

then make sure you have installed:
>gobject-introspection libgirepository1.0-dev libcairo2-dev

and enable GPIO SPI - check [RPiconfig](https://elinux.org/RPiconfig) if not sure how

## Setup dev environment
PiratePlayer runs with python >= 3.5

>$ virtualenv venv  
>$ . venv/bin/activate  
>$ pip3 install --editable .  
>$ pirateplayer

## Install as systemd service (from python module)
install pirateplayer from pip  
launch install.sh


