mrmd-ai 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

mrmd_ai/signatures/edit.py

@@ -0,0 +1,173 @@
+"""Signature definitions for cursor-based editing and comment processing."""
+
+import dspy
+from pydantic import BaseModel, Field
+from typing import List, Optional
+
+
+class Edit(BaseModel):
+    """A single find/replace edit operation.
+
+    For insertions at cursor, use find="" and the text will be inserted
+    at the cursor position.
+    """
+    find: str = Field(
+        description="Exact text to find in document. Use empty string for insertion at cursor."
+    )
+    replace: str = Field(
+        description="Text to replace the found text with, or text to insert if find is empty."
+    )
+
+
+class CommentInfo(BaseModel):
+    """Information about a comment in the document."""
+    text: str = Field(description="The comment text content")
+    context_before: str = Field(description="Text immediately before the comment")
+    context_after: str = Field(description="Text immediately after the comment")
+
+
+class EditAtCursorSignature(dspy.Signature):
+    """
+    Execute a user instruction by generating precise find/replace edits.
+
+    You are given the cursor context and a natural language instruction.
+    Generate a list of edits that implement the instruction.
+
+    CRITICAL RULES:
+    1. Each edit has `find` (exact text to locate) and `replace` (replacement text)
+    2. For INSERTIONS at cursor: use find="" - the replace text will be inserted at cursor
+    3. For MODIFICATIONS: find must match the EXACT text in the document (character-for-character)
+    4. find strings must be UNIQUE enough to match only the intended location
+    5. Include surrounding context in find to ensure uniqueness (e.g., "def process_data(items)" not just "process_data")
+    6. Edits are applied in order - earlier edits may shift positions of later ones
+
+    Examples:
+    - Instruction: "add a docstring" → find the function definition, replace with definition + docstring
+    - Instruction: "rename x to count" → find=" x " (with spaces), replace=" count "
+    - Instruction: "insert a comment here" → find="", replace="# comment\\n"
+    - Instruction: "delete this line" → find="the line content\\n", replace=""
+
+    When the user has selected text, that text is provided in `selection`.
+    Prefer to operate on the selection when it's relevant to the instruction.
+    """
+
+    text_before: str = dspy.InputField(
+        desc="Text immediately before the cursor (up to 500 characters for context)"
+    )
+    text_after: str = dspy.InputField(
+        desc="Text immediately after the cursor (up to 500 characters for context)"
+    )
+    selection: str = dspy.InputField(
+        desc="Currently selected text, or empty string if no selection"
+    )
+    full_document: str = dspy.InputField(
+        desc="The complete document content for full context"
+    )
+    instruction: str = dspy.InputField(
+        desc="User's natural language instruction for what to do"
+    )
+
+    edits: List[Edit] = dspy.OutputField(
+        desc="List of find/replace edits to apply. Order matters - applied sequentially."
+    )
+
+
+class AddressCommentSignature(dspy.Signature):
+    """
+    Address a single comment/instruction embedded in the document.
+
+    Comments are marked with <!--! comment text !--> syntax.
+    The comment contains instructions or notes that should be addressed.
+    Generate edits that fulfill the comment's request.
+
+    After addressing, you may optionally remove the comment marker itself.
+
+    Guidelines:
+    - Read the comment carefully to understand what's requested
+    - Look at the surrounding context to understand where changes should go
+    - Generate precise edits that address the comment
+    - If the comment asks for something that's already done, return empty edits
+    - Consider removing the comment after addressing it (include that as an edit)
+    """
+
+    full_document: str = dspy.InputField(
+        desc="The complete document content"
+    )
+    comment_text: str = dspy.InputField(
+        desc="The text content of the comment (without the <!--! !--> markers)"
+    )
+    comment_context_before: str = dspy.InputField(
+        desc="Text immediately before the comment marker"
+    )
+    comment_context_after: str = dspy.InputField(
+        desc="Text immediately after the comment marker"
+    )
+    comment_raw: str = dspy.InputField(
+        desc="The full raw comment including markers (e.g., '<!--! add error handling !-->')"
+    )
+
+    edits: List[Edit] = dspy.OutputField(
+        desc="List of find/replace edits to address the comment"
+    )
+
+
+class AddressAllCommentsSignature(dspy.Signature):
+    """
+    Address ALL comments/instructions in a document.
+
+    Scan the document for all <!--! ... !--> comment markers and generate
+    edits that address each one.
+
+    Guidelines:
+    - Process comments in document order (top to bottom)
+    - Each comment should be addressed appropriately
+    - Comments that conflict should be resolved sensibly
+    - After addressing, remove the comment markers
+    - Return all edits as a single list (they'll be applied in order)
+    """
+
+    full_document: str = dspy.InputField(
+        desc="The complete document content with embedded comments"
+    )
+    comments: List[CommentInfo] = dspy.InputField(
+        desc="List of all comments found in the document with their context"
+    )
+
+    edits: List[Edit] = dspy.OutputField(
+        desc="List of all find/replace edits to address all comments"
+    )
+
+
+class AddressNearbyCommentSignature(dspy.Signature):
+    """
+    Address the comment nearest to the cursor position.
+
+    Find the comment that's closest to where the user's cursor is and
+    generate edits to address that specific comment.
+
+    Guidelines:
+    - Focus only on the comment nearest to the cursor
+    - Use the cursor context to identify which comment is relevant
+    - Generate edits that address that comment
+    - Optionally remove the comment marker after addressing
+    """
+
+    full_document: str = dspy.InputField(
+        desc="The complete document content"
+    )
+    cursor_context_before: str = dspy.InputField(
+        desc="Text before the cursor position"
+    )
+    cursor_context_after: str = dspy.InputField(
+        desc="Text after the cursor position"
+    )
+    nearby_comment: CommentInfo = dspy.InputField(
+        desc="The comment closest to the cursor"
+    )
+    nearby_comment_raw: str = dspy.InputField(
+        desc="The full raw comment including markers"
+    )
+
+    edits: List[Edit] = dspy.OutputField(
+        desc="List of find/replace edits to address the nearby comment"
+    )

{mrmd_ai-0.1.0.dist-info → mrmd_ai-0.1.2.dist-info}/METADATA

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: mrmd-ai
-Version: 0.1.0
+Version: 0.1.2
 Summary: AI programs for MRMD editor - completions, fixes, and corrections
+License-File: LICENSE
 Requires-Python: >=3.11
 Requires-Dist: dspy>=2.6
 Requires-Dist: fastapi>=0.115

{mrmd_ai-0.1.0.dist-info → mrmd_ai-0.1.2.dist-info}/RECORD

@@ -1,26 +1,30 @@
 mrmd_ai/__init__.py,sha256=RocuoOEEJCUNinxqsXWjm_bIimCu8aDCDha-G5pU4fU,105
-mrmd_ai/juice.py,sha256=0_h7_M89IDhSt4iohdz0J5StcFXOaLF33d3fTxdBO-o,14442
-mrmd_ai/server.py,sha256=Jgl-bsQYbBMtv_tGu_2FwSN9BxgFpt-fmb9_pjIcqNw,14416
+mrmd_ai/custom_programs.py,sha256=owdMbWzHNDAoF2LbOpWZnri9xnFIq2BocFtiQLtoDXU,6826
+mrmd_ai/juice.py,sha256=SJjJailZ3o84RbG8XvBIyKAh0ZqDcbKmbekCj6UJa4Q,28544
+mrmd_ai/server.py,sha256=RPZhnp9Gl3tt5x8q2MjlzVrjSvuE-r8yA536JIPQbm8,23515
 mrmd_ai/metrics/__init__.py,sha256=6BngKqh0a09phOzUdYeWjhsUXznCIx5jEjrEt7DIDu4,62
-mrmd_ai/modules/__init__.py,sha256=4V4IzurDZs_nhBTGlHyXco24iwEkum58kRNrKfm4IjQ,1793
+mrmd_ai/modules/__init__.py,sha256=OO-5alsFmR1bLtsvxAJ2wNO5nOtHRmWChTexEI6Y9xU,2097
 mrmd_ai/modules/code.py,sha256=8cK6LF0ZTrSp2srt1ltvUnmYjPlt5NZTj1yWctpJ7j0,4099
 mrmd_ai/modules/correct.py,sha256=TWnE1HD_Ip7xZ5yQwJi1n01tNXgBtYNvkTK--kAknak,1478
 mrmd_ai/modules/document.py,sha256=o6iLR2amscn-DHZ95JFQuEwhaj8cLs4bBISf7G9cT9Y,1106
+mrmd_ai/modules/edit.py,sha256=lGa0tNB7d9tRG4rtdQ6uNIi3lzSbC588c3r86ccPXZc,2736
 mrmd_ai/modules/finish.py,sha256=VtyE-45-8iM6iWjNg57wRWL0Ln3mSF0RcZq8CO5CoSk,2638
 mrmd_ai/modules/fix.py,sha256=fb4flKWyyyelheigeb1sI0dixd2scL9HZX-0_M_Uh-o,1506
 mrmd_ai/modules/notebook.py,sha256=w8Dg-NKVL6_kPOKkvb84kGrwgv5zHxvFNWBtXHLHww8,477
 mrmd_ai/modules/text.py,sha256=9MCO__EDalwi-iFf__sd8t7orsUy7WiBBf6Lp4bxxGE,2010
 mrmd_ai/optimizers/__init__.py,sha256=Ay6ZrQu8fLQaG7-dl6hTMruQY5AdGOT_YnlRhhZGgag,60
-mrmd_ai/signatures/__init__.py,sha256=wWT2D8beisIpYMPxN4j4JncQmUqcamD6v5BTKp2zFWc,655
+mrmd_ai/signatures/__init__.py,sha256=UoIplXOXxPidkaXi9u-7l2LziDJX2MN4PmwtXVsC04U,1013
 mrmd_ai/signatures/code.py,sha256=zBM_Nl2NImfOw49fVWCGlXcE_sm8xgWCN1ksDbEa6e8,11245
 mrmd_ai/signatures/correct.py,sha256=tIhYCONgGhuTV0eJCiLSXcGZSAEi06XY35ommtTTsRE,2920
 mrmd_ai/signatures/document.py,sha256=4Y-9SeXJGCq098Vy-PIbb_rexS2dYDlkU-kxnKAPVSU,1828
+mrmd_ai/signatures/edit.py,sha256=OBAYsh88Qg_EIoEJHHa28QRuSh2xbGM3OSGWtPJ8u_A,6524
 mrmd_ai/signatures/finish.py,sha256=x-ZB0U8GQJdNoGGO80FBOxHXjYsCmTFq9fnkXlHDeUY,5294
 mrmd_ai/signatures/fix.py,sha256=LJNvu9_XjPl90Wtt3xn6s-jGXA9GB5rdIL0MeFyRGtE,3042
 mrmd_ai/signatures/notebook.py,sha256=ZBioHA9ZTkLUD_UovdfiRYiDaUKuKOCDhiZP1NDFY8o,1226
 mrmd_ai/signatures/text.py,sha256=GhmFtEZqwivbevPI_NSBzh6AlH6JKLt2rA_LaYGK2lQ,5223
 mrmd_ai/utils/__init__.py,sha256=T4e9jmFWDSj1HOyz5_Qv-JQSC08GwT_9CACcAn37vWg,46
-mrmd_ai-0.1.0.dist-info/METADATA,sha256=4w17Do4YbBpwoT3PFN2i01zswTPJCVzR6rgib0zZXME,1167
-mrmd_ai-0.1.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-mrmd_ai-0.1.0.dist-info/entry_points.txt,sha256=Bq6nXiXxhNSPEgYWBgrrgJH1DeGjKM6hfCijcWClApw,55
-mrmd_ai-0.1.0.dist-info/RECORD,,
+mrmd_ai-0.1.2.dist-info/METADATA,sha256=XP2KXado_UWlhsbveBajtLEdAl9Cjeq3e3XGovqK1sg,1189
+mrmd_ai-0.1.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+mrmd_ai-0.1.2.dist-info/entry_points.txt,sha256=Bq6nXiXxhNSPEgYWBgrrgJH1DeGjKM6hfCijcWClApw,55
+mrmd_ai-0.1.2.dist-info/licenses/LICENSE,sha256=7WBExfg4gC1NdkdBtnOFRbt_bOD3gKPmEc-7hHMIcXQ,1070
+mrmd_ai-0.1.2.dist-info/RECORD,,

mrmd_ai-0.1.2.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Maxime Rivest
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.