mdforge 0.1.0__tar.gz

mdforge-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 mm21
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mdforge-0.1.0/PKG-INFO

@@ -0,0 +1,29 @@
+Metadata-Version: 2.1
+Name: mdforge
+Version: 0.1.0
+Summary: Synthesize Markdown files in a Pythonic way
+Home-page: https://github.com/mm21/mdforge
+Author: mm21
+Author-email: mm21.dev@gmail.com
+Requires-Python: >=3.12,<4.0
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: pyrollup (>=0.1.0,<0.2.0)
+Description-Content-Type: text/markdown
+
+# MDForge
+
+Synthesize Markdown files in a Pythonic way.
+
+[![PyPI](https://img.shields.io/pypi/v/mdforge?color=%2334D058&label=pypi%20package)](https://pypi.org/project/mdforge)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Work in progress.
+

mdforge-0.1.0/README.md

@@ -0,0 +1,8 @@
+# MDForge
+
+Synthesize Markdown files in a Pythonic way.
+
+[![PyPI](https://img.shields.io/pypi/v/mdforge?color=%2334D058&label=pypi%20package)](https://pypi.org/project/mdforge)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Work in progress.

mdforge-0.1.0/mdforge/__init__.py

@@ -0,0 +1,13 @@
+"""
+MDForge: Forge Markdown files in a Python way.
+"""
+
+from pyrollup import rollup
+
+from .document import *
+from .elements import *
+
+from . import document
+from . import elements
+
+__all__ = rollup(document, elements)

mdforge-0.1.0/mdforge/_element.py

@@ -0,0 +1,12 @@
+"""
+Base element functionality.
+"""
+
+from abc import ABC, abstractmethod
+from typing import Generator
+
+
+class BaseElement(ABC):
+
+    @abstractmethod
+    def render(self) -> Generator[str, None, None]: ...

mdforge-0.1.0/mdforge/document.py

@@ -0,0 +1,57 @@
+"""
+Interface for Markdown document generation.
+"""
+
+from pathlib import Path
+from typing import Any, Iterable, Self
+
+from ._element import BaseElement
+
+
+class Document:
+    """
+    Encapsulates a Document. Add element(s) using the `+=` operator.
+    """
+
+    _frontmatter: dict[str, Any] | None
+    _elements: list[BaseElement]
+
+    def __init__(self, frontmatter: dict[str, Any] | None = None):
+        self._frontmatter = frontmatter
+        self._elements = []
+
+    def __iadd__(self, element: BaseElement | Iterable[BaseElement]) -> Self:
+        """
+        Implements `+=` operator to add element(s).
+        """
+        elements: list[BaseElement] = (
+            list(element) if isinstance(element, Iterable) else [element]
+        )
+        assert all(isinstance(e, BaseElement) for e in elements)
+
+        self._elements += elements
+
+        return self
+
+    def render(self, path: Path):
+        """
+        Write Markdown document to the provided path.
+        """
+        with path.open("w") as fh:
+            fh.write(self.render_text())
+
+    def render_text(self) -> str:
+        """
+        Return Markdown document as text.
+        """
+
+        lines: list[str] = []
+
+        if self._frontmatter is not None:
+            # TODO: write frontmatter
+            pass
+
+        for element in self._elements:
+            lines += list(element.render()) + [""]
+
+        return "\n".join(lines)

mdforge-0.1.0/mdforge/elements.py

@@ -0,0 +1,65 @@
+"""
+Exports common elements for use in document generation.
+"""
+
+from __future__ import annotations
+from dataclasses import dataclass
+from typing import Generator
+
+from ._element import BaseElement
+
+__all__ = [
+    "Heading",
+    "Paragraph",
+    "List",
+]
+
+INDENT = " " * 2
+
+
+@dataclass
+class Heading(BaseElement):
+    """
+    Heading, e.g. `# My heading`.
+    """
+
+    title: str
+    level: int = 1
+
+    def render(self) -> Generator[str, None, None]:
+        yield f"{'#' * self.level} {self.title}"
+
+
+@dataclass
+class Paragraph(BaseElement):
+
+    lines: str | list[str]
+
+    def render(self) -> Generator[str, None, None]:
+        lines = [self.lines] if isinstance(self.lines, str) else self.lines
+        assert all(isinstance(l, str) for l in lines)
+
+        yield from lines
+
+
+type ListItemType = str | list[ListItemType]
+
+
+@dataclass
+class List(BaseElement):
+
+    items: list[ListItemType]
+
+    def render(self) -> Generator[str, None, None]:
+
+        def do_render(
+            items: list[ListItemType], depth: int
+        ) -> Generator[str, None, None]:
+            for item in items:
+                if isinstance(item, str):
+                    yield f"{INDENT * depth}- {item}"
+                else:
+                    assert isinstance(item, list)
+                    yield from do_render(item, depth + 1)
+
+        yield from do_render(self.items, 0)

mdforge-0.1.0/pyproject.toml

@@ -0,0 +1,41 @@
+[tool.poetry]
+authors = ["mm21 <mm21.dev@gmail.com>"]
+classifiers = [
+  # Get the list of trove classifiers here: https://pypi.org/classifiers/
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Operating System :: OS Independent",
+  "Typing :: Typed",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Development Status :: 2 - Pre-Alpha",
+  "Natural Language :: English",
+  "License :: OSI Approved :: MIT License"
+]
+description = "Synthesize Markdown files in a Pythonic way"
+homepage = "https://github.com/mm21/mdforge"
+name = "mdforge"
+packages = [{include = "mdforge"}]
+readme = "README.md"
+version = "0.1.0"
+
+[tool.poetry.dependencies]
+python = "^3.12"
+pyrollup = "^0.1.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = "^8.3.2"
+black = "^24.8.0"
+mypy = "^1.11.2"
+
+[tool.black]
+line-length = 80
+
+[tool.pytest.ini_options]
+testpaths = ["test"]
+addopts = "--import-mode=importlib -s -v -rA"
+markers = [
+  "filename"
+]
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core"]