{ "info": { "author": "Paulo Mateus Moura da Silva (SrMouraSilva)", "author_email": "mateus.moura@hotmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Multimedia :: Sound/Audio" ], "description": "Pedal Pi - Application\n======================\n\n.. image:: https://travis-ci.org/PedalPi/Application.svg?branch=master\n :target: https://travis-ci.org/PedalPi/Application\n :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/pedalpi-application/badge/?version=latest\n :target: http://pedalpi-application.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. image:: https://codecov.io/gh/PedalPi/Application/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/PedalPi/Application\n :alt: Code coverage\n\n.. image:: https://landscape.io/github/PedalPi/Application/master/landscape.svg?style=flat\n :target: https://landscape.io/github/PedalPi/Application/master\n :alt: Code Health\n\nPedal Pi - Application is a framework for manager the Pedal Pi.\nThrough it is possible loads `Pedal Pi Components`_\nto provide a Human Machine Interface (HMI) or even have an opening for other software\nto consume the features of the Pedal Pi.\n\nThe components developed use the API (available through `Controllers `__) to manage the resources of the Pedal Pi.\n\n.. _Pedal Pi Components: https://github.com/PedalPi/Components\n\n**Documentation:**\n http://pedalpi-application.readthedocs.io/\n\n**Code:**\n https://github.com/PedalPi/Application\n\n**Python Package Index:**\n https://pypi.org/project/PedalPi-Application\n\n**License:**\n `Apache License 2.0`_\n\n.. _Apache License 2.0: https://github.com/PedalPi/Application/blob/master/LICENSE\n\n\nRunning Application\n-------------------\n\nFollowing are the steps required to set up and run Pedal Pi - Application.\n\nPrepare ambient\n***************\n\nInstall with pip\n\n.. code-block:: bash\n\n pip3 install PedalPi-Application\n\nCreate the script file that contains the code to run the application (as example ``start.py``)\n\n.. code-block:: python\n\n from application.application import Application\n\n application = Application(path_data=\"data/\", address='localhost')\n\n application.start()\n\n from signal import pause\n try:\n pause()\n except KeyboardInterrupt:\n application.stop()\n\nDownload, compile and install `mod-host`_. Mod-host is a *LV2 host for Jack controllable via socket or command line*.\nIt is developed by `Mod Devices`_, a company that also develops professional equipment for musicians.\n\n.. _mod-host: https://github.com/moddevices/mod-host\n.. _Mod Devices: https://moddevices.com/\n\n.. code-block:: bash\n\n git clone https://github.com/moddevices/mod-host\n cd mod-host\n make\n make install\n\nRun Application\n***************\n\nStart audio process. The required settings for your audio card can vary greatly.\nI recommend that you try different possibilities in order to minimize the latency and number of *xruns*.\n\nIf you do not have any experience with JACK, is recommend the lecture of\n`Demystifying JACK \u2013 A Beginners Guide to Getting Started with JACK`_ from **Linux Music Production**.\n\n.. _Demystifying JACK \u2013 A Beginners Guide to Getting Started with JACK: http://libremusicproduction.com/articles/demystifying-jack-%E2%80%93-beginners-guide-getting-started-jack\n\n.. code-block:: bash\n\n # In this example, is starting a Zoom g3 series audio interface\n jackd -R -P70 -t2000 -dalsa -dhw:Series -p256 -n3 -r44100 -s &\n mod-host &\n\nFinally, start the application\n\n.. code-block:: bash\n\n python3 start.py\n\n\nExtending\n---------\n\nIt's possible add or extends the Pedal Pi with addiction of `Component`. A component can\nprovides a Human Machine Interface (HMI) - like `Raspberry P0`_ - or even have an opening for other software\nto consume the features of the Pedal Pi - like `WebService`_ plugin.\n\nSee the `github Components Project`_ for complete components list.\n\nTo add a component in your configuration file, download it and register it before starting the application (``application.start()``):\n\n.. code-block:: bash\n\n pip3 install PedalPi-\n\n.. code-block:: python\n\n from application.Application import Application\n application = Application(path_data=\"data/\", address='localhost')\n\n # Loading component\n from raspberry_p0.raspberry_p0 import RaspberryP0\n application.register(RaspberryP0(application))\n\n # Start application\n application.start()\n\n # Don't stop application\n from signal import pause\n try:\n pause()\n except KeyboardInterrupt:\n # Stop components with safety\n application.stop()\n\nEach component needs a configuration to work.\nPay attention to your documentation for details on how to set it up and use it.\n\n.. _github Components Project: https://github.com/PedalPi/Components\n.. _Raspberry P0: https://github.com/PedalPi/Raspberry-P0\n.. _WebService: https://github.com/PedalPi/WebService\n\n\nDelegating audio processing to other equipment\n----------------------------------------------\n\nThe connection with `mod-host`_ is over `TCP`_. So it's possible to place a\nmachine to perform the processing and another to provide the control services.\n\nFor example, you have a **Raspberry Pi B+** and a **PC**.\n * The PC in http://10.0.0.100 will process the audio, then it will execute `jack` process,\n `mod-host` process and the audio interface will be connected to it.\n * The *RPi* will executes `Application` with `Component`, like `Raspberry P0 component`_.\n Raspberry P0 disposes a simple current pedalboard control.\n\n.. code-block:: python\n\n application = Application(path_data=\"data/\", address='10.0.0.100')\n\n.. _Raspberry P0 component: https://github.com/PedalPi/Raspberry-P0\n.. _TCP: https://en.wikipedia.org/wiki/Transmission_Control_Protocol\n\nCreating a component\n--------------------\n\nSubsequently will be added details in the documentation on how to create a component for the Pedal Pi.\nFor now, you can check the blog post `Building a Pedal Pi Component - Pedalboard selector`_\n\n.. _Building a Pedal Pi Component - Pedalboard selector: https://pedalpi.github.io/blog/building-a-pedal-pi-component-pedalboard-selector.html\n\nMaintenance\n-----------\n\nTest\n****\n\nThe purpose of the tests is:\n\n* Check if the notifications are working, since the module plugins manager is responsible for testing the models;\n* Serve as a sample basis.\n\n.. code-block:: bash\n\n make test\n make test-details\n\nGenerate documentation\n**********************\n\nThis project uses `Sphinx`_ + `Read the Docs`_.\n\nYou can generate the documentation in your local machine:\n\n.. code-block:: bash\n\n make install-docs-requirements\n make docs\n\n make docs-see\n\n.. _Sphinx: http://www.sphinx-doc.org/\n.. _Read the Docs: http://readthedocs.org\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/PedalPi/Application", "keywords": "pedal-pi mod-host lv2 audio plugins-manager", "license": "Apache Software License v2", "maintainer": "", "maintainer_email": "", "name": "PedalPi-Application", "package_url": "https://pypi.org/project/PedalPi-Application/", "platform": "Linux", "project_url": "https://pypi.org/project/PedalPi-Application/", "project_urls": { "Homepage": "https://github.com/PedalPi/Application" }, "release_url": "https://pypi.org/project/PedalPi-Application/0.4.1/", "requires_dist": null, "requires_python": "", "summary": "Framework for manager the Pedal Pi", "version": "0.4.1" }, "last_serial": 3673861, "releases": { "0.2.0": [ { "comment_text": "", "digests": { "md5": "e7116e9e21a5e1eeb43d27dd9b148501", "sha256": "4267c10215b991c4e66f9b6a5f8db89e917b7d3c60af7c7da2af476c8139295d" }, "downloads": -1, "filename": "PedalPi-Application-0.2.0.tar.gz", "has_sig": false, "md5_digest": "e7116e9e21a5e1eeb43d27dd9b148501", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20834, "upload_time": "2017-05-12T16:51:07", "url": "https://files.pythonhosted.org/packages/86/22/2fc1e8dd19497883a205750f695119b0ed93f4a3240adb6426bc5dda9c4d/PedalPi-Application-0.2.0.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "95e66d19d6eda570cf76ff92b7918dc0", "sha256": "69d6663fe2e45413f9a3f1af194cadd8eeaccc80d051ce0752ecace39f568d63" }, "downloads": -1, "filename": "PedalPi-Application-0.2.1.tar.gz", "has_sig": false, "md5_digest": "95e66d19d6eda570cf76ff92b7918dc0", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20818, "upload_time": "2017-05-14T11:21:50", "url": "https://files.pythonhosted.org/packages/d5/e2/530d018cdac4260737d9403dc3124570491374bada7a052d0890010488b1/PedalPi-Application-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "9275b1748cad0941e319e304dc9a9937", "sha256": "70362e0267158ffecd05282585411e687167947a57fe3bcbe62f07a1211fad86" }, "downloads": -1, "filename": "PedalPi-Application-0.3.0.tar.gz", "has_sig": false, "md5_digest": "9275b1748cad0941e319e304dc9a9937", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18077, "upload_time": "2017-05-30T13:41:02", "url": "https://files.pythonhosted.org/packages/63/ba/80b56af4f10e8d462fc3d1e0402a206ec1d2c2bae2d04df50523d66ae6f8/PedalPi-Application-0.3.0.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "2ceeb4457f66efac9cfa44f1906ebc4a", "sha256": "bed15d76907cbcc344daa5093d4d82b8428e75688a2e30da504a2ea6be955a19" }, "downloads": -1, "filename": "PedalPi-Application-0.4.0.tar.gz", "has_sig": false, "md5_digest": "2ceeb4457f66efac9cfa44f1906ebc4a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18144, "upload_time": "2018-02-18T16:10:28", "url": "https://files.pythonhosted.org/packages/e8/25/9da78c954027e1aec5414f0629e752d39f27ad28423cdb1cbcf996667349/PedalPi-Application-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "cddc5903f4ffa466964365d0cdb45685", "sha256": "9942999c37cdd960f287f7ea68ae87a3d33a39f866abe56f82f1f6b33211d23e" }, "downloads": -1, "filename": "PedalPi-Application-0.4.1.tar.gz", "has_sig": false, "md5_digest": "cddc5903f4ffa466964365d0cdb45685", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18160, "upload_time": "2018-03-15T19:31:03", "url": "https://files.pythonhosted.org/packages/ca/c7/de40857b9f70cbc0a1e488261e7471fd58c962dec006aba97d9192d45a95/PedalPi-Application-0.4.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "cddc5903f4ffa466964365d0cdb45685", "sha256": "9942999c37cdd960f287f7ea68ae87a3d33a39f866abe56f82f1f6b33211d23e" }, "downloads": -1, "filename": "PedalPi-Application-0.4.1.tar.gz", "has_sig": false, "md5_digest": "cddc5903f4ffa466964365d0cdb45685", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 18160, "upload_time": "2018-03-15T19:31:03", "url": "https://files.pythonhosted.org/packages/ca/c7/de40857b9f70cbc0a1e488261e7471fd58c962dec006aba97d9192d45a95/PedalPi-Application-0.4.1.tar.gz" } ] }