epub-generator 0.1.1__tar.gz → 0.1.2__tar.gz

{epub_generator-0.1.1 → epub_generator-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: epub-generator
-Version: 0.1.1
+Version: 0.1.2
 Summary: A simple Python EPUB 3.0 generator with a single API call
 License: MIT
 Keywords: epub,epub3,ebook,generator,publishing
@@ -80,9 +80,9 @@ That's it! You now have a valid EPUB 3.0 ebook file.
 
 - **Minimal API**: Just one function call `generate_epub()`
 - **EPUB 3.0**: Generates standards-compliant EPUB 3.0 format
-- **Rich Content**: Supports text, images, tables, math formulas, footnotes
+- **Rich Content**: Supports text, images, tables, math formulas (block-level and inline), footnotes
 - **Flexible Structure**: Nested chapters, prefaces, cover images
-- **Math Support**: LaTeX to MathML conversion
+- **Math Support**: LaTeX to MathML/SVG conversion with inline formula support
 - **Type Safe**: Full type annotations included
 
 ## Advanced Usage
@@ -250,6 +250,8 @@ generate_epub(epub_data, "book_with_tables.epub")
 
 ### Add Math Formulas
 
+Block-level formulas:
+
 ```python
 from epub_generator import generate_epub, EpubData, TocItem, Chapter, Text, TextKind, Formula, LaTeXRender
 
@@ -260,7 +262,7 @@ epub_data = EpubData(
             get_chapter=lambda: Chapter(
                 elements=[
                     Text(kind=TextKind.BODY, content=["Pythagorean theorem:"]),
-                    Formula(latex_expression="x^2 + y^2 = z^2"),  # LaTeX expression
+                    Formula(latex_expression="x^2 + y^2 = z^2"),  # Block-level formula
                 ]
             ),
         ),
@@ -271,6 +273,34 @@ epub_data = EpubData(
 generate_epub(epub_data, "book_with_math.epub", latex_render=LaTeXRender.MATHML)
 ```
 
+Inline formulas embedded in text:
+
+```python
+epub_data = EpubData(
+    chapters=[
+        TocItem(
+            title="Chapter 1",
+            get_chapter=lambda: Chapter(
+                elements=[
+                    Text(
+                        kind=TextKind.BODY,
+                        content=[
+                            "The Pythagorean theorem ",
+                            Formula(latex_expression="a^2 + b^2 = c^2"),  # Inline formula
+                            " is fundamental. Einstein's equation ",
+                            Formula(latex_expression="E = mc^2"),
+                            " shows mass-energy equivalence.",
+                        ],
+                    ),
+                ]
+            ),
+        ),
+    ],
+)
+
+generate_epub(epub_data, "book_with_inline_math.epub", latex_render=LaTeXRender.MATHML)
+```
+
 ### Add Prefaces
 
 ```python
@@ -392,7 +422,7 @@ class Chapter:
   @dataclass
   class Text:
       kind: TextKind                            # BODY | HEADLINE | QUOTE
-      content: list[str | Mark]                 # Text content with optional marks
+      content: list[str | Mark | Formula]       # Text with optional marks and inline formulas
   ```
 
 - **`Image`**: Image reference

{epub_generator-0.1.1 → epub_generator-0.1.2}/README.md

@@ -53,9 +53,9 @@ That's it! You now have a valid EPUB 3.0 ebook file.
 
 - **Minimal API**: Just one function call `generate_epub()`
 - **EPUB 3.0**: Generates standards-compliant EPUB 3.0 format
-- **Rich Content**: Supports text, images, tables, math formulas, footnotes
+- **Rich Content**: Supports text, images, tables, math formulas (block-level and inline), footnotes
 - **Flexible Structure**: Nested chapters, prefaces, cover images
-- **Math Support**: LaTeX to MathML conversion
+- **Math Support**: LaTeX to MathML/SVG conversion with inline formula support
 - **Type Safe**: Full type annotations included
 
 ## Advanced Usage
@@ -223,6 +223,8 @@ generate_epub(epub_data, "book_with_tables.epub")
 
 ### Add Math Formulas
 
+Block-level formulas:
+
 ```python
 from epub_generator import generate_epub, EpubData, TocItem, Chapter, Text, TextKind, Formula, LaTeXRender
 
@@ -233,7 +235,7 @@ epub_data = EpubData(
             get_chapter=lambda: Chapter(
                 elements=[
                     Text(kind=TextKind.BODY, content=["Pythagorean theorem:"]),
-                    Formula(latex_expression="x^2 + y^2 = z^2"),  # LaTeX expression
+                    Formula(latex_expression="x^2 + y^2 = z^2"),  # Block-level formula
                 ]
             ),
         ),
@@ -244,6 +246,34 @@ epub_data = EpubData(
 generate_epub(epub_data, "book_with_math.epub", latex_render=LaTeXRender.MATHML)
 ```
 
+Inline formulas embedded in text:
+
+```python
+epub_data = EpubData(
+    chapters=[
+        TocItem(
+            title="Chapter 1",
+            get_chapter=lambda: Chapter(
+                elements=[
+                    Text(
+                        kind=TextKind.BODY,
+                        content=[
+                            "The Pythagorean theorem ",
+                            Formula(latex_expression="a^2 + b^2 = c^2"),  # Inline formula
+                            " is fundamental. Einstein's equation ",
+                            Formula(latex_expression="E = mc^2"),
+                            " shows mass-energy equivalence.",
+                        ],
+                    ),
+                ]
+            ),
+        ),
+    ],
+)
+
+generate_epub(epub_data, "book_with_inline_math.epub", latex_render=LaTeXRender.MATHML)
+```
+
 ### Add Prefaces
 
 ```python
@@ -365,7 +395,7 @@ class Chapter:
   @dataclass
   class Text:
       kind: TextKind                            # BODY | HEADLINE | QUOTE
-      content: list[str | Mark]                 # Text content with optional marks
+      content: list[str | Mark | Formula]       # Text with optional marks and inline formulas
   ```
 
 - **`Image`**: Image reference

{epub_generator-0.1.1 → epub_generator-0.1.2}/epub_generator/data/style.css.jinja

@@ -53,4 +53,16 @@ div.alt-wrapper th,
 div.alt-wrapper th {
   background-color: #f6f8fa;
   font-weight: 600;
+}
+
+span.formula-inline {
+  display: inline;
+  vertical-align: middle;
+}
+
+span.formula-inline img {
+  display: inline-block;
+  vertical-align: middle;
+  margin: 0 0.2em;
+  max-height: 1.2em;
 }

{epub_generator-0.1.1 → epub_generator-0.1.2}/epub_generator/generation/gen_asset.py

@@ -34,7 +34,12 @@ def process_table(context: Context, table: Table) -> Element | None:
         return None
 
 
-def process_formula(context: Context, formula: Formula) -> Element | None:
+def process_formula(
+        context: Context, 
+        formula: Formula, 
+        inline_mode: bool,
+    ) -> Element | None:
+
     if context.latex_render == LaTeXRender.CLIPPING:
         return None
 
@@ -43,22 +48,28 @@ def process_formula(context: Context, formula: Formula) -> Element | None:
         return None
 
     if context.latex_render == LaTeXRender.MATHML:
-        return _latex2mathml(latex_expr)
-
+        return _latex2mathml(
+            latex=latex_expr, 
+            inline_mode=inline_mode,
+        )
     elif context.latex_render == LaTeXRender.SVG:
         svg_image = _latex_formula2svg(latex_expr)
         if svg_image is None:
             return None
         file_name = context.add_asset(
-            data=svg_image, 
-            media_type="image/svg+xml", 
+            data=svg_image,
+            media_type="image/svg+xml",
             file_ext=".svg",
         )
         img_element = Element("img")
         img_element.set("src", f"../assets/{file_name}")
         img_element.set("alt", "formula")
 
-        wrapper = Element("div", attrib={"class": "alt-wrapper"})
+        if inline_mode:
+            wrapper = Element("span", attrib={"class": "formula-inline"})
+        else:
+            wrapper = Element("div", attrib={"class": "alt-wrapper"})
+
         wrapper.append(img_element)
         return wrapper
 
@@ -83,9 +94,12 @@ def process_image(context: Context, image: Image) -> Element | None:
 _ESCAPE_UNICODE_PATTERN = re.compile(r"&#x([0-9A-Fa-f]{5});")
 
 
-def _latex2mathml(latex: str) -> None | Element:
+def _latex2mathml(latex: str, inline_mode: bool) -> None | Element:
     try:
-        html_latex = convert(latex)
+        html_latex = convert(
+            latex=latex,
+            display="inline" if inline_mode else "block",
+        )
     except Exception:
         return None
 

{epub_generator-0.1.1 → epub_generator-0.1.2}/epub_generator/generation/gen_chapter.py

@@ -13,8 +13,8 @@ from ..types import (
     Text,
     TextKind,
 )
-from .xml_utils import serialize_element, set_epub_type
 from .gen_asset import process_formula, process_image, process_table
+from .xml_utils import serialize_element, set_epub_type
 
 
 def generate_chapter(
@@ -98,7 +98,7 @@ def _render_content_block(context: Context, block: ContentBlock) -> Element | No
         else:
             raise ValueError(f"Unknown TextKind: {block.kind}")
 
-        _render_text_content(container, block.content)
+        _render_text_content(context, container, block.content)
 
         if block.kind == TextKind.QUOTE:
             blockquote = Element("blockquote")
@@ -111,7 +111,7 @@ def _render_content_block(context: Context, block: ContentBlock) -> Element | No
         return process_table(context, block)
 
     elif isinstance(block, Formula):
-        return process_formula(context, block)
+        return process_formula(context, block, inline_mode=False)
 
     elif isinstance(block, Image):
         return process_image(context, block)
@@ -120,7 +120,7 @@ def _render_content_block(context: Context, block: ContentBlock) -> Element | No
         return None
 
 
-def _render_text_content(parent: Element, content: list[str | Mark]) -> None:
+def _render_text_content(context: Context, parent: Element, content: list[str | Mark | Formula]) -> None:
     """Render text content with inline citation marks."""
     current_element = parent
     for item in content:
@@ -135,6 +135,17 @@ def _render_text_content(parent: Element, content: list[str | Mark]) -> None:
                     current_element.tail = item
                 else:
                     current_element.tail += item
+
+        elif isinstance(item, Formula):
+            formula_element = process_formula(
+                context=context,
+                formula=item,
+                inline_mode=True,
+            )
+            if formula_element is not None:
+                parent.append(formula_element)
+                current_element = formula_element
+
         elif isinstance(item, Mark):
             # EPUB 3.0 noteref with semantic attributes
             anchor = Element("a")

{epub_generator-0.1.1 → epub_generator-0.1.2}/epub_generator/generation/gen_epub.py

@@ -8,7 +8,7 @@ from zipfile import ZipFile
 from ..context import Context, Template
 from ..i18n import I18N
 from ..options import LaTeXRender, TableRender
-from ..types import EpubData, Formula
+from ..types import EpubData, Formula, Text
 from .gen_chapter import generate_chapter
 from .gen_nav import gen_nav
 from .gen_toc import NavPoint, gen_toc
@@ -136,9 +136,22 @@ def _write_chapters_from_data(
 
 
 def _chapter_has_formula(chapter) -> bool:
+    """Check if chapter contains any formulas (block-level or inline)."""
     for element in chapter.elements:
         if isinstance(element, Formula):
             return True
+        if isinstance(element, Text):
+            for item in element.content:
+                if isinstance(item, Formula):
+                    return True
+    for footnote in chapter.footnotes:
+        for content_block in footnote.contents:
+            if isinstance(content_block, Formula):
+                return True
+            if isinstance(content_block, Text):
+                for item in content_block.content:
+                    if isinstance(item, Formula):
+                        return True
     return False
 
 def _write_basic_files(

epub_generator-0.1.2/epub_generator/generation/xml_utils.py

@@ -0,0 +1,31 @@
+import re
+from xml.etree.ElementTree import Element, tostring
+
+_EPUB_NS = "http://www.idpf.org/2007/ops"
+_MATHML_NS = "http://www.w3.org/1998/Math/MathML"
+
+
+def set_epub_type(element: Element, epub_type: str) -> None:
+    element.set(f"{{{_EPUB_NS}}}type", epub_type)
+
+def serialize_element(element: Element) -> str:
+    xml_string = tostring(element, encoding="unicode")
+    for prefix, namespace_uri, keep_xmlns in (
+        ("epub", _EPUB_NS, False),  # EPUB namespace: remove xmlns (declared at root)
+        ("m", _MATHML_NS, True),     # MathML namespace: keep xmlns with clean prefix
+    ):
+        xml_string = xml_string.replace(f"{{{namespace_uri}}}", f"{prefix}:")
+        pattern = r"xmlns:(ns\d+)=\"" + re.escape(namespace_uri) + r"\""
+        matches = re.findall(pattern, xml_string)
+
+        for ns_prefix in matches:
+            if keep_xmlns:
+                xml_string = xml_string.replace(
+                    f" xmlns:{ns_prefix}=\"{namespace_uri}\"",
+                    f" xmlns:{prefix}=\"{namespace_uri}\""
+                )
+            else:
+                xml_string = xml_string.replace(f" xmlns:{ns_prefix}=\"{namespace_uri}\"", "")
+            xml_string = xml_string.replace(f"{ns_prefix}:", f"{prefix}:")
+
+    return xml_string

{epub_generator-0.1.1 → epub_generator-0.1.2}/epub_generator/types.py

@@ -83,13 +83,6 @@ class Mark:
     id: int
     """Citation ID, matches Footnote.id"""
 
-@dataclass
-class Text:
-    kind: TextKind
-    """Kind of text block."""
-    content: list[str | Mark]
-    """Text content with optional citation marks."""
-    
 @dataclass
 class Table:
     """HTML table."""
@@ -113,6 +106,12 @@ class Image:
     alt_text: str = "image"
     """Alt text (defaults to "image")"""
 
+@dataclass
+class Text:
+    kind: TextKind
+    """Kind of text block."""
+    content: list[str | Mark | Formula]
+    """Text content with optional citation marks."""
 
 @dataclass
 class Footnote:

{epub_generator-0.1.1 → epub_generator-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "epub-generator"
-version = "0.1.1"
+version = "0.1.2"
 description = "A simple Python EPUB 3.0 generator with a single API call"
 authors = ["Tao Zeyu <i@taozeyu.com>"]
 license = "MIT"

epub_generator-0.1.1/epub_generator/generation/xml_utils.py

@@ -1,18 +0,0 @@
-import re
-from xml.etree.ElementTree import Element, tostring
-
-_EPUB_NS = "http://www.idpf.org/2007/ops"
-
-
-def set_epub_type(element: Element, epub_type: str) -> None:
-    element.set(f"{{{_EPUB_NS}}}type", epub_type)
-
-def serialize_element(element: Element) -> str:
-    xml_string = tostring(element, encoding="unicode")
-    xml_string = xml_string.replace(f"{{{_EPUB_NS}}}", "epub:")
-    ns_pattern = r'xmlns:(ns\d+)="' + re.escape(_EPUB_NS) + r'"'
-    matches = re.findall(ns_pattern, xml_string)
-    for ns_prefix in matches:
-        xml_string = xml_string.replace(f' xmlns:{ns_prefix}="{_EPUB_NS}"', "")
-        xml_string = xml_string.replace(f"{ns_prefix}:", "epub:")
-    return xml_string