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.0.1.tar.gz (14.8 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.0.1-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lean_server-0.0.1.tar.gz
Algorithm Hash digest
SHA256 bc78a7e42c5a2c73ddd635a7dc46fa56180f0001513f21a9430cf6632b5560e0
MD5 3ae504c3c15cf8cb5ed866425eae06a0
BLAKE2b-256 07b55692d396dd20d871725d7783afc176dde7dfb776e1fbed26f5fa2258c046

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lean_server-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ef73f8c7e7754b1a90ecae7bca7539faf841f5100b370b660c4c3bc09b102a9
MD5 e6d4b4be53fc3acbf2261e3f06c9f65b
BLAKE2b-256 f548cfd3b415d46dd131b223e774ff138ff5f4471fd0f642055de9fb8f0cf371

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