notionary 0.1.29__py3-none-any.whl → 0.2.0__py3-none-any.whl

notionary/elements/registry/{block_element_registry_builder.py → block_registry_builder.py}

@@ -2,14 +2,16 @@ from __future__ import annotations
 from typing import List, Type
 from collections import OrderedDict
 
+from notionary.elements.notion_block_element import NotionBlockElement
+
 from notionary.elements.audio_element import AudioElement
 from notionary.elements.bulleted_list_element import BulletedListElement
 from notionary.elements.embed_element import EmbedElement
 from notionary.elements.mention_element import MentionElement
 from notionary.elements.notion_block_element import NotionBlockElement
 from notionary.elements.numbered_list_element import NumberedListElement
-from notionary.elements.registry.block_element_registry import (
-    BlockElementRegistry,
+from notionary.elements.registry.block_registry import (
+    BlockRegistry,
 )
 
 from notionary.elements.paragraph_element import ParagraphElement
@@ -27,9 +29,9 @@ from notionary.elements.toggle_element import ToggleElement
 from notionary.elements.bookmark_element import BookmarkElement
 
 
-class BlockElementRegistryBuilder:
+class BlockRegistryBuilder:
     """
-    True builder for constructing BlockElementRegistry instances.
+    True builder for constructing BlockRegistry instances.
 
     This builder allows for incremental construction of registry instances
     with specific configurations of block elements.
@@ -40,7 +42,7 @@ class BlockElementRegistryBuilder:
         self._elements = OrderedDict()
 
     @classmethod
-    def create_full_registry(cls) -> BlockElementRegistry:
+    def create_full_registry(cls) -> BlockRegistry:
         """
         Start with all standard elements in recommended order.
         """
@@ -65,10 +67,24 @@ class BlockElementRegistryBuilder:
             .with_paragraphs()
             .with_toggleable_heading_element()
         ).build()
+        
+    @classmethod
+    def create_minimal_registry(cls) -> BlockRegistry:
+        """
+        Create a minimal registry with just essential text elements.
+        Suitable for basic note-taking.
+        """
+        builder = cls()
+        return (
+            builder.with_paragraphs()
+            .with_headings()
+            .with_bulleted_list()
+            .with_numbered_list()
+        ).build()
 
     def add_element(
         self, element_class: Type[NotionBlockElement]
-    ) -> BlockElementRegistryBuilder:
+    ) -> BlockRegistryBuilder:
         """
         Add an element class to the registry configuration.
         If the element already exists, it's moved to the end.
@@ -86,7 +102,7 @@ class BlockElementRegistryBuilder:
 
     def add_elements(
         self, element_classes: List[Type[NotionBlockElement]]
-    ) -> BlockElementRegistryBuilder:
+    ) -> BlockRegistryBuilder:
         """
         Add multiple element classes to the registry configuration.
 
@@ -102,7 +118,7 @@ class BlockElementRegistryBuilder:
 
     def remove_element(
         self, element_class: Type[NotionBlockElement]
-    ) -> BlockElementRegistryBuilder:
+    ) -> BlockRegistryBuilder:
         """
         Remove an element class from the registry configuration.
 
@@ -117,7 +133,7 @@ class BlockElementRegistryBuilder:
 
     def move_element_to_end(
         self, element_class: Type[NotionBlockElement]
-    ) -> BlockElementRegistryBuilder:
+    ) -> BlockRegistryBuilder:
         """
         Move an existing element to the end of the registry.
         If the element doesn't exist, it will be added.
@@ -138,131 +154,131 @@ class BlockElementRegistryBuilder:
             paragraph_class = self._elements.pop(ParagraphElement.__name__)
             self._elements[ParagraphElement.__name__] = paragraph_class
 
-    def with_paragraphs(self) -> BlockElementRegistryBuilder:
+    def with_paragraphs(self) -> BlockRegistryBuilder:
         """
         Add support for paragraph elements.
         """
         return self.add_element(ParagraphElement)
 
-    def with_headings(self) -> BlockElementRegistryBuilder:
+    def with_headings(self) -> BlockRegistryBuilder:
         """
         Add support for heading elements.
         """
         return self.add_element(HeadingElement)
 
-    def with_callouts(self) -> BlockElementRegistryBuilder:
+    def with_callouts(self) -> BlockRegistryBuilder:
         """
         Add support for callout elements.
         """
         return self.add_element(CalloutElement)
 
-    def with_code(self) -> BlockElementRegistryBuilder:
+    def with_code(self) -> BlockRegistryBuilder:
         """
         Add support for code blocks.
         """
         return self.add_element(CodeBlockElement)
 
-    def with_dividers(self) -> BlockElementRegistryBuilder:
+    def with_dividers(self) -> BlockRegistryBuilder:
         """
         Add support for divider elements.
         """
         return self.add_element(DividerElement)
 
-    def with_tables(self) -> BlockElementRegistryBuilder:
+    def with_tables(self) -> BlockRegistryBuilder:
         """
         Add support for tables.
         """
         return self.add_element(TableElement)
 
-    def with_bulleted_list(self) -> BlockElementRegistryBuilder:
+    def with_bulleted_list(self) -> BlockRegistryBuilder:
         """
         Add support for bulleted list elements (unordered lists).
         """
         return self.add_element(BulletedListElement)
 
-    def with_numbered_list(self) -> BlockElementRegistryBuilder:
+    def with_numbered_list(self) -> BlockRegistryBuilder:
         """
         Add support for numbered list elements (ordered lists).
         """
         return self.add_element(NumberedListElement)
 
-    def with_toggles(self) -> BlockElementRegistryBuilder:
+    def with_toggles(self) -> BlockRegistryBuilder:
         """
         Add support for toggle elements.
         """
         return self.add_element(ToggleElement)
 
-    def with_quotes(self) -> BlockElementRegistryBuilder:
+    def with_quotes(self) -> BlockRegistryBuilder:
         """
         Add support for quote elements.
         """
         return self.add_element(QuoteElement)
 
-    def with_todos(self) -> BlockElementRegistryBuilder:
+    def with_todos(self) -> BlockRegistryBuilder:
         """
         Add support for todo elements.
         """
         return self.add_element(TodoElement)
 
-    def with_bookmarks(self) -> BlockElementRegistryBuilder:
+    def with_bookmarks(self) -> BlockRegistryBuilder:
         """
         Add support for bookmark elements.
         """
         return self.add_element(BookmarkElement)
 
-    def with_images(self) -> BlockElementRegistryBuilder:
+    def with_images(self) -> BlockRegistryBuilder:
         """
         Add support for image elements.
         """
         return self.add_element(ImageElement)
 
-    def with_videos(self) -> BlockElementRegistryBuilder:
+    def with_videos(self) -> BlockRegistryBuilder:
         """
         Add support for video elements.
         """
         return self.add_element(VideoElement)
 
-    def with_embeds(self) -> BlockElementRegistryBuilder:
+    def with_embeds(self) -> BlockRegistryBuilder:
         """
         Add support for embed elements.
         """
         return self.add_element(EmbedElement)
 
-    def with_audio(self) -> BlockElementRegistryBuilder:
+    def with_audio(self) -> BlockRegistryBuilder:
         """
         Add support for audio elements.
         """
         return self.add_element(AudioElement)
 
-    def with_media_support(self) -> BlockElementRegistryBuilder:
+    def with_media_support(self) -> BlockRegistryBuilder:
         """
         Add support for media elements (images, videos, audio).
         """
         return self.with_images().with_videos().with_audio()
 
-    def with_mention(self) -> BlockElementRegistryBuilder:
+    def with_mention(self) -> BlockRegistryBuilder:
         return self.add_element(MentionElement)
 
-    def with_toggleable_heading_element(self) -> BlockElementRegistryBuilder:
+    def with_toggleable_heading_element(self) -> BlockRegistryBuilder:
         return self.add_element(ToggleableHeadingElement)
 
-    def build(self) -> BlockElementRegistry:
+    def build(self) -> BlockRegistry:
         """
-        Build and return the configured BlockElementRegistry instance.
+        Build and return the configured BlockRegistry instance.
 
         This automatically ensures that ParagraphElement is at the end
         of the registry (if present) as a fallback element, unless
         this behavior was explicitly disabled.
 
         Returns:
-            A configured BlockElementRegistry instance
+            A configured BlockRegistry instance
         """
         if ParagraphElement.__name__ not in self._elements:
             self.add_element(ParagraphElement)
         else:
             self._ensure_paragraph_at_end()
 
-        registry = BlockElementRegistry()
+        registry = BlockRegistry()
 
         # Add elements in the recorded order
         for element_class in self._elements.values():

notionary/elements/table_element.py

@@ -2,7 +2,7 @@ import re
 from typing import Dict, Any, Optional, List, Tuple
 from notionary.elements.notion_block_element import NotionBlockElement
 from notionary.elements.text_inline_formatter import TextInlineFormatter
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )

notionary/elements/text_inline_formatter.py

@@ -1,7 +1,7 @@
 from typing import Dict, Any, List, Tuple
 import re
 
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )
@@ -219,20 +219,24 @@ class TextInlineFormatter:
         return (
             ElementPromptBuilder()
             .with_description(
-                "Enables inline formatting like bold, italics, strikethrough, code, links, and underlining for enhanced readability and emphasis."
+                "Inline formatting can be used within most block types to style your text. You can combine multiple formatting options."
             )
             .with_usage_guidelines(
                 "Use inline formatting to highlight important words, provide emphasis, show code or paths, or add hyperlinks. "
-                "Helps create a visual hierarchy and improves scanability of long texts."
+                "This helps create visual hierarchy and improves readability."
+            )
+            .with_syntax(
+                "**bold**, *italic*, `code`, ~~strikethrough~~, __underline__, [text](url)"
             )
-            .with_syntax("**bold**, *italic*, `code`, [text](url)")
             .with_examples(
                 [
-                    "This is a **bold** word.",
-                    "Use *italics* for emphasis.",
-                    "Mark outdated content like ~~this~~.",
-                    "Write `config.json` to reference a file.",
-                    "Visit [Notion](https://notion.so) for more info.",
+                    "This text has a **bold** word.",
+                    "This text has an *italic* word.",
+                    "This text has `code` formatting.",
+                    "This text has ~~strikethrough~~ formatting.",
+                    "This text has __underlined__ formatting.",
+                    "This has a [hyperlink](https://example.com).",
+                    "You can **combine *different* formatting** styles.",
                 ]
             )
             .build()

notionary/elements/todo_element.py

@@ -1,7 +1,7 @@
 import re
 from typing import Dict, Any, Optional
 from notionary.elements.notion_block_element import NotionBlockElement
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )

notionary/elements/toggle_element.py

@@ -2,7 +2,7 @@ import re
 from typing import Dict, Any, Optional, List, Tuple, Callable
 
 from notionary.elements.notion_block_element import NotionBlockElement
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )

notionary/elements/toggleable_heading_element.py

@@ -2,7 +2,7 @@ import re
 from typing import Dict, Any, Optional, List, Tuple, Callable
 
 from notionary.elements.notion_block_element import NotionBlockElement
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )

notionary/elements/video_element.py

@@ -1,7 +1,7 @@
 import re
 from typing import Dict, Any, Optional, List
 from notionary.elements.notion_block_element import NotionBlockElement
-from notionary.elements.prompts.element_prompt_content import (
+from notionary.prompting.element_prompt_content import (
     ElementPromptBuilder,
     ElementPromptContent,
 )

notionary/models/notion_block_response.py

@@ -0,0 +1,264 @@
+from typing import List, Optional, Union, Literal
+from pydantic import BaseModel
+
+
+# Rich Text Komponenten
+class TextContent(BaseModel):
+    content: str
+    link: Optional[dict] = None
+
+
+class Annotations(BaseModel):
+    bold: bool
+    italic: bool
+    strikethrough: bool
+    underline: bool
+    code: bool
+    color: str
+
+
+class RichText(BaseModel):
+    type: Literal["text"]
+    text: TextContent
+    annotations: Annotations
+    plain_text: str
+    href: Optional[str]
+
+
+# Benutzerobjekt
+class User(BaseModel):
+    object: str
+    id: str
+
+
+# Elternobjekte
+class PageParent(BaseModel):
+    type: Literal["page_id"]
+    page_id: str
+
+
+class DatabaseParent(BaseModel):
+    type: Literal["database_id"]
+    database_id: str
+
+
+class WorkspaceParent(BaseModel):
+    type: Literal["workspace"]
+    workspace: bool = True
+
+
+Parent = Union[PageParent, DatabaseParent, WorkspaceParent]
+
+
+# Block-spezifische Inhalte
+class ParagraphBlock(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+
+
+class Heading1Block(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+    is_toggleable: Optional[bool] = False
+
+
+class Heading2Block(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+    is_toggleable: Optional[bool] = False
+
+
+class Heading3Block(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+    is_toggleable: Optional[bool] = False
+
+
+class BulletedListItemBlock(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+
+
+class NumberedListItemBlock(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+
+
+class ToDoBlock(BaseModel):
+    rich_text: List[RichText]
+    checked: Optional[bool] = False
+    color: Optional[str] = "default"
+
+
+class ToggleBlock(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+
+
+class QuoteBlock(BaseModel):
+    rich_text: List[RichText]
+    color: Optional[str] = "default"
+
+
+class CalloutBlock(BaseModel):
+    rich_text: List[RichText]
+    icon: Optional[dict] = None
+    color: Optional[str] = "default"
+
+
+class CodeBlock(BaseModel):
+    rich_text: List[RichText]
+    language: Optional[str] = "plain text"
+
+
+class EquationBlock(BaseModel):
+    expression: str
+
+
+class DividerBlock(BaseModel):
+    pass
+
+
+class TableOfContentsBlock(BaseModel):
+    color: Optional[str] = "default"
+
+
+class BreadcrumbBlock(BaseModel):
+    pass
+
+
+class ColumnListBlock(BaseModel):
+    pass
+
+
+class ColumnBlock(BaseModel):
+    pass
+
+
+class LinkToPageBlock(BaseModel):
+    type: str
+    page_id: Optional[str] = None
+    database_id: Optional[str] = None
+
+
+class SyncedBlock(BaseModel):
+    synced_from: Optional[dict] = None
+
+
+class TemplateBlock(BaseModel):
+    rich_text: List[RichText]
+
+
+class TableBlock(BaseModel):
+    table_width: int
+    has_column_header: bool
+    has_row_header: bool
+
+
+class TableRowBlock(BaseModel):
+    cells: List[List[RichText]]
+
+
+class BookmarkBlock(BaseModel):
+    caption: List[RichText]
+    url: str
+
+
+class EmbedBlock(BaseModel):
+    url: str
+
+
+class ImageBlock(BaseModel):
+    type: str
+    external: Optional[dict] = None
+    file: Optional[dict] = None
+    caption: List[RichText]
+
+
+class VideoBlock(BaseModel):
+    type: str
+    external: Optional[dict] = None
+    file: Optional[dict] = None
+    caption: List[RichText]
+
+
+class PDFBlock(BaseModel):
+    type: str
+    external: Optional[dict] = None
+    file: Optional[dict] = None
+    caption: List[RichText]
+
+
+class FileBlock(BaseModel):
+    type: str
+    external: Optional[dict] = None
+    file: Optional[dict] = None
+    caption: List[RichText]
+
+
+class AudioBlock(BaseModel):
+    type: str
+    external: Optional[dict] = None
+    file: Optional[dict] = None
+    caption: List[RichText]
+
+
+class LinkPreviewBlock(BaseModel):
+    url: str
+
+
+class ChildPageBlock(BaseModel):
+    title: str
+
+
+class ChildDatabaseBlock(BaseModel):
+    title: str
+
+
+# TODO: Use the block typing here:
+# Test the code base.
+class Block(BaseModel):
+    object: Literal["block"]
+    id: str
+    parent: Parent
+    created_time: str
+    last_edited_time: str
+    created_by: User
+    last_edited_by: User
+    has_children: bool
+    archived: bool
+    in_trash: bool
+    type: str
+    paragraph: Optional[ParagraphBlock] = None
+    heading_1: Optional[Heading1Block] = None
+    heading_2: Optional[Heading2Block] = None
+    heading_3: Optional[Heading3Block] = None
+    bulleted_list_item: Optional[BulletedListItemBlock] = None
+    numbered_list_item: Optional[NumberedListItemBlock] = None
+    to_do: Optional[ToDoBlock] = None
+    toggle: Optional[ToggleBlock] = None
+    quote: Optional[QuoteBlock] = None
+    callout: Optional[CalloutBlock] = None
+    code: Optional[CodeBlock] = None
+    equation: Optional[EquationBlock] = None
+    divider: Optional[DividerBlock] = None
+    table_of_contents: Optional[TableOfContentsBlock] = None
+    breadcrumb: Optional[BreadcrumbBlock] = None
+    column_list: Optional[ColumnListBlock] = None
+    column: Optional[ColumnBlock] = None
+    link_to_page: Optional[LinkToPageBlock] = None
+    synced_block: Optional[SyncedBlock] = None
+    template: Optional[TemplateBlock] = None
+    table: Optional[TableBlock] = None
+    table_row: Optional[TableRowBlock] = None
+    bookmark: Optional[BookmarkBlock] = None
+    embed: Optional[EmbedBlock] = None
+    image: Optional[ImageBlock] = None
+    video: Optional[VideoBlock] = None
+    pdf: Optional[PDFBlock] = None
+    file: Optional[FileBlock] = None
+    audio: Optional[AudioBlock] = None
+    link_preview: Optional[LinkPreviewBlock] = None
+    child_page: Optional[ChildPageBlock] = None
+    child_database: Optional[ChildDatabaseBlock] = None
+    unsupported: Optional[dict] = None

notionary/models/notion_database_response.py

@@ -0,0 +1,63 @@
+from pydantic import BaseModel
+from dataclasses import dataclass
+from typing import Optional, List, Dict, Any, Literal
+
+from notionary.models.notion_page_response import Icon
+
+
+@dataclass
+class TextContent:
+    content: str
+    link: Optional[str] = None
+
+
+@dataclass
+class TextContent:
+    content: str
+    link: Optional[str] = None
+
+
+@dataclass
+class RichText:
+    type: str
+    text: TextContent
+    plain_text: str
+    href: Optional[str]
+
+
+@dataclass
+class User:
+    object: str
+    id: str
+
+
+@dataclass
+class Parent:
+    type: Literal["page_id", "workspace"]
+    page_id: Optional[str] = None
+
+
+@dataclass
+class NotionDatabaserResponse(BaseModel):
+    """
+    Represents the response from the Notion API when retrieving a database.
+    """
+
+    object: Literal["database"]
+    id: str
+    cover: Optional[Any]
+    icon: Optional[Icon]
+    created_time: str
+    last_edited_time: str
+    created_by: User
+    last_edited_by: User
+    title: List[RichText]
+    description: List[Any]
+    is_inline: bool
+    properties: Dict[str, Any]
+    parent: Parent
+    url: str
+    public_url: Optional[str]
+    archived: bool
+    in_trash: bool
+    request_id: Optional[str] = None