# pygccxml

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

Using pygccxml you can:

- Parse C++ source code

- Create a code generator

- Generate UML diagrams

- Build code analyzers

- …

## Installation

Installation instructions can be found here: Installation

## Compatibility

pygccxml is compatible with Python 2.7, 3.4, 3.5, pypy and pypy3.

## Documentation and examples

The examples are a good way to learn how to use pygccxml.

If you want to know more about the API provided by pygccxml, read the query interface document or the API documentation.

A FAQ is also available and may answer some of your questions.

## License

Boost Software License

## Contact us

You can contact us through the CastXML mailing list.

For issues with pygccxml you can open an issue here.

## 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.

## Test environment

You can find the Mac and Linux builds here. The Windows builds are located here.

Running the test suite is done with:

    python3 -m unittests.test_all

Code coverage is also available. It is automatically updated after each commit and can be found here.

## Documentation contents

- Download & Install
- Examples
- FAQ
- API
- Building the documentation
- Declarations query API
- Design overview
- Who is using pygccxml?
- C++ Reflection
- Releasing
- History and Credits
- GCC-XML 0.7 → 0.9 upgrade issues (Legacy)

## Indices and tables

- Index

- Module Index

- Search Page