cvldoc-parser 1.0.1

No project description provided

CVLDoc Parser: Python module

Exposes a Python API for the CVLDoc module. WIP.

Usage

First, make sure Rust 1.62 or newer is installed. Clone the entire repo, then from the project base:

$ cd src/python_wrapper
$ python -m venv .env
$ source .env/bin/activate
$ pip install maturin

It creates a virtual environment for development, and should only be done once. Now, while the .env is sourced, it is possible to run

$ maturin build

in order to build the module, which can then be used in the virtualenv or installed globally with pip install {generated .whl file}. It is also possible to run maturin develop in order to generate a temporary module.

It is now possible to import the module:

$ python
>>> import cvldoc_parser

API

Currently exposes a single function, cvldoc_parser.parse(paths). It takes a list of file paths as strings, and returns a list of parsed CVLDoc objects for each path. A parsed CVLDoc object is either a Documentation or a FreeForm. They both support a diagnostics() method, that returns a list of warnings or errors associated with that object.