README.rst 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. =========
  2. larigira
  3. =========
  4. .. image:: https://travis-ci.org/boyska/larigira.svg?branch=master
  5. :target: https://travis-ci.org/boyska/larigira
  6. :alt: Build status
  7. .. image:: https://drone.degenerazione.xyz/api/badges/boyska/larigira/status.svg?branch=master
  8. :alt: Build status on self-managed CI server
  9. .. image:: https://img.shields.io/pypi/v/larigira.svg
  10. :target: https://pypi.python.org/pypi/larigira
  11. :alt: Latest Version
  12. About
  13. -------
  14. A radio automation based on MPD. Larigira will sit right to your mpd player and
  15. will keep your playlist never empty. It will also manage a db of "events", so
  16. that you can schedule shows, play jingles every X minutes, etc.
  17. Software stack
  18. ---------------
  19. * MPD, of course
  20. * python3.5 or greater
  21. - gevent as an async framework
  22. - flask to provide web interface and rpc
  23. * tinydb as an embedded database
  24. Why? (aka design features)
  25. --------------------------
  26. Reinventing a player is a bad idea. MPD provides an eccellent base.
  27. Separating the player from "action loops" makes it easy to work on this. For
  28. example, you can stop larigira for some minutes, and the audio will keep
  29. playing. It also means that you can easily replace specific parts of your radio
  30. automation.
  31. The "continous playing" part is separated from the "events" part. ``larigira``
  32. can be run to perform one, the other, or both.
  33. The "audio generation" part can be used separately by any script that you like.
  34. Installation
  35. -------------
  36. Just run ``python setup.py install``. It will, of course, also work in a
  37. virtualenv. Apart from running an MPD server, there is no additional setup.
  38. You will find some command in your PATH now; they all begin with ``larigira``,
  39. so the usual ``<TAB><TAB>`` is a good way to explore them ;)
  40. The name
  41. ---------
  42. larigira mai la sbaglia...
  43. -- https://www.youtube.com/watch?v=K9XJkOSSdEA