# 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/7e/98/22b0d3487539d44bfa9eefc4061e8dd57c6ed81b331bde030b9cef735933/lean_server-0.0.1.dev4.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.0.1.dev4",
"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": "c835ab4174ecbd7ea89381e9c35a5546801fddb81365612a3f140ea0d440d3c0",
"md5": "05122955d288ac40d403cd6590a660e0",
"sha256": "20a8324a8d0b38beb16e9663ada16a95acb4f03a6c4b4d1156d2b2615a24aefd"
},
"downloads": -1,
"filename": "lean_server-0.0.1.dev4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05122955d288ac40d403cd6590a660e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 13749,
"upload_time": "2025-08-09T03:19:27",
"upload_time_iso_8601": "2025-08-09T03:19:27.625978Z",
"url": "https://files.pythonhosted.org/packages/c8/35/ab4174ecbd7ea89381e9c35a5546801fddb81365612a3f140ea0d440d3c0/lean_server-0.0.1.dev4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7e9822b0d3487539d44bfa9eefc4061e8dd57c6ed81b331bde030b9cef735933",
"md5": "eea12937bd007224454c3d612d81cef3",
"sha256": "451d9db858f2e4b2b020c41923b7625825f47ac274fc82b1b18279cdef1b3273"
},
"downloads": -1,
"filename": "lean_server-0.0.1.dev4.tar.gz",
"has_sig": false,
"md5_digest": "eea12937bd007224454c3d612d81cef3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 11246,
"upload_time": "2025-08-09T03:19:29",
"upload_time_iso_8601": "2025-08-09T03:19:29.068525Z",
"url": "https://files.pythonhosted.org/packages/7e/98/22b0d3487539d44bfa9eefc4061e8dd57c6ed81b331bde030b9cef735933/lean_server-0.0.1.dev4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-09 03:19:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pufanyi",
"github_project": "lean-server",
"github_not_found": true,
"lcname": "lean-server"
}
JSON
