2024-04-11 12:37:58 -07:00
|
|
|
# PyPantograph
|
2024-04-19 16:47:35 -07:00
|
|
|
|
2024-04-11 12:37:58 -07:00
|
|
|
Python interface to the Pantograph library
|
2024-04-19 16:47:35 -07:00
|
|
|
|
|
|
|
## Getting started
|
2024-05-19 18:59:03 -07:00
|
|
|
Update submodule
|
|
|
|
``` bash
|
|
|
|
git submodule update --init
|
|
|
|
```
|
2024-05-24 22:42:32 -07:00
|
|
|
Install dependencies
|
|
|
|
```bash
|
|
|
|
poetry install
|
|
|
|
```
|
2024-04-19 16:47:35 -07:00
|
|
|
|
|
|
|
Execute
|
|
|
|
```bash
|
|
|
|
poetry build
|
|
|
|
```
|
2024-04-22 22:59:29 -07:00
|
|
|
To run server tests:
|
2024-04-19 16:47:35 -07:00
|
|
|
``` bash
|
|
|
|
python -m pantograph.server
|
2024-09-13 17:54:11 -07:00
|
|
|
python -m pantograph.search
|
2024-04-19 16:47:35 -07:00
|
|
|
```
|
2024-04-22 22:59:29 -07:00
|
|
|
The tests in `pantograph/server.py` also serve as simple interaction examples
|
2024-04-19 16:47:35 -07:00
|
|
|
|
2024-07-01 12:18:00 -07:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
See `examples/README.md`
|
2024-09-06 22:41:34 -07:00
|
|
|
|
|
|
|
## Referencing
|
|
|
|
|
|
|
|
```bib
|
|
|
|
@misc{pantograph,
|
|
|
|
title = "Pantograph, A Machine-to-Machine Interface for Lean 4",
|
|
|
|
author = {Aniva, Leni and Miranda, Brando and Sun, Chuyue},
|
|
|
|
year = 2024,
|
|
|
|
howpublished = {\url{https://github.com/lenianiva/PyPantograph}}
|
|
|
|
}
|
|
|
|
```
|