docmarq 0.1.0__py3-none-any.whl

docmarq/__init__.py

@@ -0,0 +1,54 @@
+# docmarq/__init__.py
+
+"""
+DOCX generation with fluent API. Built on `python-docx`.
+
+Mirror of `pdfmarq` philosophy: thin fluent layer over a heavy backend.
+We use `python-docx` for OOXML zip plumbing, content types, and
+relationships - everything user-facing is our own API.
+
+Example:
+  >>> from docmarq import DOCX, Align
+  >>> with DOCX("out.docx") as doc:
+  ...   doc.heading("Tytuł", level=1)
+  ...   doc.para("Pierwszy akapit.")
+  ...   doc.text("Drugi z ").text("bold", bold=True).text(" tekstem.")
+"""
+
+#----------------------------------------------------------------------- Metadata for auto-toml
+
+__version__ = "0.1.0"
+__repo__ = "Xaeian/docmarq"
+__python__ = ">=3.10"
+__description__ = "DOCX generation library with fluent API"
+__author__ = "Xaeian"
+__keywords__ = ["docx", "word", "ooxml", "document", "generation"]
+__dependencies__ = ["python-docx"]
+# pip-name → import-name mapping. `python-docx` is the pip package but
+# the import is `import docx`; the hint surfaces in dependency diagnostics
+# so users debugging `No module named 'docx'` see the right install command.
+__import_names__ = {"python-docx": "docx"}
+
+#----------------------------------------------------------------------------------- Public API
+
+from .constants import (
+  Unit, PageSize, Align, Colors, Defaults,
+  A4, A3, A5, LETTER, LEGAL, EMU_PER_MM, EMU_PER_PT,
+)
+from .styles import Style, TableStyle, Styles
+from .layout import PageGeometry
+from .structure import Metadata, Bookmark
+from .utils import to_mm, mm_to_emu, pt_to_emu, parse_color, parse_margin, color_hex, rgb255
+from .inline import RichSegment
+from .core import DOCX
+
+__all__ = [
+  "DOCX",
+  "Unit", "PageSize", "Align", "Colors", "Defaults",
+  "A4", "A3", "A5", "LETTER", "LEGAL", "EMU_PER_MM", "EMU_PER_PT",
+  "Style", "TableStyle", "Styles",
+  "PageGeometry",
+  "Metadata", "Bookmark",
+  "to_mm", "mm_to_emu", "pt_to_emu", "parse_color", "parse_margin", "color_hex", "rgb255",
+  "RichSegment",
+]

docmarq/constants.py

@@ -0,0 +1,77 @@
+# docmarq/constants.py
+
+"""Constants for DOCX library - units, page sizes, alignment, defaults."""
+from dataclasses import dataclass
+
+# OOXML uses EMU (English Metric Units): 1 inch = 914400 EMU = 25.4 mm
+EMU_PER_MM = 36000
+EMU_PER_PT = 12700 # 1 pt = 1/72 inch
+
+#---------------------------------------------------------------------------------------- Units
+
+class Unit:
+  """Unit conversion factors to millimeters."""
+  MM = 1.0
+  CM = 10.0
+  INCH = 25.4
+  PT = 25.4 / 72
+  PX = 25.4 / 96
+
+#------------------------------------------------------------------------------------- PageSize
+
+@dataclass
+class PageSize:
+  """Common page sizes in mm."""
+  width: float
+  height: float
+  def landscape(self) -> "PageSize":
+    """Return a copy with width/height swapped (landscape orientation)."""
+    return PageSize(self.height, self.width)
+
+A4 = PageSize(210, 297)
+A3 = PageSize(297, 420)
+A5 = PageSize(148, 210)
+LETTER = PageSize(215.9, 279.4)
+LEGAL = PageSize(215.9, 355.6)
+
+#---------------------------------------------------------------------------------------- Align
+
+class Align:
+  """Text/element alignment constants. Match pdfmarq values for cross-lib reuse."""
+  LEFT = "L"
+  RIGHT = "R"
+  CENTER = "C"
+  JUSTIFY = "J"
+
+#--------------------------------------------------------------------------------------- Colors
+
+class Colors:
+  """Predefined colors as (r, g, b) tuples (0-1 range)."""
+  BLACK = (0, 0, 0)
+  WHITE = (1, 1, 1)
+  RED = (1, 0, 0)
+  GREEN = (0, 1, 0)
+  BLUE = (0, 0, 1)
+  GREY = (0.5, 0.5, 0.5)
+  LIGHT_GREY = (0.8, 0.8, 0.8)
+  DARK_GREY = (0.3, 0.3, 0.3)
+
+#------------------------------------------------------------------------------------- Defaults
+
+class Defaults:
+  """Default values for DOCX generation."""
+  PAGE_WIDTH = 210
+  PAGE_HEIGHT = 297
+  MARGIN = 20
+  FONT_FAMILY = "Calibri"
+  FONT_SIZE = 11
+  FONT_MODE = "Regular"
+  LINE_HEIGHT = 1.15
+  UNIT = "mm"
+  # Heading palette - GitHub-light, mirrors `pdfmarq.MarkdownStyle`
+  HEAD_COLOR = (0.09, 0.11, 0.13) # near-black #1f2328
+  RULE_COLOR = (0.82, 0.84, 0.87) # light grey #d0d7de (h1/h2 underline)
+  # h1..h6 sizes in pt. Matches `pdfmarq.MarkdownStyle.h{1-6}_size` so
+  # the same markdown source renders at the same scale in both libs.
+  HEAD_SIZES = (20, 16, 13, 11, 11, 11)
+  HEAD_UNDERLINE_LEVELS = (1, 2) # which heading levels get bottom border