marklassian 0.1.0__tar.gz

marklassian-0.1.0/.claude/settings.local.json

@@ -0,0 +1,10 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv sync:*)",
+      "Bash(uv run pytest:*)",
+      "Bash(uv run python:*)",
+      "Bash(tree:*)"
+    ]
+  }
+}

marklassian-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+*.log

marklassian-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

marklassian-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Michał Brotoń
+
+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.

marklassian-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: marklassian
+Version: 0.1.0
+Summary: Convert Markdown to Atlassian Document Format (ADF)
+Project-URL: Homepage, https://github.com/mbroton/marklassian-py
+Project-URL: Repository, https://github.com/mbroton/marklassian-py
+Author-email: Michał Brotoń <michal@broton.dev>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: adf,atlassian,confluence,jira,markdown
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Markup :: Markdown
+Requires-Python: >=3.10
+Requires-Dist: mistune>=3.0.0
+Description-Content-Type: text/markdown
+
+# marklassian-py
+
+A lightweight Python library that converts Markdown to the [Atlassian Document Format (ADF)](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Built for easy integration with Atlassian products like Jira and Confluence.
+
+This is a Python port of the excellent [marklassian](https://github.com/jamsinclair/marklassian) JavaScript library by [@jamsinclair](https://github.com/jamsinclair).
+
+## Features
+
+- Convert Markdown to ADF with a single function call
+- Support for common Markdown syntax including GFM task lists
+- Minimal dependencies (only [mistune](https://github.com/lepture/mistune))
+- Full type hints for IDE support
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install marklassian
+```
+
+Or with uv:
+
+```bash
+uv add marklassian
+```
+
+## Usage
+
+```python
+from marklassian import markdown_to_adf
+
+markdown = "# Hello World\n\nThis is **bold** and *italic* text."
+adf = markdown_to_adf(markdown)
+```
+
+The result is a dictionary that can be serialized to JSON:
+
+```python
+import json
+print(json.dumps(adf, indent=2))
+```
+
+## Supported Markdown Features
+
+- Headings (H1-H6)
+- Paragraphs and line breaks
+- Emphasis (bold, italic, strikethrough)
+- Links and images
+- Inline code and code blocks with language support
+- Ordered and unordered lists with nesting
+- Blockquotes
+- Horizontal rules
+- Tables
+- Task lists (GitHub Flavored Markdown)
+
+## API Reference
+
+### `markdown_to_adf(markdown: str) -> AdfDocument`
+
+Converts a Markdown string to an ADF document object.
+
+### Types
+
+```python
+class AdfMark(TypedDict, total=False):
+    type: Required[str]
+    attrs: dict[str, Any]
+
+class AdfNode(TypedDict, total=False):
+    type: Required[str]
+    attrs: dict[str, Any]
+    content: list[AdfNode]
+    marks: list[AdfMark]
+    text: str
+
+class AdfDocument(TypedDict):
+    version: Literal[1]
+    type: Literal["doc"]
+    content: list[AdfNode]
+```
+
+## Caveats
+
+This library aims to provide a lightweight and mostly accurate conversion from Markdown to ADF.
+
+For complex Markdown documents or strict ADF conformance requirements, consider using the official Atlassian libraries. Note that those are heavier dependencies.
+
+## References
+
+- [Atlassian Document Format Reference](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)
+- [ADF Interactive Builder](https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/)
+- [Original marklassian (JavaScript)](https://github.com/jamsinclair/marklassian)
+
+## Credits
+
+This library is a Python port of [marklassian](https://github.com/jamsinclair/marklassian) by [Jamie Sinclair](https://github.com/jamsinclair). All credit for the original implementation and conversion logic goes to them.
+
+## License
+
+MIT - see [LICENSE](LICENSE) for details.

marklassian-0.1.0/README.md

@@ -0,0 +1,100 @@
+# marklassian-py
+
+A lightweight Python library that converts Markdown to the [Atlassian Document Format (ADF)](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Built for easy integration with Atlassian products like Jira and Confluence.
+
+This is a Python port of the excellent [marklassian](https://github.com/jamsinclair/marklassian) JavaScript library by [@jamsinclair](https://github.com/jamsinclair).
+
+## Features
+
+- Convert Markdown to ADF with a single function call
+- Support for common Markdown syntax including GFM task lists
+- Minimal dependencies (only [mistune](https://github.com/lepture/mistune))
+- Full type hints for IDE support
+- Python 3.10+
+
+## Installation
+
+```bash
+pip install marklassian
+```
+
+Or with uv:
+
+```bash
+uv add marklassian
+```
+
+## Usage
+
+```python
+from marklassian import markdown_to_adf
+
+markdown = "# Hello World\n\nThis is **bold** and *italic* text."
+adf = markdown_to_adf(markdown)
+```
+
+The result is a dictionary that can be serialized to JSON:
+
+```python
+import json
+print(json.dumps(adf, indent=2))
+```
+
+## Supported Markdown Features
+
+- Headings (H1-H6)
+- Paragraphs and line breaks
+- Emphasis (bold, italic, strikethrough)
+- Links and images
+- Inline code and code blocks with language support
+- Ordered and unordered lists with nesting
+- Blockquotes
+- Horizontal rules
+- Tables
+- Task lists (GitHub Flavored Markdown)
+
+## API Reference
+
+### `markdown_to_adf(markdown: str) -> AdfDocument`
+
+Converts a Markdown string to an ADF document object.
+
+### Types
+
+```python
+class AdfMark(TypedDict, total=False):
+    type: Required[str]
+    attrs: dict[str, Any]
+
+class AdfNode(TypedDict, total=False):
+    type: Required[str]
+    attrs: dict[str, Any]
+    content: list[AdfNode]
+    marks: list[AdfMark]
+    text: str
+
+class AdfDocument(TypedDict):
+    version: Literal[1]
+    type: Literal["doc"]
+    content: list[AdfNode]
+```
+
+## Caveats
+
+This library aims to provide a lightweight and mostly accurate conversion from Markdown to ADF.
+
+For complex Markdown documents or strict ADF conformance requirements, consider using the official Atlassian libraries. Note that those are heavier dependencies.
+
+## References
+
+- [Atlassian Document Format Reference](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/)
+- [ADF Interactive Builder](https://developer.atlassian.com/cloud/jira/platform/apis/document/playground/)
+- [Original marklassian (JavaScript)](https://github.com/jamsinclair/marklassian)
+
+## Credits
+
+This library is a Python port of [marklassian](https://github.com/jamsinclair/marklassian) by [Jamie Sinclair](https://github.com/jamsinclair). All credit for the original implementation and conversion logic goes to them.
+
+## License
+
+MIT - see [LICENSE](LICENSE) for details.

marklassian-0.1.0/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "marklassian"
+version = "0.1.0"
+description = "Convert Markdown to Atlassian Document Format (ADF)"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "Michał Brotoń", email = "michal@broton.dev" }]
+keywords = ["markdown", "adf", "atlassian", "jira", "confluence"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Text Processing :: Markup :: Markdown",
+]
+dependencies = ["mistune>=3.0.0"]
+
+[project.urls]
+Homepage = "https://github.com/mbroton/marklassian-py"
+Repository = "https://github.com/mbroton/marklassian-py"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/marklassian"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[dependency-groups]
+dev = ["pytest>=8.0.0"]

marklassian-0.1.0/src/marklassian/__init__.py

@@ -0,0 +1,7 @@
+from importlib.metadata import version
+
+from .converter import markdown_to_adf
+from .types import AdfDocument, AdfMark, AdfNode
+
+__all__ = ["markdown_to_adf", "AdfDocument", "AdfMark", "AdfNode"]
+__version__ = version("marklassian")