xmind2markdown 0.0.0__tar.gz

xmind2markdown-0.0.0/.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build package
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/xmind2markdown
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

xmind2markdown-0.0.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.pyc
+.env
+.venv
+.dist/
+build/
+src/xmind2markdown.egg-info/**

xmind2markdown-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Frithjof Engel
+
+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.

xmind2markdown-0.0.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: xmind2markdown
+Version: 0.0.0
+Summary: XMind to Markdown converter
+Author-email: Frithjof Engel <frithjof@fms-engel.de>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Dynamic: license-file

xmind2markdown-0.0.0/README.md

@@ -0,0 +1,21 @@
+# xmind2markdown
+
+xmind2markdown converts XMind mindmap files to markdown format. Useful for migrating to PKMS like Obsidian or other markdown-based systems. 
+
+## Features
+- converts mindmap leaves to markdown headlines (`#`, `##`, …)
+- (limited) support for XMind icons/markers (e.g. task status, priority, ...)
+- supports the XMmind 2020+ format (JSON)
+
+## Installation
+```
+pip install xmind2markdown
+```
+
+## Usage
+```
+xmind2markdown input.xmind output.md
+```
+
+## License
+MIT License

xmind2markdown-0.0.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "xmind2markdown"
+authors = [
+  { name="Frithjof Engel", email="frithjof@fms-engel.de" },
+]
+dynamic = ["version"]
+description = "XMind to Markdown converter" 
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+
+[project.scripts]
+xmind2markdown = "xmind2markdown:main"
+

xmind2markdown-0.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

xmind2markdown-0.0.0/src/xmind2markdown.egg-info/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: xmind2markdown
+Version: 0.0.0
+Summary: XMind to Markdown converter
+Author-email: Frithjof Engel <frithjof@fms-engel.de>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Dynamic: license-file

xmind2markdown-0.0.0/src/xmind2markdown.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+.github/workflows/release.yml
+src/xmind2markdown.py
+src/xmind2markdown.egg-info/PKG-INFO
+src/xmind2markdown.egg-info/SOURCES.txt
+src/xmind2markdown.egg-info/dependency_links.txt
+src/xmind2markdown.egg-info/entry_points.txt
+src/xmind2markdown.egg-info/top_level.txt
+tests/test.md
+tests/test_smoke.py
+tests/testfile.md
+tests/testfile.xmind
+tests/xmind2markdown.py

xmind2markdown-0.0.0/src/xmind2markdown.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

xmind2markdown-0.0.0/src/xmind2markdown.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+xmind2markdown = xmind2markdown:main

xmind2markdown-0.0.0/src/xmind2markdown.egg-info/top_level.txt

@@ -0,0 +1 @@
+xmind2markdown

xmind2markdown-0.0.0/src/xmind2markdown.py

@@ -0,0 +1,98 @@
+import zipfile
+import json
+from pathlib import Path
+
+MARKER_MAP = {
+    "task-start": "○",
+    "task-quarter": "◔",
+    "task-half": "◑",
+    "task-3quar": "◕",
+    "task-done": "✔",
+
+    "task-oct": "○",    # TODO: Find unicode symbol for octets
+    "task-3oct": "◔",   # TODO: Find unicode symbol for octets
+    "task-5oct": "◑",   # TODO: Find unicode symbol for octets
+    "task-7oct": "◕",   # TODO: Find unicode symbol for octets
+
+    "priority-1": "①",
+    "priority-2": "②",
+    "priority-3": "③",
+    "priority-4": "④",
+    "priority-5": "⑤",
+    "priority-6": "⑥",
+    "priority-7": "⑦",
+    "priority-8": "⑧",
+    "priority-9": "⑨",
+
+    "symbol-star": "⭐",
+    "symbol-exclam": "❗",
+    "symbol-wrong" : "❌)", 
+
+    "flag-red": "🚩", 
+}
+
+def markdown_heading(text: str, level: int) -> str:
+    return f"{'#' * level} {text}\n\n"
+
+def markdown_note(note: str) -> str:
+    return f"> {note.strip()}\n\n"
+
+def xmind_to_markdown(zf: zipfile.ZipFile) -> str:
+    content = json.loads(zf.read("content.json"))
+    markdown = []
+
+    def extract_markers(topic: dict) -> str:
+        markers_str = ""
+        for m in topic.get("markers", []):
+            marker = m["markerId"]
+            if marker in MARKER_MAP:
+                 markers_str += MARKER_MAP[marker]
+            else: 
+                print("Marker could not be converted: "+marker)
+     
+        return markers_str
+
+
+    def parse_topic(topic, level=1):
+        markers = extract_markers(topic)
+        title = markers + topic.get("title", "Untitled")
+
+        markdown.append(markdown_heading(title, level))
+
+        note = topic.get("notes", {}).get("plain", {}).get("content")
+        if note:
+            markdown.append(markdown_note(note))
+
+        for child in topic.get("children", {}).get("attached", []):
+            parse_topic(child, level + 1)
+
+    for sheet in content:
+        parse_topic(sheet["rootTopic"])
+
+    return "".join(markdown)
+
+def convert_xmind2markdown(xmind_file: Path, markdown_file: Path):
+        with zipfile.ZipFile(xmind_file) as zf:
+            if "content.json" in zf.namelist():
+                markdown = xmind_to_markdown(zf)
+                markdown_file.write_text(markdown, encoding="utf-8")
+            else:
+                raise RuntimeError("XMind file could not be opened. Only XMind Files in modern format are supported.")
+
+# -----------------------------
+# CLI entry point
+# -----------------------------
+def main(): 
+    import sys
+    
+    if len(sys.argv) == 3:
+        xmind_file = Path(sys.argv[1])
+        markdown_file = Path(sys.argv[2])
+        convert_xmind2markdown(xmind_file, markdown_file)
+        print("XMind file was converted to "+markdown_file.name)
+    else:
+        print("Usage: xmind2markdown input.xmind output.md")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()

xmind2markdown-0.0.0/tests/test.md

@@ -0,0 +1,14 @@
+# Title
+
+## ◑①H1
+
+### ○H2
+
+#### ✔H3
+
+## ○H1-1
+
+### ②H2-1
+
+#### ❌)H3-1
+

xmind2markdown-0.0.0/tests/test_smoke.py

@@ -0,0 +1,16 @@
+def test_import():
+    import sys, os
+    from pathlib import Path
+    import xmind2markdown
+    exit_value = 0
+    output_md = Path("output.md")
+    xmind2markdown.convert_xmind2markdown(Path("testfile.xmind"), output_md)
+    testfile_md = Path("testfile.md")
+    if output_md.read_text() != testfile_md.read_text(): 
+        exit_value = 1
+    
+    os.remove("output.md")
+    sys.exit(exit_value)
+
+if __name__ == '__main__':
+    test_import()

xmind2markdown-0.0.0/tests/testfile.md

@@ -0,0 +1,14 @@
+# Title
+
+## ◑①H1
+
+### ○H2
+
+#### ✔H3
+
+## ○H1-1
+
+### ②H2-1
+
+#### ❌)H3-1
+

xmind2markdown-0.0.0/tests/xmind2markdown.py

@@ -0,0 +1,98 @@
+import zipfile
+import json
+from pathlib import Path
+
+MARKER_MAP = {
+    "task-start": "○",
+    "task-quarter": "◔",
+    "task-half": "◑",
+    "task-3quar": "◕",
+    "task-done": "✔",
+
+    "task-oct": "○",    # TODO: Find unicode symbol for octets
+    "task-3oct": "◔",   # TODO: Find unicode symbol for octets
+    "task-5oct": "◑",   # TODO: Find unicode symbol for octets
+    "task-7oct": "◕",   # TODO: Find unicode symbol for octets
+
+    "priority-1": "①",
+    "priority-2": "②",
+    "priority-3": "③",
+    "priority-4": "④",
+    "priority-5": "⑤",
+    "priority-6": "⑥",
+    "priority-7": "⑦",
+    "priority-8": "⑧",
+    "priority-9": "⑨",
+
+    "symbol-star": "⭐",
+    "symbol-exclam": "❗",
+    "symbol-wrong" : "❌)", 
+
+    "flag-red": "🚩", 
+}
+
+def markdown_heading(text: str, level: int) -> str:
+    return f"{'#' * level} {text}\n\n"
+
+def markdown_note(note: str) -> str:
+    return f"> {note.strip()}\n\n"
+
+def xmind_to_markdown(zf: zipfile.ZipFile) -> str:
+    content = json.loads(zf.read("content.json"))
+    markdown = []
+
+    def extract_markers(topic: dict) -> str:
+        markers_str = ""
+        for m in topic.get("markers", []):
+            marker = m["markerId"]
+            if marker in MARKER_MAP:
+                 markers_str += MARKER_MAP[marker]
+            else: 
+                print("Marker could not be converted: "+marker)
+     
+        return markers_str
+
+
+    def parse_topic(topic, level=1):
+        markers = extract_markers(topic)
+        title = markers + topic.get("title", "Untitled")
+
+        markdown.append(markdown_heading(title, level))
+
+        note = topic.get("notes", {}).get("plain", {}).get("content")
+        if note:
+            markdown.append(markdown_note(note))
+
+        for child in topic.get("children", {}).get("attached", []):
+            parse_topic(child, level + 1)
+
+    for sheet in content:
+        parse_topic(sheet["rootTopic"])
+
+    return "".join(markdown)
+
+def convert_xmind2markdown(xmind_file: Path, markdown_file: Path):
+        with zipfile.ZipFile(xmind_file) as zf:
+            if "content.json" in zf.namelist():
+                markdown = xmind_to_markdown(zf)
+                markdown_file.write_text(markdown, encoding="utf-8")
+            else:
+                raise RuntimeError("XMind file could not be opened. Only XMind Files in modern format are supported.")
+
+# -----------------------------
+# CLI entry point
+# -----------------------------
+def main(): 
+    import sys
+    
+    if len(sys.argv) == 3:
+        xmind_file = Path(sys.argv[1])
+        markdown_file = Path(sys.argv[2])
+        convert_xmind2markdown(xmind_file, markdown_file)
+        print("XMind file was converted to "+markdown_file.name)
+    else:
+        print("Usage: xmind2markdown input.xmind output.md")
+        sys.exit(1)
+
+if __name__ == '__main__':
+    main()