Developer Guide
===============

Installation
------------

EasyPlayer supports Python version 3.5 and newer.
Dependencies are listed in requirements files, the main dependencies are: 

* `Circuits`_ the asynchronous event driven framework, the application is based on
* `Circus`_ process manager that keeps the application running
* `Requests`_ http communication with the remote web server
* `psutil`_ provides information about running processes

.. _Circuits: https://circuits.readthedocs.io/en/latest/index.html
.. _Circus: https://circus.readthedocs.io/en/latest/
.. _Requests: https://2.python-requests.org/en/master/
.. _psutil: https://psutil.readthedocs.io

System dependencies include:

* `cmus`_ audio player
* `OMXPlayer`_ video player for Raspberry Pi
* `fbi`_ framebuffer image viewer for Raspberry Pi

.. _cmus: https://cmus.github.io
.. _OMXPlayer: https://www.raspberrypi.org/documentation/raspbian/applications/omxplayer.md
.. _fbi: https://www.raspberrypi-spy.co.uk/2017/02/how-to-display-images-on-raspbian-command-line-with-fbi/



Configuration
-------------

Configuration options can be given on command line or stored in a config file.

.. argparse::
   :module: easyplayer.config
   :func: add_arguments
   :prog: easyplayer/run.py
   :passparser: