README.rst 1.4 KB

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