notionary 0.2.2__tar.gz → 0.2.4__tar.gz

{notionary-0.2.2 → notionary-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: notionary
-Version: 0.2.2
+Version: 0.2.4
 Summary: A toolkit to convert between Markdown and Notion blocks
 Home-page: https://github.com/mathisarends/notionary
 Author: Mathis Arends

{notionary-0.2.2 → notionary-0.2.4}/notionary/elements/registry/block_registry_builder.py

@@ -67,7 +67,7 @@ class BlockRegistryBuilder:
             .with_paragraphs()
             .with_toggleable_heading_element()
         ).build()
-        
+
     @classmethod
     def create_minimal_registry(cls) -> BlockRegistry:
         """

{notionary-0.2.2 → notionary-0.2.4}/notionary/models/notion_database_response.py

@@ -1,4 +1,3 @@
-
 from pydantic import BaseModel
 from dataclasses import dataclass
 from typing import Optional, List, Dict, Any, Literal
@@ -55,4 +54,4 @@ class NotionDatabaseResponse(BaseModel):
     public_url: Optional[str]
     archived: bool
     in_trash: bool
-    request_id: Optional[str] = None
+    request_id: Optional[str] = None

{notionary-0.2.2 → notionary-0.2.4}/notionary/notion_client.py

@@ -69,8 +69,6 @@ class NotionClient(LoggingMixin):
         """
         return await self._make_request(HttpMethod.GET, endpoint)
 
-    # TODO: Get Blocks implementeren und Patch Blcoks hierfür das Typing finden:
-
     async def get_database(self, database_id: str) -> NotionDatabaseResponse:
         """
         Ruft die Metadaten einer Notion-Datenbank anhand ihrer ID ab und gibt sie als NotionPageResponse zurück.

notionary-0.2.4/notionary/prompting/markdown_syntax_prompt_generator.py

@@ -0,0 +1,111 @@
+from textwrap import dedent
+from typing import Type, List
+from notionary.elements.notion_block_element import NotionBlockElement
+
+
+class MarkdownSyntaxPromptGenerator:
+    """
+    Generator for LLM system prompts that describe Notion-Markdown syntax.
+
+    This class extracts information about supported Markdown patterns
+    and formats them optimally for LLMs.
+    """
+
+    SYSTEM_PROMPT_TEMPLATE = dedent(
+        """
+    You are a knowledgeable assistant that helps users create content for Notion pages.
+    Notion supports standard Markdown with some special extensions for creating rich content.
+
+    # Understanding Notion Blocks
+
+    Notion documents are composed of individual blocks. Each block has a specific type (paragraph, heading, list item, etc.) and format.
+    The Markdown syntax you use directly maps to these Notion blocks.
+
+    {element_docs}
+
+    CRITICAL USAGE GUIDELINES:
+
+    1. Do NOT start content with a level 1 heading (# Heading). In Notion, the page title is already displayed in the metadata, so starting with an H1 heading is redundant. Begin with H2 (## Heading) or lower for section headings.
+
+    2. INLINE FORMATTING - VERY IMPORTANT:
+    ✅ You can use inline formatting within almost any block type.
+    ✅ Combine **bold**, _italic_, `code`, and other formatting as needed.
+    ✅ Format text to create visual hierarchy and emphasize important points.
+    ❌ DO NOT overuse formatting - be strategic with formatting for best readability.
+
+    3. BACKTICK HANDLING - EXTREMELY IMPORTANT:
+    ❌ NEVER wrap entire content or responses in triple backticks (```).
+    ❌ DO NOT use triple backticks (```) for anything except CODE BLOCKS or DIAGRAMS.
+    ❌ DO NOT use triple backticks to mark or highlight regular text or examples.
+    ✅ USE triple backticks ONLY for actual programming code, pseudocode, or specialized notation.
+    ✅ For inline code, use single backticks (`code`).
+    ✅ When showing Markdown syntax examples, use inline code formatting with single backticks.
+
+    4. BLOCK SEPARATION - IMPORTANT:
+    ✅ Use empty lines between different blocks to ensure proper rendering in Notion.
+    ✅ For major logical sections, use the spacer element (see documentation below).
+    ⚠️ While headings can sometimes work without an empty line before the following paragraph, including empty lines between all block types ensures consistent rendering.
+
+    5. CONTENT FORMATTING - CRITICAL:
+    ❌ DO NOT include introductory phrases like "I understand that..." or "Here's the content...".
+    ✅ Provide ONLY the requested content directly without any prefacing text or meta-commentary.
+    ✅ Generate just the content itself, formatted according to these guidelines."""
+    )
+
+    @staticmethod
+    def generate_element_doc(element_class: Type[NotionBlockElement]) -> str:
+        """
+        Generates documentation for a specific NotionBlockElement in a compact format.
+        Uses the element's get_llm_prompt_content method if available.
+        """
+        class_name = element_class.__name__
+        element_name = class_name.replace("Element", "")
+
+        content = element_class.get_llm_prompt_content()
+
+        doc_parts = [
+            f"## {element_name}",
+            f"{content.description}",
+            f"**Syntax:** {content.syntax}",
+        ]
+
+        if content.examples:
+            doc_parts.append("**Examples:**")
+            for example in content.examples:
+                doc_parts.append(example)
+
+        doc_parts.append(f"**When to use:** {content.when_to_use}")
+
+        if content.avoid:
+            doc_parts.append(f"**Avoid:** {content.avoid}")
+
+        return "\n".join([part for part in doc_parts if part])
+
+    @classmethod
+    def generate_element_docs(
+        cls, element_classes: List[Type[NotionBlockElement]]
+    ) -> str:
+        """
+        Generates complete documentation for all provided element classes.
+        """
+        docs = [
+            "# Markdown Syntax for Notion Blocks",
+            "The following Markdown patterns are supported for creating Notion blocks:",
+        ]
+
+        # Generate docs for each element
+        for element in element_classes:
+            docs.append("\n" + cls.generate_element_doc(element))
+
+        return "\n".join(docs)
+
+    @classmethod
+    def generate_system_prompt(
+        cls,
+        element_classes: List[Type[NotionBlockElement]],
+    ) -> str:
+        """
+        Generates a complete system prompt for LLMs.
+        """
+        element_docs = cls.generate_element_docs(element_classes)
+        return cls.SYSTEM_PROMPT_TEMPLATE.format(element_docs=element_docs)

{notionary-0.2.2 → notionary-0.2.4}/notionary.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: notionary
-Version: 0.2.2
+Version: 0.2.4
 Summary: A toolkit to convert between Markdown and Notion blocks
 Home-page: https://github.com/mathisarends/notionary
 Author: Mathis Arends

{notionary-0.2.2 → notionary-0.2.4}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name="notionary",
-    version="0.2.2",
+    version="0.2.4",
     packages=find_namespace_packages(include=["notionary*"]),
     install_requires=["httpx>=0.28.0", "python-dotenv>=1.1.0", "pydantic>=2.11.4"],
     author="Mathis Arends",

notionary-0.2.2/notionary/prompting/markdown_syntax_prompt_generator.py

@@ -1,92 +0,0 @@
-import os
-from pathlib import Path
-from typing import Type, List
-from notionary.elements.notion_block_element import NotionBlockElement
-
-
-class MarkdownSyntaxPromptGenerator:
-    """
-    Generator for LLM system prompts that describe Notion-Markdown syntax.
-
-    This class extracts information about supported Markdown patterns
-    and formats them optimally for LLMs.
-    """
-
-    def __init__(self):
-        # Lade das Template aus der Markdown-Datei
-        self.SYSTEM_PROMPT_TEMPLATE = self._load_template()
-
-    def _load_template(self) -> str:
-        """
-        Lädt das Prompt-Template aus der Markdown-Datei.
-        """
-        current_dir = Path(__file__).parent
-        template_path = current_dir /  "res/notion_syntax_prompt.md"
-
-        try:
-            with open(template_path, "r", encoding="utf-8") as file:
-                return file.read()
-        except FileNotFoundError:
-            raise FileNotFoundError(f"Template file not found at {template_path}")
-        except Exception as e:
-            raise RuntimeError(f"Error loading template file: {e}")
-
-    @staticmethod
-    def generate_element_doc(element_class: Type[NotionBlockElement]) -> str:
-        """
-        Generates documentation for a specific NotionBlockElement in a compact format.
-        Uses the element's get_llm_prompt_content method if available.
-        """
-        class_name = element_class.__name__
-        element_name = class_name.replace("Element", "")
-
-        content = element_class.get_llm_prompt_content()
-
-        doc_parts = [
-            f"## {element_name}",
-            f"{content.description}",
-            f"**Syntax:** {content.syntax}",
-        ]
-
-        if content.examples:
-            doc_parts.append("**Examples:**")
-            for example in content.examples:
-                doc_parts.append(example)
-
-        doc_parts.append(f"**When to use:** {content.when_to_use}")
-
-        if content.avoid:
-            doc_parts.append(f"**Avoid:** {content.avoid}")
-
-        return "\n".join([part for part in doc_parts if part])
-
-    @classmethod
-    def generate_element_docs(
-        cls, element_classes: List[Type[NotionBlockElement]]
-    ) -> str:
-        """
-        Generates complete documentation for all provided element classes.
-        """
-        docs = [
-            "# Markdown Syntax for Notion Blocks",
-            "The following Markdown patterns are supported for creating Notion blocks:",
-        ]
-
-        # Generate docs for each element
-        for element in element_classes:
-            docs.append("\n" + cls.generate_element_doc(element))
-
-        return "\n".join(docs)
-
-    @classmethod
-    def generate_system_prompt(
-        cls,
-        element_classes: List[Type[NotionBlockElement]],
-    ) -> str:
-        """
-        Generates a complete system prompt for LLMs.
-        """
-        # Erstelle eine Instanz, um das Template zu laden
-        instance = cls()
-        element_docs = cls.generate_element_docs(element_classes)
-        return instance.SYSTEM_PROMPT_TEMPLATE.format(element_docs=element_docs)