No project description provided
Project description
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.
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.
Source Distributions
Built Distributions
Hashes for cvldoc_parser-1.0.0-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cb1ff89b2bce13994ac0c10678577f64d198b40a5f92cdcb2067f72d9c1f059 |
|
MD5 | f40c57f37233fbea4a2af3f1c4c6dce8 |
|
BLAKE2b-256 | 1b19de3d545984914b21a5a4fa4f577dd23d748bfa5279db84849218aa32c942 |
Hashes for cvldoc_parser-1.0.0-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce710e3d09e94ca24ef90de82d35ae99bc83921f79ca98ad53906b0dc07e9b4e |
|
MD5 | 52ad1253b0c6597a0d3977ae8c551766 |
|
BLAKE2b-256 | d75393249d4033c3615389c9c49219d126576e27989d5c23bdc74b1aeec1eedc |
Hashes for cvldoc_parser-1.0.0-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 03c12c0286c449427ea2a95f8a43fbc44dd8d0e31e3e34cdacca5f19e8ad4139 |
|
MD5 | e0ab2875ff97ff4bb840c5ec7a3d40b7 |
|
BLAKE2b-256 | f59036d6f5c28f5ce70f1ee049e14dd49ced95143b5b30cb14243121e75269de |