Metadata-Version: 2.0
Name: rpp
Version: 0.2
Summary: REAPER Project File Parser
Home-page: https://github.com/Perlence/rpp
Author: Sviatoslav Abakumov
Author-email: dust.harvesting@gmail.com
License: BSD
Download-URL: https://github.com/Perlence/rpp/archive/master.zip
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Text Processing
Requires-Dist: ply
Requires-Dist: attrs

RPP
===

Description
-----------

RPP is a format used to describe `REAPER <http://reaper.fm>`_ projects. This package is designed to be RPP
parser/emitter and uses `PLY <http://www.dabeaz.com/ply/>`_ as parser framework.


Examples
--------

Import the package:

.. code-block:: python

   >>> import rpp

Decode RPP:

.. code-block:: python

   >>> r = rpp.loads("""\
   <REAPER_PROJECT 0.1 "4.32" 1372525904
     RIPPLE 0
     GROUPOVERRIDE 0 0 0
     AUTOXFADE 1
   >
   """)
   >>> r
   Element(tag='REAPER_PROJECT', attrib=(Decimal('0.1'), '4.32', 1372525904), children=[
       Element(tag='RIPPLE', attrib=(0,), children=None),
       Element(tag='GROUPOVERRIDE', attrib=(0, 0, 0), children=None),
       Element(tag='AUTOXFADE', attrib=(1,), children=None)
   ])

Transform elements into RPP:

.. code-block:: python

   >>> from decimal import Decimal
   >>> from rpp import Element
   >>> rpp.dumps(
   ...     Element(tag='REAPER_PROJECT', attrib=(Decimal('0.1'), '4.32', 1372525904), children=[
   ...         Element(tag='RIPPLE', attrib=(0,), children=None),
   ...         Element(tag='GROUPOVERRIDE', attrib=(0, 0, 0), children=None),
   ...         Element(tag='AUTOXFADE', attrib=(1,), children=None),
   ...     ]))
   '<REAPER_PROJECT 0.1 4.32 1372525904\n  RIPPLE 0\n  GROUPOVERRIDE 0 0 0\n  AUTOXFADE 1\n>\n'

``Element`` mimics the interface of xml.etree.ElementTree.Element_. You can perform quering operations with ``findall``,
``find``, ``iterfind``. Note that attribute and text predicates are not supported.

.. _xml.etree.ElementTree.Element: https://docs.python.org/3/library/xml.etree.elementtree.html#xml.etree.ElementTree.Element

.. code-block:: python

   >>> r.find('.//GROUPOVERRIDE')
   Element(tag='GROUPOVERRIDE', attrib=(0, 0, 0), children=None)


Dependencies
------------

- `attrs <https://attrs.readthedocs.org/>`_
- `ply <http://www.dabeaz.com/ply/>`_


