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.1-cp37-abi3-win_amd64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d594682452ea01f7be36b6bb36d7deb350751967e88b4e03806f0f9adbc5f62a |
|
MD5 | 634b72a99ac3f2c2e2cb5dd265352b1d |
|
BLAKE2b-256 | 5af91a911c5ec0942f13d6b77a14a3121b30b1e96dc64d37d924325191a47196 |
Hashes for cvldoc_parser-1.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 499022568ee84fc094301fd4849741a6725f13846638f6e8474a11336fd809ab |
|
MD5 | 76ff6f7bddad50869cc1035bc0aaf061 |
|
BLAKE2b-256 | e0bff00e4c0b27071d04cee04d3b1230bc4fa6ddc22178668d2f42438f6858ff |
Hashes for cvldoc_parser-1.0.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c588e426134c39f2f25c6dbf7d15462d67fb0b20b5626cb1e3e2bd10aaad76b0 |
|
MD5 | 78d07fe888d46c49122455ea42a369bd |
|
BLAKE2b-256 | c3c6ee9c11d24440855b1c2e27f84434d8890380740a82bc7647f3f4311a7460 |