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.
Metadata
Release files for cvldoc-parser 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cvldoc_parser-1.0.1-cp37-abi3-win_amd64.whl | CPython 3.7 | abi3 | Windows x86-64 | Details for cvldoc_parser-1.0.1-cp37-abi3-win_amd64.whl |
| cvldoc_parser-1.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.7 | abi3 | Linux glibc 2.17+ x86-64 | Details for cvldoc_parser-1.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
| cvldoc_parser-1.0.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl | CPython 3.7 | abi3 | macOS 10.9+ universal2 (ARM64, x86-64), macOS 11.0+ ARM64, macOS 10.9+ x86-64 | Details for cvldoc_parser-1.0.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl |
Total release size: 13.7 MB
Release files / cvldoc_parser-1.0.1-cp37-abi3-win_amd64.whl
| Download URL | cvldoc_parser-1.0.1-cp37-abi3-win_amd64.whl |
|---|---|
| Size | 733.9 kB |
| Tags | CPython 3.7 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
d594682452ea01f7be36b6bb36d7deb350751967e88b4e03806f0f9adbc5f62a
|
|
BLAKE2b-256 checksum How to use checksums |
5af91a911c5ec0942f13d6b77a14a3121b30b1e96dc64d37d924325191a47196
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.7
|
Release files / cvldoc_parser-1.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | cvldoc_parser-1.0.1-cp37-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 10.1 MB |
| Tags | CPython 3.7 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
499022568ee84fc094301fd4849741a6725f13846638f6e8474a11336fd809ab
|
|
BLAKE2b-256 checksum How to use checksums |
e0bff00e4c0b27071d04cee04d3b1230bc4fa6ddc22178668d2f42438f6858ff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.7
|
Release files / cvldoc_parser-1.0.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl
| Download URL | cvldoc_parser-1.0.1-cp37-abi3-macosx_10_9_x86_64.macosx_11_0_arm64.macosx_10_9_universal2.whl |
|---|---|
| Size | 2.9 MB |
| Tags | CPython 3.7 abi3 macOS 10.9+ universal2 (ARM64, x86-64) macOS 10.9+ x86-64 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c588e426134c39f2f25c6dbf7d15462d67fb0b20b5626cb1e3e2bd10aaad76b0
|
|
BLAKE2b-256 checksum How to use checksums |
c3c6ee9c11d24440855b1c2e27f84434d8890380740a82bc7647f3f4311a7460
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.7
|
Security for cvldoc-parser 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.