markdown2jira 0.0.1__tar.gz

markdown2jira-0.0.1/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: markdown2jira
+Version: 0.0.1
+Summary: Convert Markdown to Jira wiki markup
+Keywords: markdown,jira,wiki markup,confluence
+Author: Abraham Murciano
+Author-email: Abraham Murciano <abrahammurciano@gmail.com>
+License-Expression: MIT
+Requires-Dist: wenmode>=0.15.1
+Requires-Python: >=3.14
+Project-URL: repository, https://github.com/abrahammurciano/python-markdown2jira
+Project-URL: documentation, https://abrahammurciano.github.io/python-markdown2jira/markdown2jira
+Description-Content-Type: text/markdown
+
+# markdown2jira
+Convert Markdown to Jira wiki markup
+
+## Installation
+
+You can install this package with pip.
+```sh
+$ pip install markdown2jira
+```
+
+## Links
+
+[![Documentation](https://img.shields.io/badge/Documentation-C61C3E?style=for-the-badge&logo=Read+the+Docs&logoColor=%23FFFFFF)](https://abrahammurciano.github.io/python-markdown2jira)
+
+[![Source Code - GitHub](https://img.shields.io/badge/Source_Code-GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=%23FFFFFF)](https://github.com/abrahammurciano/python-markdown2jira.git)
+
+[![PyPI - markdown2jira](https://img.shields.io/badge/PyPI-markdown2jira-006DAD?style=for-the-badge&logo=PyPI&logoColor=%23FFD242)](https://pypi.org/project/markdown2jira/)
+
+## Usage

markdown2jira-0.0.1/README.md

@@ -0,0 +1,19 @@
+# markdown2jira
+Convert Markdown to Jira wiki markup
+
+## Installation
+
+You can install this package with pip.
+```sh
+$ pip install markdown2jira
+```
+
+## Links
+
+[![Documentation](https://img.shields.io/badge/Documentation-C61C3E?style=for-the-badge&logo=Read+the+Docs&logoColor=%23FFFFFF)](https://abrahammurciano.github.io/python-markdown2jira)
+
+[![Source Code - GitHub](https://img.shields.io/badge/Source_Code-GitHub-181717?style=for-the-badge&logo=GitHub&logoColor=%23FFFFFF)](https://github.com/abrahammurciano/python-markdown2jira.git)
+
+[![PyPI - markdown2jira](https://img.shields.io/badge/PyPI-markdown2jira-006DAD?style=for-the-badge&logo=PyPI&logoColor=%23FFD242)](https://pypi.org/project/markdown2jira/)
+
+## Usage

markdown2jira-0.0.1/pyproject.toml

@@ -0,0 +1,122 @@
+[project]
+name = "markdown2jira"
+version = "0.0.1"
+description = "Convert Markdown to Jira wiki markup"
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.14"
+keywords = [
+    "markdown",
+    "jira",
+    "wiki markup",
+    "confluence",
+]
+dependencies = ["wenmode>=0.15.1"]
+
+[[project.authors]]
+name = "Abraham Murciano"
+email = "abrahammurciano@gmail.com"
+
+[project.urls]
+repository = "https://github.com/abrahammurciano/python-markdown2jira"
+documentation = "https://abrahammurciano.github.io/python-markdown2jira/markdown2jira"
+
+[dependency-groups]
+dev = [
+    "basedpyright",
+    "mypy",
+    "pdoc3",
+    "pytest",
+    "ruff",
+]
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["markdown2jira"]
+
+[tool.mypy]
+exclude = [
+    ".venv",
+    "venv",
+]
+
+[tool.basedpyright]
+reportUnusedCallResult = "none"
+reportAny = "none"
+reportIncompatibleUnannotatedOverride = "warning"
+reportUnannotatedClassAttribute = "none"
+reportUnusedParameter = "none"
+reportCallInDefaultInitializer = "none"
+reportExplicitAny = "none"
+reportInvalidCast = "none"
+reportUnknownLambdaType = "none"
+reportImportCycles = "hint"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "A001",
+    "A002",
+    "ANN401",
+    "C901",
+    "COM812",
+    "CPY001",
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D106",
+    "D107",
+    "D203",
+    "D213",
+    "D413",
+    "E501",
+    "EM101",
+    "EM102",
+    "G004",
+    "PLC0415",
+    "PLR0911",
+    "PLR0912",
+    "PLR0913",
+    "PLR2004",
+    "PT013",
+    "PYI025",
+    "S101",
+    "S104",
+    "S105",
+    "S311",
+    "S603",
+    "S608",
+    "TC001",
+    "TC002",
+    "TC003",
+    "TC006",
+    "TD002",
+    "TD003",
+    "TRY003",
+    "TRY400",
+]
+
+[tool.ruff.lint.flake8-annotations]
+allow-star-arg-any = true
+
+[tool.ruff.lint.flake8-pytest-style]
+parametrize-values-type = "tuple"
+parametrize-values-row-type = "tuple"
+
+[tool.ruff.lint.pylint]
+max-args = 10
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**.py" = ["ARG001"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true

markdown2jira-0.0.1/pyproject.toml.orig

@@ -0,0 +1,106 @@
+[project]
+name = "markdown2jira"
+# Version is overwritten at build time by CI based on git tag
+version = "0.0.1"
+description = "Convert Markdown to Jira wiki markup"
+authors = [{ name = "Abraham Murciano", email = "abrahammurciano@gmail.com" }]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.14"
+keywords = ["markdown", "jira", "wiki markup", "confluence"]
+dependencies = ["wenmode>=0.15.1"]
+
+[project.urls]
+repository = "https://github.com/abrahammurciano/python-markdown2jira"
+documentation = "https://abrahammurciano.github.io/python-markdown2jira/markdown2jira"
+
+[dependency-groups]
+dev = ["basedpyright", "mypy", "pdoc3", "pytest", "ruff"]
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["markdown2jira"]
+
+[tool.mypy]
+exclude = [".venv", "venv"]
+
+[tool.basedpyright]
+reportUnusedCallResult = "none"
+reportAny = "none"
+reportIncompatibleUnannotatedOverride = "warning"
+reportUnannotatedClassAttribute = "none"
+reportUnusedParameter = "none"
+reportCallInDefaultInitializer = "none"
+reportExplicitAny = "none"
+reportInvalidCast = "none"
+reportUnknownLambdaType = "none"
+reportImportCycles = "hint"
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+	"A001",
+	"A002",
+	"ANN401",
+	"C901",
+	"COM812",
+	"CPY001",
+	"D100",
+	"D101",
+	"D102",
+	"D103",
+	"D104",
+	"D105",
+	"D106",
+	"D107",
+	"D203",
+	"D213",
+	"D413",
+	"E501",
+	"EM101",
+	"EM102",
+	"G004",
+	"PLC0415",
+	"PLR0911",
+	"PLR0912",
+	"PLR0913",
+	"PLR2004",
+	"PT013",
+	"PYI025",
+	"S101",
+	"S104",
+	"S105",
+	"S311",
+	"S603",
+	"S608",
+	"TC001",
+	"TC002",
+	"TC003",
+	"TC006",
+	"TD002",
+	"TD003",
+	"TRY003",
+	"TRY400",
+]
+
+[tool.ruff.lint.flake8-annotations]
+allow-star-arg-any = true
+
+[tool.ruff.lint.flake8-pytest-style]
+parametrize-values-type = "tuple"
+parametrize-values-row-type = "tuple"
+
+[tool.ruff.lint.pylint]
+max-args = 10
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**.py" = ["ARG001"]
+
+[tool.ruff.lint.isort]
+split-on-trailing-comma = false
+
+[tool.ruff.format]
+skip-magic-trailing-comma = true

markdown2jira-0.0.1/src/markdown2jira/__init__.py

@@ -0,0 +1,12 @@
+"""Convert Markdown to Jira wiki markup.
+
+.. include:: ../../README.md
+"""
+
+from importlib import metadata
+
+from ._convert import Markdown2Jira, convert
+from ._renderer import JiraRenderContext, JiraRenderer
+
+__version__ = metadata.version(__package__ or __name__)
+__all__ = ["JiraRenderContext", "JiraRenderer", "Markdown2Jira", "convert"]

markdown2jira-0.0.1/src/markdown2jira/_convert.py

@@ -0,0 +1,55 @@
+from collections.abc import Iterable
+from types import ModuleType
+
+from wenmode import Wenmode
+from wenmode.plugins import PluginModule
+from wenmode.presets import PresetFactory, github
+from wenmode.renderers import BaseRenderer
+from wenmode.rules import Rule
+
+from ._renderer import JiraRenderer
+
+
+class Markdown2Jira:
+    """Converts Markdown to Jira wiki markup, with configurable parsing rules and rendering.
+
+    Args:
+        rules: The Markdown parsing rules to use. Defaults to the GitHub preset (tables, task lists, strikethrough, auto-links, footnotes).
+        renderer: The renderer used to turn the parsed Markdown into Jira wiki markup. Defaults to `JiraRenderer`. Subclass `JiraRenderer` to support custom node types.
+        plugins: Wenmode plugins to extend parsing with, e.g. for custom syntax.
+        positions: Whether to track source positions on parsed nodes.
+    """
+
+    def __init__(
+        self,
+        rules: Iterable[type[Rule] | Rule] | PresetFactory | None = None,
+        *,
+        renderer: BaseRenderer | None = None,
+        plugins: Iterable[PluginModule | ModuleType] = (),
+        positions: bool = False,
+    ) -> None:
+        self._wenmode = Wenmode(
+            rules if rules is not None else github(),
+            renderer=renderer or JiraRenderer(),
+            plugins=plugins,
+            positions=positions,
+        )
+
+    def convert(self, content: str) -> str:
+        """Convert a Markdown string to Jira wiki markup."""
+        return self._wenmode.render(content).strip("\n")
+
+
+_default = Markdown2Jira()
+
+
+def convert(content: str) -> str:
+    """Convert a Markdown string to Jira wiki markup, using the default rules and renderer.
+
+    Args:
+        content: The Markdown source to convert.
+
+    Returns:
+        The equivalent Jira wiki markup.
+    """
+    return _default.convert(content)

markdown2jira-0.0.1/src/markdown2jira/_renderer.py

@@ -0,0 +1,208 @@
+from dataclasses import dataclass, field
+from typing import override
+
+from wenmode.nodes import (
+    Blockquote,
+    Break,
+    Code,
+    Delete,
+    Emphasis,
+    Heading,
+    Html,
+    Image,
+    InlineCode,
+    Link,
+    List,
+    ListItem,
+    Node,
+    Paragraph,
+    Strong,
+    Table,
+    TableCell,
+    TableRow,
+    Text,
+    ThematicBreak,
+)
+from wenmode.renderers import BaseRenderer, RenderContext
+
+
+@dataclass
+class JiraRenderContext(RenderContext):
+    list_markers: list[str] = field(default_factory=list)
+
+
+class JiraRenderer(BaseRenderer):
+    name = "jira"
+
+    @override
+    def create_context(self, node: Node | None = None) -> JiraRenderContext:
+        return JiraRenderContext()
+
+
+@JiraRenderer.register("paragraph")
+def render_paragraph(
+    renderer: JiraRenderer, node: Paragraph, context: JiraRenderContext
+) -> str:
+    return renderer.render_children(node.children, context) + "\n\n"
+
+
+@JiraRenderer.register("heading")
+def render_heading(
+    renderer: JiraRenderer, node: Heading, context: JiraRenderContext
+) -> str:
+    depth = min(max(node.depth, 1), 6)
+    title = renderer.render_children(node.children, context)
+    return f"h{depth}. {title}\n\n"
+
+
+@JiraRenderer.register("blockquote")
+def render_blockquote(
+    renderer: JiraRenderer, node: Blockquote, context: JiraRenderContext
+) -> str:
+    body = renderer.render_children(node.children, context).rstrip("\n")
+    return f"{{quote}}\n{body}\n{{quote}}\n\n"
+
+
+@JiraRenderer.register("thematicBreak")
+def render_thematic_break(
+    _renderer: JiraRenderer, _node: ThematicBreak, _context: JiraRenderContext
+) -> str:
+    return "----\n\n"
+
+
+@JiraRenderer.register("html")
+def render_html(
+    _renderer: JiraRenderer, node: Html, _context: JiraRenderContext
+) -> str:
+    value = node.value.rstrip("\n")
+    return f"{{noformat}}\n{value}\n{{noformat}}\n\n"
+
+
+@JiraRenderer.register("text")
+def render_text(
+    _renderer: JiraRenderer, node: Text, _context: JiraRenderContext
+) -> str:
+    return node.value
+
+
+@JiraRenderer.register("inlineCode")
+def render_inline_code(
+    _renderer: JiraRenderer, node: InlineCode, _context: JiraRenderContext
+) -> str:
+    return "{{" + node.value + "}}"
+
+
+@JiraRenderer.register("strong")
+def render_strong(
+    renderer: JiraRenderer, node: Strong, context: JiraRenderContext
+) -> str:
+    return "*" + renderer.render_children(node.children, context) + "*"
+
+
+@JiraRenderer.register("emphasis")
+def render_emphasis(
+    renderer: JiraRenderer, node: Emphasis, context: JiraRenderContext
+) -> str:
+    return "_" + renderer.render_children(node.children, context) + "_"
+
+
+@JiraRenderer.register("delete")
+def render_delete(
+    renderer: JiraRenderer, node: Delete, context: JiraRenderContext
+) -> str:
+    return "-" + renderer.render_children(node.children, context) + "-"
+
+
+@JiraRenderer.register("link")
+def render_link(renderer: JiraRenderer, node: Link, context: JiraRenderContext) -> str:
+    text = renderer.render_children(node.children, context)
+    if node.title:
+        return f"[{text}|{node.url}|{node.title}]"
+    return f"[{text}|{node.url}]"
+
+
+@JiraRenderer.register("image")
+def render_image(
+    _renderer: JiraRenderer, node: Image, _context: JiraRenderContext
+) -> str:
+    if node.alt:
+        return f"!{node.url}|alt={node.alt}!"
+    return f"!{node.url}!"
+
+
+@JiraRenderer.register("break")
+def render_break(
+    _renderer: JiraRenderer, _node: Break, _context: JiraRenderContext
+) -> str:
+    return "\\\\\n"
+
+
+@JiraRenderer.register("code")
+def render_code(
+    _renderer: JiraRenderer, node: Code, _context: JiraRenderContext
+) -> str:
+    header = f"{{code:{node.lang}}}" if node.lang else "{code}"
+    code = node.value if node.value.endswith("\n") else node.value + "\n"
+    return f"{header}\n{code}{{code}}\n\n"
+
+
+@JiraRenderer.register("list")
+def render_list(renderer: JiraRenderer, node: List, context: JiraRenderContext) -> str:
+    context.list_markers.append("#" if node.ordered else "*")
+    text = renderer.render_children(node.children, context)
+    context.list_markers.pop()
+    return text if context.list_markers else text + "\n"
+
+
+@JiraRenderer.register("listItem")
+def render_list_item(
+    renderer: JiraRenderer, node: ListItem, context: JiraRenderContext
+) -> str:
+    marker = "".join(context.list_markers)
+    if node.checked is not None:
+        marker += " [x]" if node.checked else " [ ]"
+    parts: list[str] = []
+    for child in node.children:
+        if isinstance(child, List):
+            parts.append(renderer.render_node(child, context))
+        else:
+            text = renderer.render_node(child, context).rstrip("\n")
+            parts.append(f"{marker} {text}\n")
+    return "".join(parts)
+
+
+@JiraRenderer.register("table")
+def render_table(
+    renderer: JiraRenderer, node: Table, context: JiraRenderContext
+) -> str:
+    rows = [child for child in node.children if isinstance(child, TableRow)]
+    if not rows:
+        return ""
+    head, *body = rows
+    lines = [render_table_head(renderer, head, context)]
+    lines.extend(render_table_row(renderer, row, context) for row in body)
+    return "".join(lines) + "\n"
+
+
+def table_row_cells(row: TableRow) -> list[TableCell]:
+    return [cell for cell in row.children if isinstance(cell, TableCell)]
+
+
+def render_table_head(
+    renderer: JiraRenderer, row: TableRow, context: JiraRenderContext
+) -> str:
+    cells = "".join(
+        "||" + renderer.render_children(cell.children, context)
+        for cell in table_row_cells(row)
+    )
+    return cells + "||\n"
+
+
+def render_table_row(
+    renderer: JiraRenderer, row: TableRow, context: JiraRenderContext
+) -> str:
+    cells = "".join(
+        "|" + renderer.render_children(cell.children, context)
+        for cell in table_row_cells(row)
+    )
+    return cells + "|\n"

markdown2jira-0.0.1/src/markdown2jira/py.typed

@@ -0,0 +1 @@
+