lean-explore 0.1.1__py3-none-any.whl

lean_explore/shared/models/db.py

@@ -0,0 +1,411 @@
+# src/lean_explore/shared/models/db.py
+
+"""SQLAlchemy ORM models for the lean_explore database.
+
+Defines 'declarations', 'dependencies', 'statement_groups', and
+'statement_group_dependencies' tables representing Lean entities,
+their dependency graphs at different granularities, and source code groupings.
+Uses SQLAlchemy 2.0 syntax.
+"""
+
+import datetime
+from typing import List, Optional
+
+from sqlalchemy import (
+    Boolean,
+    DateTime,
+    Float,
+    ForeignKey,
+    Index,
+    Integer,
+    MetaData,
+    String,
+    Text,
+    UniqueConstraint,  # Kept for potential standalone model testing
+)
+from sqlalchemy.orm import DeclarativeBase, Mapped, mapped_column, relationship
+
+# Naming conventions for constraints and indexes for database consistency.
+convention = {
+    "ix": "ix_%(column_0_label)s",
+    "uq": "uq_%(table_name)s_%(column_0_name)s",
+    "ck": "ck_%(table_name)s_%(constraint_name)s",
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    "pk": "pk_%(table_name)s",
+}
+
+metadata_obj = MetaData(naming_convention=convention)
+
+
+class Base(DeclarativeBase):
+    """Base class for SQLAlchemy declarative models.
+
+    Includes metadata with naming conventions for database constraints and indexes,
+    ensuring consistency across the database schema.
+    """
+
+    metadata = metadata_obj
+
+
+class StatementGroup(Base):
+    """Represents a unique block of source code text.
+
+    This table groups multiple `Declaration` entries that originate from the
+    exact same source code text and location. This allows search results to
+    show a single entry for a code block, while retaining all individual
+    declarations for graph analysis and detailed views. It also tracks
+    dependencies to and from other statement groups.
+
+    Attributes:
+        id: Primary key identifier for the statement group.
+        text_hash: SHA-256 hash of `statement_text` for unique identification.
+        statement_text: Canonical source code text for this group (full block).
+        display_statement_text: Optional, potentially truncated version of the
+            source code, optimized for display (e.g., omitting proofs).
+        docstring: Docstring associated with this code block, typically from the
+            primary declaration.
+        informal_description: Optional informal English description, potentially
+            LLM-generated.
+        source_file: Relative path to the .lean file containing this block.
+        range_start_line: Starting line number of the block in the source file.
+        range_start_col: Starting column number of the block.
+        range_end_line: Ending line number of the block.
+        range_end_col: Ending column number of the block.
+        pagerank_score: PageRank score calculated for this statement group.
+        scaled_pagerank_score: Log-transformed, min-max scaled PageRank score.
+        primary_decl_id: Foreign key to the 'declarations' table, identifying
+            the primary or most representative declaration of this group.
+        created_at: Timestamp of when the record was created.
+        updated_at: Timestamp of the last update to the record.
+        primary_declaration: SQLAlchemy relationship to the primary Declaration.
+        declarations: SQLAlchemy relationship to all Declarations in this group.
+        dependencies_as_source: Links to `StatementGroupDependency` where this
+            group is the source (i.e., this group depends on others).
+        dependencies_as_target: Links to `StatementGroupDependency` where this
+            group is the target (i.e., other groups depend on this one).
+    """
+
+    __tablename__ = "statement_groups"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    text_hash: Mapped[str] = mapped_column(
+        String(64), nullable=False, index=True, unique=True
+    )
+    statement_text: Mapped[str] = mapped_column(Text, nullable=False)
+    display_statement_text: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    docstring: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    informal_description: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+
+    source_file: Mapped[str] = mapped_column(Text, nullable=False)
+    range_start_line: Mapped[int] = mapped_column(Integer, nullable=False)
+    range_start_col: Mapped[int] = mapped_column(Integer, nullable=False)
+    range_end_line: Mapped[int] = mapped_column(Integer, nullable=False)
+    range_end_col: Mapped[int] = mapped_column(Integer, nullable=False)
+
+    pagerank_score: Mapped[Optional[float]] = mapped_column(
+        Float, nullable=True, index=True
+    )
+    scaled_pagerank_score: Mapped[Optional[float]] = mapped_column(
+        Float, nullable=True, index=True
+    )
+
+    primary_decl_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey("declarations.id"), nullable=False, index=True
+    )
+
+    created_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+    updated_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime,
+        default=datetime.datetime.utcnow,
+        onupdate=datetime.datetime.utcnow,
+        nullable=False,
+    )
+
+    # Relationships
+    primary_declaration: Mapped["Declaration"] = relationship(
+        "Declaration", foreign_keys=[primary_decl_id]
+    )
+    declarations: Mapped[List["Declaration"]] = relationship(
+        "Declaration",
+        foreign_keys="[Declaration.statement_group_id]",
+        back_populates="statement_group",
+    )
+
+    dependencies_as_source: Mapped[List["StatementGroupDependency"]] = relationship(
+        foreign_keys="StatementGroupDependency.source_statement_group_id",
+        back_populates="source_group",
+        cascade="all, delete-orphan",
+        lazy="select",
+    )
+    dependencies_as_target: Mapped[List["StatementGroupDependency"]] = relationship(
+        foreign_keys="StatementGroupDependency.target_statement_group_id",
+        back_populates="target_group",
+        cascade="all, delete-orphan",
+        lazy="select",
+    )
+
+    __table_args__ = (
+        Index(
+            "ix_statement_groups_location",
+            "source_file",
+            "range_start_line",
+            "range_start_col",
+        ),
+    )
+
+    def __repr__(self) -> str:
+        """Provides a developer-friendly string representation."""
+        has_desc = "+" if self.informal_description else "-"
+        return (
+            f"<StatementGroup(id={self.id}, hash='{self.text_hash[:8]}...', "
+            f"primary_decl_id='{self.primary_decl_id}', informal_desc='{has_desc}', "
+            f"loc='{self.source_file}:{self.range_start_line}:{self.range_start_col}')>"
+        )
+
+
+class Declaration(Base):
+    """Represents a Lean declaration, a node in the dependency graph.
+
+    Stores information about Lean declarations (definitions, theorems, axioms, etc.),
+    including source location, Lean code, descriptions, and (potentially)
+    embeddings. Declarations from the same source block can be grouped via
+    `statement_group_id`.
+
+    Attributes:
+        id: Primary key identifier.
+        lean_name: Fully qualified Lean name (e.g., 'Nat.add'), unique and indexed.
+        decl_type: Type of declaration (e.g., 'theorem', 'definition').
+        source_file: Relative path to the .lean source file.
+        module_name: Lean module name (e.g., 'Mathlib.Data.Nat.Basic'), indexed.
+        is_internal: True if considered compiler-internal or auxiliary.
+        docstring: Documentation string, if available.
+        is_protected: True if marked 'protected' in Lean.
+        is_deprecated: True if marked 'deprecated'.
+        is_projection: True if it's a projection (e.g., from a class/structure).
+        range_start_line: Starting line number of the source block.
+        range_start_col: Starting column number of the source block.
+        range_end_line: Ending line number of the source block.
+        range_end_col: Ending column number of the source block.
+        statement_text: Full Lean code text of the originating source block.
+        declaration_signature: Extracted Lean signature text of the declaration.
+        statement_group_id: Optional foreign key to `statement_groups.id`.
+        type_signature_text: Lean type signature (may be redundant with
+            `declaration_signature`).
+        informal_description: Informal English explanation.
+        lean_embedding: Text representation (e.g., JSON) of the embedding for
+            Lean code.
+        informal_description_embedding: Text representation (e.g., JSON) of the
+            embedding for the informal description.
+        pagerank_score: PageRank score within the dependency graph, indexed.
+        created_at: Timestamp of record creation.
+        updated_at: Timestamp of last record update.
+        statement_group: SQLAlchemy relationship to the StatementGroup.
+    """
+
+    __tablename__ = "declarations"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    lean_name: Mapped[str] = mapped_column(
+        Text, unique=True, index=True, nullable=False
+    )
+    decl_type: Mapped[str] = mapped_column(String(30), nullable=False)
+    source_file: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    module_name: Mapped[Optional[str]] = mapped_column(Text, index=True, nullable=True)
+    is_internal: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+    docstring: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+
+    is_protected: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+    is_deprecated: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+    is_projection: Mapped[bool] = mapped_column(Boolean, default=False, nullable=False)
+
+    range_start_line: Mapped[Optional[int]] = mapped_column(Integer, nullable=True)
+    range_start_col: Mapped[Optional[int]] = mapped_column(Integer, nullable=True)
+    range_end_line: Mapped[Optional[int]] = mapped_column(Integer, nullable=True)
+    range_end_col: Mapped[Optional[int]] = mapped_column(Integer, nullable=True)
+
+    statement_text: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    declaration_signature: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+
+    statement_group_id: Mapped[Optional[int]] = mapped_column(
+        Integer, ForeignKey("statement_groups.id"), nullable=True, index=True
+    )
+
+    type_signature_text: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    informal_description: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+
+    lean_embedding: Mapped[Optional[str]] = mapped_column(Text, nullable=True)
+    informal_description_embedding: Mapped[Optional[str]] = mapped_column(
+        Text, nullable=True
+    )
+
+    pagerank_score: Mapped[Optional[float]] = mapped_column(
+        Float, nullable=True, index=True
+    )
+
+    created_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+    updated_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime,
+        default=datetime.datetime.utcnow,
+        onupdate=datetime.datetime.utcnow,
+        nullable=False,
+    )
+
+    statement_group: Mapped[Optional["StatementGroup"]] = relationship(
+        "StatementGroup",
+        foreign_keys=[statement_group_id],
+        back_populates="declarations",
+    )
+
+    __table_args__ = (
+        Index("ix_declarations_source_file", "source_file"),
+        Index("ix_declarations_is_protected", "is_protected"),
+        Index("ix_declarations_is_deprecated", "is_deprecated"),
+        Index("ix_declarations_is_projection", "is_projection"),
+        Index("ix_declarations_is_internal", "is_internal"),
+    )
+
+    def __repr__(self) -> str:
+        """Provides a developer-friendly string representation."""
+        group_id_str = (
+            f", group_id={self.statement_group_id}" if self.statement_group_id else ""
+        )
+        return (
+            f"<Declaration(id={self.id}, lean_name='{self.lean_name}', "
+            f"type='{self.decl_type}'{group_id_str})>"
+        )
+
+
+class Dependency(Base):
+    """Represents a dependency link between two Lean declarations.
+
+    Each row signifies that a 'source' declaration depends on a 'target'
+    declaration, forming an edge in the dependency graph. The nature of this
+    dependency is described by `dependency_type`.
+
+    Attributes:
+        id: Primary key identifier for the dependency link.
+        source_decl_id: Foreign key to the `Declaration` that depends on another.
+        target_decl_id: Foreign key to the `Declaration` that is depended upon.
+        dependency_type: String describing the type of dependency (e.g., 'Direct').
+        context: Optional string providing context for the dependency.
+        created_at: Timestamp of record creation.
+    """
+
+    __tablename__ = "dependencies"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    source_decl_id: Mapped[int] = mapped_column(
+        Integer,
+        ForeignKey("declarations.id", ondelete="CASCADE"),
+        nullable=False,
+        index=True,
+    )
+    target_decl_id: Mapped[int] = mapped_column(
+        Integer,
+        ForeignKey("declarations.id", ondelete="CASCADE"),
+        nullable=False,
+        index=True,
+    )
+    dependency_type: Mapped[str] = mapped_column(String(30), nullable=False)
+    context: Mapped[Optional[str]] = mapped_column(String(30), nullable=True)
+
+    created_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+
+    __table_args__ = (
+        UniqueConstraint(
+            "source_decl_id",
+            "target_decl_id",
+            "dependency_type",
+            name="uq_dependency_link",
+        ),
+        Index("ix_dependencies_source_target", "source_decl_id", "target_decl_id"),
+    )
+
+    def __repr__(self) -> str:
+        """Provides a developer-friendly string representation."""
+        return (
+            f"<Dependency(id={self.id}, source={self.source_decl_id}, "
+            f"target={self.target_decl_id}, type='{self.dependency_type}')>"
+        )
+
+
+class StatementGroupDependency(Base):
+    """Represents a dependency link between two StatementGroups.
+
+    Each row signifies that a 'source' statement group depends on a 'target'
+    statement group. This allows for a higher-level dependency graph.
+
+    Attributes:
+        id: Primary key identifier for the group dependency link.
+        source_statement_group_id: Foreign key to the `StatementGroup` that
+                                   depends on another.
+        target_statement_group_id: Foreign key to the `StatementGroup` that
+                                   is depended upon.
+        dependency_type: String describing the type of group dependency
+                         (e.g., 'DerivedFromDecl').
+        created_at: Timestamp of record creation.
+        source_group: SQLAlchemy relationship to the source StatementGroup.
+        target_group: SQLAlchemy relationship to the target StatementGroup.
+    """
+
+    __tablename__ = "statement_group_dependencies"
+
+    id: Mapped[int] = mapped_column(Integer, primary_key=True)
+    source_statement_group_id: Mapped[int] = mapped_column(
+        Integer,
+        ForeignKey("statement_groups.id", ondelete="CASCADE"),
+        nullable=False,
+        index=True,
+    )
+    target_statement_group_id: Mapped[int] = mapped_column(
+        Integer,
+        ForeignKey("statement_groups.id", ondelete="CASCADE"),
+        nullable=False,
+        index=True,
+    )
+    dependency_type: Mapped[str] = mapped_column(
+        String(50), nullable=False, default="DerivedFromDecl"
+    )
+
+    created_at: Mapped[datetime.datetime] = mapped_column(
+        DateTime, default=datetime.datetime.utcnow, nullable=False
+    )
+
+    # Relationships back to StatementGroup
+    source_group: Mapped["StatementGroup"] = relationship(
+        foreign_keys=[source_statement_group_id],
+        back_populates="dependencies_as_source",
+    )
+    target_group: Mapped["StatementGroup"] = relationship(
+        foreign_keys=[target_statement_group_id],
+        back_populates="dependencies_as_target",
+    )
+
+    __table_args__ = (
+        UniqueConstraint(
+            "source_statement_group_id",
+            "target_statement_group_id",
+            "dependency_type",  # Consider if type is part of uniqueness
+            name="uq_stmt_group_dependency_link",
+        ),
+        Index(
+            "ix_stmt_group_deps_source_target",
+            "source_statement_group_id",
+            "target_statement_group_id",
+        ),
+    )
+
+    def __repr__(self) -> str:
+        """Provides a developer-friendly string representation."""
+        return (
+            f"<StatementGroupDependency(id={self.id}, "
+            f"source_sg_id={self.source_statement_group_id}, "
+            f"target_sg_id={self.target_statement_group_id}, "
+            f"type='{self.dependency_type}')>"
+        )

lean_explore-0.1.1.dist-info/METADATA

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: lean-explore
+Version: 0.1.1
+Summary: A project to explore and rank Lean mathematical declarations.
+Author-email: Justin Asher <justinchadwickasher@gmail.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright 2025 LeanExplore Contributors
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+        
+Project-URL: Homepage, https://www.leanexplore.com/
+Project-URL: Repository, https://github.com/justincasher/lean-explore
+Keywords: lean,lean4,search,formal methods,theorem prover,math,AI
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: numpy>=1.20
+Requires-Dist: faiss-cpu>=1.7
+Requires-Dist: sentence-transformers>=2.2.0
+Requires-Dist: rapidfuzz>=3.0.0
+Requires-Dist: filelock>=3.0.0
+Requires-Dist: httpx>=0.23.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: typer[all]>=0.9.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: openai-agents>=0.0.16
+Requires-Dist: mcp>=1.9.0
+Requires-Dist: tqdm>=4.60
+Dynamic: license-file
+
+# LeanExplore
+
+A search engine for Lean 4 declarations. This project provides tools and resources for exploring the Lean 4 ecosystem.
+
+**For full documentation, please visit: [https://www.leanexplore.com/docs](https://www.leanexplore.com/docs)**
+
+The current indexed projects include:
+
+* Batteries
+* Lean
+* Mathlib
+* PhysLean
+* Std
+
+This code is distributed under an Apache License (see [LICENSE](LICENSE)).
+
+### Cite
+
+If you use LeanExplore in your research or work, please cite it as follows:
+
+**General Citation:**
+
+Justin Asher. (2025). *LeanExplore: A search engine for Lean 4 declarations*. LeanExplore.com. Retrieved from [http://www.leanexplore.com](http://www.leanexplore.com) (GitHub: [https://github.com/justincasher/lean-explore](https://github.com/justincasher/lean-explore)).
+
+**BibTeX Entry:**
+
+```bibtex
+@software{Asher_LeanExplore_2025,
+  author = {Asher, Justin},
+  title = {{LeanExplore: A search engine for Lean 4 declarations}},
+  year = {2025},
+  publisher = {LeanExplore.com},
+  url = {http://www.leanexplore.com},
+  note = {GitHub repository: https://github.com/justincasher/lean-explore}
+}
+```