This release is a pre-release and may not be stable for production use.
The pip distribution package pycoq provides two python packages:
-
serlib
-
pycoq
pycoq
pycoq is a python library that provides interface to Coq using the serialization coq-serapi https://github.com/ejgallego/coq-serapi
serlib
serlib is a python library providing s-expression parser implemented in C++
Install on Linux
Currently we support only the Linux platform.
External dependencies
opam
The pycoq calls opam package manager to install and run the coq-serapi and coq binaries.
The pycoq assumes that opam binary of version 2.* is in the $PATH.
On Ubuntu 20.04 install opam with sudo apt-get install opam.
See https://opam.ocaml.org/doc/Install.html for other systems.
strace
The pycoq calls strace to inspect the building of coq-projects to prepare the context. The pycoq assumes
that strace is in the $PATH.
On Ubuntu 20.04 install strace with sudo apt-get install strace.
See https://github.com/strace/strace for other systems.
Install from github
Assuming python>=3.8 and pip are in your python environment (we recommend to use conda or python venv) to install from github run
pip install git+https://github.com/IBM/pycoq
Test your setup
From your python environment with pycoq installed run
pytest --pyargs pycoq
Config pycoq
The location of the project directory, debug level and other parameters can be specified in the config file $HOME/.pycoq
Uninstall pycoq
From your python environment with pycoq installed run
pip uninstall pycoq
By default, pycoq uses directory $HOME/.local/share/pycoq to store temporary files such as the opam repository, project files and the logs.
To remove the project directory:
rm -fr $HOME/.local/share/pycoq
To remove the config file:
rm $HOME/.pycoq
Using pycoq
For basics see the example tutorial/tutorial_pycoq.py and the test scripts in pycoq/tests.
Build pycoq in Docker
Install docker, git clone the source repository and from the directory containing Dockerfile run
docker build -t pycoq:test .
to verify the setup and test of pycoq in docker container on linux
Metadata
Release files for pycoq 0.0.1a1.dev2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pycoq-0.0.1a1.dev2.tar.gz | 146.7 kB | Without provenance | Details for pycoq-0.0.1a1.dev2.tar.gz |
Release files / pycoq-0.0.1a1.dev2.tar.gz
| Download URL | pycoq-0.0.1a1.dev2.tar.gz |
|---|---|
| Size | 146.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d85a332266bc1d680b2494a52eb9cdae039c4618ea9d7e999da63bb00502b23
|
|
BLAKE2b-256 checksum How to use checksums |
bdfd63b2e88a2fc4c5cd9ba4bc7c21281ba322f140fb5cfd3c6920c995da5e34
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
|
Security for pycoq 0.0.1a1.dev2
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.