Skip to main content

A FastAPI-based server to interact with the Lean Theorem Prover.

Project description

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 to set up the development environment.

  2. Install Dependencies: In the container's terminal, install the package in editable mode:

    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:

    lean-server
    

    By default, it should be available at http://localhost:8000.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lmms_lean_server-0.0.1.dev2.tar.gz (8.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

lmms_lean_server-0.0.1.dev2-py3-none-any.whl (10.2 kB view details)

Uploaded Python 3

File details

Details for the file lmms_lean_server-0.0.1.dev2.tar.gz.

File metadata

File hashes

Hashes for lmms_lean_server-0.0.1.dev2.tar.gz
Algorithm Hash digest
SHA256 ba3446e8bab12a1b47aecf108522117a9534fe4c053f3674df3efec70941c920
MD5 776c6ecb2c477130bc5eb53088377370
BLAKE2b-256 121d626938c30673e503f0b79f875f5ac73774eed696afe51a2566bb9a7a82a5

See more details on using hashes here.

File details

Details for the file lmms_lean_server-0.0.1.dev2-py3-none-any.whl.

File metadata

File hashes

Hashes for lmms_lean_server-0.0.1.dev2-py3-none-any.whl
Algorithm Hash digest
SHA256 4365b9a6caa0053f543ec6c560ce2e505fb33c95fd9179196b064440cfcf9581
MD5 acd1ca46d0b5a54bfb9e20089b2c13c0
BLAKE2b-256 d1f9c8efb387384fffae20f40139fbd9aa7b789bc00960eb3eaaabe0ced0fef1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page