.. image:: _static/logo.png
   :align: center

.. rst-class:: centered

S-expression toolkit for Python
=======================================

.. image:: https://travis-ci.org/IwoHerka/sexpr.svg?branch=master
   :target: https://travis-ci.org/IwoHerka/sexpr

.. image:: https://coveralls.io/repos/github/IwoHerka/sexpr/badge.svg?branch=master
   :target: https://coveralls.io/github/IwoHerka/sexpr?branch=master

.. image:: https://api.codacy.com/project/badge/Grade/dc96c6c6dc5141c4ba956bedb35c120f
   :target: https://www.codacy.com/app/IwoHerka/sexpr?utm_source=github.com&utm_medium=referral&utm_content=IwoHerka/sexpr&utm_campaign=Badge_Grade

.. image:: https://api.codeclimate.com/v1/badges/bd380c4f4a9848a87a20/maintainability
   :target: https://codeclimate.com/github/IwoHerka/sexpr/maintainability

**sexpr** is small and compact toolkit for working with
s-expressions_ in Python. It provides:

1. Meta-syntax notation for grammar definition in YAML (similar to EBNF).
2. Validation of s-expressions against defined grammar.
3. Small and simple manipulation and rewriting framework.

Want to get a feel for it? Check out README_ on GitHub.
And when you're ready, have a look at the documentation.

.. _s-expressions: https://en.wikipedia.org/wiki/S-expression
.. _README: https://github.com/IwoHerka/sexpr

Documentation
-------------

Those articles will guide you through all of the library's usage patterns.

.. toctree::
    :maxdepth: 2

    quickstart
    defining_grammar
    loading_grammar
    verifing_expressions
    manipulating_expressions
    utilities

API Reference
-------------

If you are looking for information on a specific function, class, or
method, this part of the documentation is for you.

.. toctree::

    api

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`