lean-interact 0.5.3__tar.gz → 0.6.1__tar.gz

{lean_interact-0.5.3 → lean_interact-0.6.1}/.github/workflows/ci.yml

@@ -32,8 +32,8 @@ jobs:
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install .
+          pip install --upgrade pip
+          pip install . --group dev
 
       - name: Install Lean (Linux/macOS)
         if: runner.os != 'Windows'
@@ -60,3 +60,7 @@ jobs:
         run: python -m unittest discover -s ./tests
         env:
           PYTHONIOENCODING: utf-8
+
+      - name: Build documentation
+        if: runner.os == 'Linux'
+        run: mkdocs build

lean_interact-0.6.1/.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main # Default branch
+      - docs-test # Test branch for documentation
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'src/lean_interact/**'
+      - '.github/workflows/docs.yml'
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment
+concurrency:
+  group: 'pages'
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install . --group dev
+
+      - name: Install Lean
+        run: |
+          install-lean
+          echo "$HOME/.elan/bin" >> $GITHUB_PATH
+
+      - name: Build documentation
+        run: mkdocs build
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './site'
+
+  deploy:
+    if: github.ref == 'refs/heads/main'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

lean_interact-0.6.1/.github/workflows/update-changelog.yml

@@ -0,0 +1,33 @@
+name: Update Changelog
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  update-changelog:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Update Changelog
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          python docs/update_changelog.py --release-tag "${{ github.event.release.tag_name }}"
+
+      - name: Commit and push changelog
+        run: |
+          git config --local user.email "action@github.com"
+          git config --local user.name "GitHub Action"
+          git add docs/changelog.md
+          git commit -m "Update changelog with ${{ github.event.release.tag_name }} release notes"
+          git push origin ${GITHUB_REF_NAME}

{lean_interact-0.5.3 → lean_interact-0.6.1}/.gitignore

@@ -12,3 +12,6 @@ __pycache__
 
 sandbox*
 .vscode
+
+# Doc build
+site

{lean_interact-0.5.3 → lean_interact-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lean-interact
-Version: 0.5.3
+Version: 0.6.1
 Summary: LeanInteract is a Python package that allows you to interact with the Lean theorem prover.
 Author-email: Auguste Poiroux <auguste.poiroux@epfl.ch>
 License: MIT License
@@ -29,6 +29,7 @@ Keywords: Lean,REPL,autoformalization,theorem proving
 Requires-Python: >=3.10
 Requires-Dist: filelock>=3.18.0
 Requires-Dist: gitpython>=3.1.44
+Requires-Dist: packaging>=24.2
 Requires-Dist: psutil>=6.1.0
 Requires-Dist: pydantic>=2.11.1
 Requires-Dist: requests>=2.32.3
@@ -37,6 +38,7 @@ Description-Content-Type: text/markdown
 
 # LeanInteract
 
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://augustepoiroux.github.io/LeanInteract/)
 [![PyPI version](https://img.shields.io/pypi/v/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![PyPI downloads](https://img.shields.io/pepy/dt/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
@@ -49,8 +51,8 @@ Description-Content-Type: text/markdown
 - **🔗 Interactivity**: Execute Lean code and files directly from Python.
 - **🚀 Ease of Use**: LeanInteract abstracts the complexities of Lean setup and interaction.
 - **💻 Cross-platform**: Works on Windows, macOS, and Linux operating systems.
-- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.19.0`.
-  - We backport the latest features of Lean REPL to older versions of Lean.
+- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.21.0-rc3`.
+  - We backport the latest features of Lean REPL to older versions of Lean (see [fork](https://github.com/augustepoiroux/repl)).
 - **📦 Temporary Projects**: Easily instantiate temporary Lean environments.
   - Useful for experimenting with benchmarks depending on [Mathlib](https://github.com/leanprover-community/mathlib4) like [ProofNet#](https://huggingface.co/datasets/PAug/ProofNetSharp) and [MiniF2F](https://github.com/yangky11/miniF2F-lean4).
 
@@ -109,6 +111,8 @@ In the [`examples`](examples) directory, you will find a few scripts demonstrati
 
 ## Usage
 
+Full documentation is available [here](https://augustepoiroux.github.io/LeanInteract/).
+
 ### Basic example
 
 The following code will use the default Lean version (latest available):
@@ -460,7 +464,22 @@ Two versions of Lean servers are available:
 
 ### Custom Lean REPL
 
-To use a forked Lean REPL project, specify the git repository using the `repl_git` parameter in the `LeanREPLConfig`. Your fork should have a similar versioning format to <https://github.com/augustepoiroux/repl> (i.e. having a branch with commits for each Lean version). For assistance, feel free to contact [us](mailto:auguste.poiroux@epfl.ch).
+To use a forked Lean REPL project, specify the git repository using the `repl_git` parameter in the `LeanREPLConfig` and the target revision using the `repl_rev` parameter. For example:
+
+```python
+config = LeanREPLConfig(repl_rev="v4.21.0-rc3", repl_git="https://github.com/leanprover-community/repl", verbose=True)
+```
+
+> [!WARNING]
+>
+> Custom REPL implementations may have interfaces that are incompatible with LeanInteract's standard commands. If you encounter incompatibility issues, you can use the `run_dict` method from `LeanServer` to communicate directly with the REPL using the raw JSON protocol:
+>
+> ```python
+> # Using run_dict instead of the standard commands
+> result = server.run_dict({"cmd": "your_command_here"})
+> ```
+
+For assistance, feel free to contact [us](mailto:auguste.poiroux@epfl.ch).
 
 ## Similar tools
 

{lean_interact-0.5.3 → lean_interact-0.6.1}/README.md

@@ -1,5 +1,6 @@
 # LeanInteract
 
+[![Docs](https://img.shields.io/badge/docs-latest-blue.svg)](https://augustepoiroux.github.io/LeanInteract/)
 [![PyPI version](https://img.shields.io/pypi/v/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![PyPI downloads](https://img.shields.io/pepy/dt/lean-interact.svg)](https://pypi.org/project/lean-interact/)
 [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
@@ -12,8 +13,8 @@
 - **🔗 Interactivity**: Execute Lean code and files directly from Python.
 - **🚀 Ease of Use**: LeanInteract abstracts the complexities of Lean setup and interaction.
 - **💻 Cross-platform**: Works on Windows, macOS, and Linux operating systems.
-- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.19.0`.
-  - We backport the latest features of Lean REPL to older versions of Lean.
+- **🔧 Compatibility**: Supports all Lean versions between `v4.7.0-rc1` and `v4.21.0-rc3`.
+  - We backport the latest features of Lean REPL to older versions of Lean (see [fork](https://github.com/augustepoiroux/repl)).
 - **📦 Temporary Projects**: Easily instantiate temporary Lean environments.
   - Useful for experimenting with benchmarks depending on [Mathlib](https://github.com/leanprover-community/mathlib4) like [ProofNet#](https://huggingface.co/datasets/PAug/ProofNetSharp) and [MiniF2F](https://github.com/yangky11/miniF2F-lean4).
 
@@ -72,6 +73,8 @@ In the [`examples`](examples) directory, you will find a few scripts demonstrati
 
 ## Usage
 
+Full documentation is available [here](https://augustepoiroux.github.io/LeanInteract/).
+
 ### Basic example
 
 The following code will use the default Lean version (latest available):
@@ -423,7 +426,22 @@ Two versions of Lean servers are available:
 
 ### Custom Lean REPL
 
-To use a forked Lean REPL project, specify the git repository using the `repl_git` parameter in the `LeanREPLConfig`. Your fork should have a similar versioning format to <https://github.com/augustepoiroux/repl> (i.e. having a branch with commits for each Lean version). For assistance, feel free to contact [us](mailto:auguste.poiroux@epfl.ch).
+To use a forked Lean REPL project, specify the git repository using the `repl_git` parameter in the `LeanREPLConfig` and the target revision using the `repl_rev` parameter. For example:
+
+```python
+config = LeanREPLConfig(repl_rev="v4.21.0-rc3", repl_git="https://github.com/leanprover-community/repl", verbose=True)
+```
+
+> [!WARNING]
+>
+> Custom REPL implementations may have interfaces that are incompatible with LeanInteract's standard commands. If you encounter incompatibility issues, you can use the `run_dict` method from `LeanServer` to communicate directly with the REPL using the raw JSON protocol:
+>
+> ```python
+> # Using run_dict instead of the standard commands
+> result = server.run_dict({"cmd": "your_command_here"})
+> ```
+
+For assistance, feel free to contact [us](mailto:auguste.poiroux@epfl.ch).
 
 ## Similar tools
 

lean_interact-0.6.1/docs/api/config.md

@@ -0,0 +1,90 @@
+# Configuration API
+
+This page documents the configuration classes used to set up the Lean environment.
+
+## LeanREPLConfig
+
+::: lean_interact.config.LeanREPLConfig
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### Examples
+
+```python
+# Basic configuration with default settings
+config = LeanREPLConfig(verbose=True)
+
+# Configuration with specific Lean version
+config = LeanREPLConfig(lean_version="v4.19.0", verbose=True)
+
+# Configuration with memory limits
+config = LeanREPLConfig(memory_hard_limit_mb=2000)
+
+# Configuration with custom REPL version and repository
+config = LeanREPLConfig(
+    repl_rev="v4.21.0-rc3",
+    repl_git="https://github.com/leanprover-community/repl"
+)
+```
+
+## Project Classes
+
+### BaseProject
+
+::: lean_interact.config.BaseProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### LocalProject
+
+::: lean_interact.config.LocalProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### GitProject
+
+::: lean_interact.config.GitProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### BaseTempProject
+
+::: lean_interact.config.BaseTempProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### TemporaryProject
+
+::: lean_interact.config.TemporaryProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+## Project Dependencies
+
+### LeanRequire
+
+::: lean_interact.config.LeanRequire
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### TempRequireProject
+
+::: lean_interact.config.TempRequireProject
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3

lean_interact-0.6.1/docs/api/interface.md

@@ -0,0 +1,121 @@
+# Interface API
+
+This page documents the interface classes used to communicate with the Lean REPL.
+
+## Commands
+
+### Command
+
+::: lean_interact.interface.Command
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### FileCommand
+
+::: lean_interact.interface.FileCommand
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### ProofStep
+
+::: lean_interact.interface.ProofStep
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### PickleEnvironment
+
+::: lean_interact.interface.PickleEnvironment
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### UnpickleEnvironment
+
+::: lean_interact.interface.UnpickleEnvironment
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### PickleProofState
+
+::: lean_interact.interface.PickleProofState
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### UnpickleProofState
+
+::: lean_interact.interface.UnpickleProofState
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+## Responses
+
+### BaseREPLResponse
+
+::: lean_interact.interface.BaseREPLResponse
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### CommandResponse
+
+::: lean_interact.interface.CommandResponse
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### ProofStepResponse
+
+::: lean_interact.interface.ProofStepResponse
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+## Helper Classes
+
+### Message
+
+::: lean_interact.interface.Message
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### Sorry
+
+::: lean_interact.interface.Sorry
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### Pos
+
+::: lean_interact.interface.Pos
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### Tactic
+
+::: lean_interact.interface.Tactic
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3

lean_interact-0.6.1/docs/api/server.md

@@ -0,0 +1,34 @@
+# LeanServer API
+
+This page documents the server classes responsible for communicating with the Lean REPL.
+
+## LeanServer
+
+::: lean_interact.server.LeanServer
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### Using `run_dict` for custom REPLs
+
+When working with custom REPL implementations that might have incompatible interfaces with LeanInteract's standard commands, you can use the `run_dict` method to communicate directly with the REPL using the raw JSON protocol:
+
+```python
+# Using run_dict to send a raw command to the REPL
+result = server.run_dict({"cmd": "your_command_here"})
+```
+
+This method bypasses the command-specific parsing and validation, allowing you to work with custom REPL interfaces.
+
+## AutoLeanServer
+
+::: lean_interact.server.AutoLeanServer
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+## Timeout Configuration
+
+::: lean_interact.server.DEFAULT_TIMEOUT

lean_interact-0.6.1/docs/api/sessioncache.md

@@ -0,0 +1,52 @@
+# Session Cache API
+
+This page documents the session cache classes responsible for storing and retrieving Lean proof states and environments.
+Session cache is used internally by the `AutoLeanServer` class.
+It enables efficient resumption of proofs and environments after server restarts, timeouts, and automated recover from crashes. While by default `AutoLeanServer` instantiates a fresh `PickleSessionCache` instance, you can also use a custom one. It can be useful to share a session cache between multiple `AutoLeanServer` instances, or to use a custom session cache implementation.
+
+```python
+from lean_interact.sessioncache import PickleSessionCache
+from lean_interact.server import AutoLeanServer
+
+# Create a session cache
+cache = PickleSessionCache(working_dir="./cache")
+
+# Create a Lean server with the cache
+server = AutoLeanServer(config=..., session_cache=cache)
+```
+
+## Session State Classes
+
+### SessionState
+
+::: lean_interact.sessioncache.SessionState
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### PickleSessionState
+
+::: lean_interact.sessioncache.PickleSessionState
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+## Cache Implementation
+
+### BaseSessionCache
+
+::: lean_interact.sessioncache.BaseSessionCache
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3
+
+### PickleSessionCache
+
+::: lean_interact.sessioncache.PickleSessionCache
+    options:
+      show_root_heading: true
+      show_source: true
+      heading_level: 3

lean_interact-0.6.1/docs/api/utils.md

@@ -0,0 +1,98 @@
+# Utilities API
+
+This page documents the utility functions and classes used in LeanInteract.
+
+## Installation and Cache Management
+
+::: lean_interact.utils.install_lean
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.clear_cache
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Project Utilities
+
+::: lean_interact.utils.get_project_lean_version
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Windows Path Utilities
+
+::: lean_interact.utils.check_windows_long_paths
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Memory Management
+
+::: lean_interact.utils.get_total_memory_usage
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils._limit_memory
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Code Processing Utilities
+
+::: lean_interact.utils.indent_code
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.compress_newlines
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.lean_comments_ranges
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.remove_lean_comments
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.split_implementation
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.split_conclusion
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.clean_theorem_string
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.extract_last_theorem
+    options:
+      show_root_heading: true
+      show_source: true
+
+::: lean_interact.utils.clean_last_theorem_string
+    options:
+      show_root_heading: true
+      show_source: true
+
+## Constants
+
+::: lean_interact.utils.ROOT_DIR
+
+::: lean_interact.utils.DEFAULT_CACHE_DIR
+
+::: lean_interact.utils.DEFAULT_REPL_GIT_URL
+
+::: lean_interact.utils.DEFAULT_REPL_VERSION