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.dev4.tar.gz (8.5 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.dev4-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for lmms_lean_server-0.0.1.dev4.tar.gz
Algorithm Hash digest
SHA256 c6fbf1ee7828d1aefd6cc288ebec60f4b79718aee2e68f5ec582519b17268753
MD5 2d09f6f3ce881a2b74fa9ba617f91705
BLAKE2b-256 4ff2ae63dd6d39c4f891d669beed57d30cdf0691787f68764eafb71fd2da7aef

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for lmms_lean_server-0.0.1.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 c825cc2f5a537e5e670d2e8992190eece249e50e81ca9a44464f19ae2723ddec
MD5 7277710bb5b0471744c25d79ac3939c3
BLAKE2b-256 53faead69cc4b1f3198eebcade2325bbe5c7ee6839196df6ac1fcb58cfd65238

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