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

lean_server-0.1.0.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

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

lean_server-0.1.0-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file lean_server-0.1.0.tar.gz.

File metadata

  • Download URL: lean_server-0.1.0.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.5

File hashes

Hashes for lean_server-0.1.0.tar.gz
Algorithm Hash digest
SHA256 d885df3e0a0bcd85aa095c2b9b8ce0e134bacbf37b65977b1b8bb5e9b646ae59
MD5 c0662f26d42f9e32e4c4092bc63758b0
BLAKE2b-256 1ebf966645e873f6175384736a7eff8a8b1f561a6d0e2e0416532850ea892b74

See more details on using hashes here.

File details

Details for the file lean_server-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for lean_server-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 51c95922821509f05a0923f2da8cf36c43cc1b2c0b1eac8a3a4535145dff6e3c
MD5 1a021f619994a928f0f4baeade823ac0
BLAKE2b-256 1b5758772c3184a3a02a5ea5a02b84d45c72762d45712574640df4765daa88a6

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