| Name | lean-server JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | A FastAPI-based server to interact with the Lean Theorem Prover. |
| upload_time | 2025-08-11 11:39:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT |
| keywords |
lean
lean-server
theorem prover
fastapi
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Lean Server Package
This package contains the core `lean-server` application, a FastAPI-based server that provides a REST API for interacting with the Lean prover.
## 📖 Overview
The server is designed to be run inside the Docker environment provided at the root of this monorepo. It exposes endpoints to perform proof checking and other Lean-related tasks.
The main API endpoint is:
- `POST /prove/check`: Accepts a `proof` and an optional `config` to run a proof.
## ⚙️ Configuration
The server's behavior can be configured via `config.yaml`. Key settings include:
- Server host and port.
- Lean process configuration.
- Proof checking timeouts.
## 🚀 Running the Server
This package is intended to be run within the development container.
1. **Navigate to the Dev Container**:
Follow the instructions in the [root README](../../README.md) to set up the development environment.
2. **Install Dependencies**:
In the container's terminal, install the package in editable mode:
```bash
uv pip install -e .
```
(Note: The root setup installs this automatically).
3. **Start the Server**:
The `pyproject.toml` file defines a script entry point. You can start the server with the following command:
```bash
lean-server
```
By default, it should be available at `http://localhost:8000`.
Raw data
{
"_id": null,
"home_page": null,
"name": "lean-server",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "lean, lean-server, theorem prover, fastapi",
"author": null,
"author_email": "Pu Fanyi <FPU001@e.ntu.edu.sg>",
"download_url": "https://files.pythonhosted.org/packages/1e/bf/966645e873f6175384736a7eff8a8b1f561a6d0e2e0416532850ea892b74/lean_server-0.1.0.tar.gz",
"platform": null,
"description": "# Lean Server Package\n\nThis package contains the core `lean-server` application, a FastAPI-based server that provides a REST API for interacting with the Lean prover.\n\n## \ud83d\udcd6 Overview\n\nThe server is designed to be run inside the Docker environment provided at the root of this monorepo. It exposes endpoints to perform proof checking and other Lean-related tasks.\n\nThe main API endpoint is:\n- `POST /prove/check`: Accepts a `proof` and an optional `config` to run a proof.\n\n## \u2699\ufe0f Configuration\n\nThe server's behavior can be configured via `config.yaml`. Key settings include:\n- Server host and port.\n- Lean process configuration.\n- Proof checking timeouts.\n\n## \ud83d\ude80 Running the Server\n\nThis package is intended to be run within the development container.\n\n1. **Navigate to the Dev Container**:\n Follow the instructions in the [root README](../../README.md) to set up the development environment.\n\n2. **Install Dependencies**:\n In the container's terminal, install the package in editable mode:\n ```bash\n uv pip install -e .\n ```\n (Note: The root setup installs this automatically).\n\n3. **Start the Server**:\n The `pyproject.toml` file defines a script entry point. You can start the server with the following command:\n ```bash\n lean-server\n ```\n By default, it should be available at `http://localhost:8000`.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A FastAPI-based server to interact with the Lean Theorem Prover.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/pufanyi/lean-server",
"Repository": "https://github.com/pufanyi/lean-server"
},
"split_keywords": [
"lean",
" lean-server",
" theorem prover",
" fastapi"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1b5758772c3184a3a02a5ea5a02b84d45c72762d45712574640df4765daa88a6",
"md5": "1a021f619994a928f0f4baeade823ac0",
"sha256": "51c95922821509f05a0923f2da8cf36c43cc1b2c0b1eac8a3a4535145dff6e3c"
},
"downloads": -1,
"filename": "lean_server-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1a021f619994a928f0f4baeade823ac0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 18527,
"upload_time": "2025-08-11T11:39:35",
"upload_time_iso_8601": "2025-08-11T11:39:35.630086Z",
"url": "https://files.pythonhosted.org/packages/1b/57/58772c3184a3a02a5ea5a02b84d45c72762d45712574640df4765daa88a6/lean_server-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1ebf966645e873f6175384736a7eff8a8b1f561a6d0e2e0416532850ea892b74",
"md5": "c0662f26d42f9e32e4c4092bc63758b0",
"sha256": "d885df3e0a0bcd85aa095c2b9b8ce0e134bacbf37b65977b1b8bb5e9b646ae59"
},
"downloads": -1,
"filename": "lean_server-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "c0662f26d42f9e32e4c4092bc63758b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 15041,
"upload_time": "2025-08-11T11:39:37",
"upload_time_iso_8601": "2025-08-11T11:39:37.155481Z",
"url": "https://files.pythonhosted.org/packages/1e/bf/966645e873f6175384736a7eff8a8b1f561a6d0e2e0416532850ea892b74/lean_server-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-11 11:39:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pufanyi",
"github_project": "lean-server",
"github_not_found": true,
"lcname": "lean-server"
}
