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-2.0.0b2-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95aad85f9cb761874c6092d794973adbddabbf098b1c51dee2c70bf817881a50 |
|
MD5 | 55802567a9996a9d5eebb58f32d15bd0 |
|
BLAKE2b-256 | 1da06d4aaa0fed8ae2cb265cbce07167418115a32c7572027111a8658c8cf511 |
Hashes for cvldoc_parser-2.0.0b2-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c77702002245bbfd652a5e311323ba54664b95f9fa5e750a469fa57cf63f94cd |
|
MD5 | 3e0730ae89a4f9076da3a2d9be5750e5 |
|
BLAKE2b-256 | ebcc10aa0b3fd75601f456fdd57c1616a07c7da1d55f34df0f451ce33e1837eb |
Hashes for cvldoc_parser-2.0.0b2-cp37-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 226372ed54a18f96e316b2a644e3ddcb462985ffc47d24210960e60398af6dcf |
|
MD5 | dfc8026b0bb948c5e2c838d004403a7e |
|
BLAKE2b-256 | b0edbea5101bc9c0d685b8f464b830eeebec772f8b5a75485fef338a16735930 |