Augemented pandas for tracking JSON metadata
Project description
antlr4-vba-parser
Navigate antlr VBA Parse Trees in python.
Installation
antlr4_vba_parser itself is a pure python package, but depends on pandas and the SciPy
stack. Note: It optionally uses geopandas as well, which is often difficult
to install without conda
.
To install, simply try:
pip install antlr4_vba_parser
Development
To set up a development environment, first create either a new virtual or conda environment before activating it and then run the following:
git clone https://github.com/Liam-Deacon/antlr4-vba-parser
cd antlr4-vba-parser
pip install -r requirements-dev.txt requirements-test.txt -r requirements.txt
pip install -e .
This will install the package in development mode. Note that is you have forked the repo then change the URL as appropriate.
Documentation
Documentation can be found within the docs/
directory. This project
uses sphinx to autogenerate API documentation by scraping python docstrings.
To generate the HTML documentation, simply do the following:
cd docs
make html
PDF generation
PDF documentation is currently only supported on Ubuntu systems, but needs additional packages to run. These can be installed by:
cd docs
chmod +x setup.sh
./setup.sh
PDFs can then be created with make pdf
from within the docs/
directory.
Contribution Guidelines
Contributions are extremely welcome and highly encouraged. To help with consistency please can the following areas be considered before submitting a PR for review:
- Use
autopep8 -a -a -i -r .
to run over any modified files to ensure basic pep8 conformance, allowing the code to be read in a style expected for most python projects. - New or changed functionality should be tested, running
pytest
should - Try to document any new or changed functionality. Note: this project uses numpydoc for it's docstring documentation style.
License
Released under the MIT license.
TODO
This package is mostly a proof of concept and as such there are a number of areas to add to, fix and improve.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.