Metadata-Version: 2.0
Name: xparser
Version: 0.0.4rc0
Summary: An XResources parser for python applications.
Home-page: https://github.com/taesko/xparser
Author: Antonio Todorov
Author-email: taeskow@gmail.com
License: MIT
Keywords: parser XResources
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Framework :: Pytest
Requires-Python: >=3.6.0

XParser
=======

A very simple python library for parsing XResources.

Example Usage
~~~~~~~~~~~~~

.. code:: python

    import xrp
    result = xrp.parse_file('.Xresources')
    result.resources['*foreground'] == '#FFFFFF'
    result.resources.x_statement('*foreground').value == 'white'
    result.definitions['white'] == '#FFFFFF'

Installation
~~~~~~~~~~~~

Install stable versions from PyPi

.. code:: bash

    pip install xparser

and development versions by cloning

.. code:: bash

    git clone https://github.com/taesko/xparser.git
    cd xparser && pip install .

Documentation
~~~~~~~~~~~~~

The two main entry points to the API are the ``parse`` and
``parse_file`` functions in the ``xrp`` package

They both return an xrp.views.XFileView object, which has ``resources``
and ``definitions`` attributes with dict-like interface for accessing
the parsed data.

No designated docs are written yet (but are planned to be) - use help()
on the xrp.views.XFileView object for more information on usage.


