pygccxml
========

.. image:: https://travis-ci.org/gccxml/pygccxml.svg?branch=master
    :target: https://travis-ci.org/gccxml/pygccxml
    :alt: Unit tests status
.. image:: https://coveralls.io/repos/gccxml/pygccxml/badge.svg?branch=master
    :target: https://coveralls.io/r/gccxml/pygccxml?branch=master
    :alt: Code coverage status
.. image:: https://readthedocs.org/projects/pygccxml/badge/?version=master
    :target: http://pygccxml.readthedocs.io/en/master/?badge=master
    :alt: Documentation status

pygccxml is a specialized XML reader that reads the output from CastXML or GCCXML. It provides a simple framework to navigate C++ declarations, using Python classes.

Install
-------

Install instructions can be found `here <http://pygccxml.readthedocs.io/en/master/install.html>`_.

Documentation and examples
--------------------------

The documentation can be found `here <http://pygccxml.readthedocs.io>`_, examples can be found `here <http://pygccxml.readthedocs.io/en/master/examples.html>`_.

A `FAQ <http://pygccxml.readthedocs.io/en/master/faq.html>`_ is also available and may answer some of your questions.

Contact us
----------

You can contact us through the `CastXML mailing list <http://public.kitware.com/mailman/listinfo/castxml/>`_.

For issues with pygccxml you can open an issue `here <https://github.com/gccxml/pygccxml/issues/>`_.

Branches
--------

The stable version can be found on the master branch.

The develop branch contains the latest improvements but can be unstable. Pull Requests should be done on the develop branch.

Testing and code coverage
-------------------------

pygccxml has more than 200 unit tests. They are run after each code commit to ensure
that the code stays functional and stable. You can find the builds `here <https://travis-ci.org/gccxml/pygccxml/builds>`_.

Code coverage is also available. It is automatically updated after each commit and can be found `here <https://coveralls.io/r/gccxml/pygccxml>`_.
