PyPI version Anaconda version CircleCI Documentation Status codecov Binder

Python client for Isabelle server

isabelle-client is a TCP client for Isabelle server. For more information about the server see part 4 of the Isabelle system manual.

How to Install

The best way to install this package is to use pip:

pip install isabelle-client

Another option is to use Anaconda:

conda install -c conda-forge isabelle-client

One can also download and run the client together with Isabelle in a Docker contanier:

docker build -t isabelle-client https://github.com/inpefess/isabelle-client.git
docker run -it --rm -p 8888:8888 isabelle-client jupyter-lab --ip=0.0.0.0 --port=8888 --no-browser

How to use

Follow the usage example from documentation, run the script, or use isabelle-client from a notebook, e.g. with Binder.

How to Contribute

Pull requests are welcome. To start:

git clone https://github.com/inpefess/isabelle-client
cd isabelle-client
# activate python virtual environment with Python 3.6+
pip install -U pip
pip install -U setuptools wheel poetry
poetry install
# recommended but not necessary
pre-commit install

To check the code quality before creating a pull request, one might run the script local-build.sh. It locally does nearly the same as the CI pipeline after the PR is created.

Reporting issues or problems with the software

Questions and bug reports are welcome on the tracker.

More documentation

More documentation can be found here.

Video example

(if not displayed correctly on this page, please watch here).

How to cite

If you’re writing a research paper, you can cite Isabelle client (and Isabelle 2021) using the following DOI.

Indices and tables