C eXtract Metadata
A python CLI and library to extract meta-data from Cxx style languages.
Running
pip install cxmeta
cxmeta <directory or file>
cxmeta will create an _output directory next to your source files with the generated markdown document
- TODO: document the .cxmeta file
- TODO: document single vs multi-module files
- TODO: work on meta-data extraction
- TODO: work on styling extensions
Description
This is not intended to be a full AST style exploration for static analysis.
Instead, the goal is to pull embedded metadata and accompanying declarations from the code in order to support tasks such as DRY documentation.
C source | meta-data | Markdown/rST documentation
I couldn't find any tools that made this process simple and effective. Initially I built a very small python script that would pull very-specifically formatted headers into markdown. This process was heavily opinionated in it's formatting requirements and brittle and inflexible in implementation.
This new approach is to provide a more flexible and powerful processing pipeline for the code which exposes comments, statements and expressions into a stream which can extract metadata.
Additional meta-data rules at the end of the pipeline allow for rST authoring to make it simple for the source code author to export their types into simple and attractive documentation.
Contributing
Pull requests welcome!
Make sure you run lint (./run_lint.sh)
vim, set makeprg=./run_link.sh, :make
Or figure out how to integrate in your IDE such as PyCharm!
Make sure you pass existing tests
tox
Add tests for new functionality
