hammad-python 0.0.10__py3-none-any.whl → 0.0.12__py3-none-any.whl

hammad/{utils/markdown/formatting.py → text/markdown.py}

@@ -1,4 +1,4 @@
-"""hammad.utils.markdown.formatting"""
+"""hammad.text.utils.markdown"""
 
 from typing import (
     List,
@@ -7,60 +7,62 @@ from typing import (
 )
 
 __all__ = (
-    "bold",
-    "italic",
-    "code",
-    "code_block",
-    "heading",
-    "link",
-    "list_item",
-    "table_row",
-    "blockquote",
-    "horizontal_rule",
-    "table",
+    "markdown_bold",
+    "markdown_italic",
+    "markdown_code",
+    "markdown_code_block",
+    "markdown_heading",
+    "markdown_link",
+    "markdown_list_item",
+    "markdown_table_row",
+    "markdown_blockquote",
+    "markdown_horizontal_rule",
+    "markdown_table",
 )
 
 
-def bold(text: str) -> str:
+def markdown_bold(text: str) -> str:
     """Format text as bold in Markdown."""
     return f"**{text}**"
 
 
-def italic(text: str) -> str:
+def markdown_italic(text: str) -> str:
     """Format text as italic in Markdown."""
     return f"*{text}*"
 
 
-def code(text: str) -> str:
+def markdown_code(text: str) -> str:
     """Format text as inline code in Markdown."""
     return f"`{text}`"
 
 
-def code_block(text: str, language: str = "") -> str:
+def markdown_code_block(text: str, language: str = "") -> str:
     """Format text as a code block in Markdown."""
     return f"```{language}\n{text}\n```"
 
 
-def heading(text: str, level: int = 1) -> str:
+def markdown_heading(text: str, level: int = 1) -> str:
     """Format text as a heading in Markdown."""
     if not 1 <= level <= 6:
         level = 1
     return f"{'#' * level} {text}"
 
 
-def link(text: str, url: str) -> str:
+def markdown_link(text: str, url: str) -> str:
     """Format text as a link in Markdown."""
     return f"[{text}]({url})"
 
 
-def list_item(text: str, level: int = 0, ordered: bool = False, index: int = 1) -> str:
+def markdown_list_item(
+    text: str, level: int = 0, ordered: bool = False, index: int = 1
+) -> str:
     """Format text as a list item in Markdown."""
     indent = "  " * level
     marker = f"{index}." if ordered else "-"
     return f"{indent}{marker} {text}"
 
 
-def table_row(cells: List[str], is_header: bool = False) -> str:
+def markdown_table_row(cells: List[str], is_header: bool = False) -> str:
     """Format a table row in Markdown."""
     row = "| " + " | ".join(cells) + " |"
     if is_header:
@@ -69,19 +71,19 @@ def table_row(cells: List[str], is_header: bool = False) -> str:
     return row
 
 
-def blockquote(text: str, level: int = 1) -> str:
+def markdown_blockquote(text: str, level: int = 1) -> str:
     """Format text as a blockquote in Markdown."""
     prefix = ">" * level + " "
     lines = text.split("\n")
     return "\n".join(f"{prefix}{line}" for line in lines)
 
 
-def horizontal_rule() -> str:
+def markdown_horizontal_rule() -> str:
     """Create a horizontal rule in Markdown."""
     return "---"
 
 
-def table(
+def markdown_table(
     headers: List[str],
     rows: List[List[str]],
     alignment: Optional[List[Literal["left", "center", "right"]]] = None,