Skip to main content

PyPlane

PyPlane is a small Python library and desktop editor for Freeplane-compatible mind maps. The object model and .mm reader have no third-party dependencies; the optional desktop application uses PySide6.

Install

python -m pip install pyplane-mindmap
python -m pip install 'pyplane-mindmap[ui]'  # include the desktop editor

Python 3.10 or newer is required. Start the editor with pyplane.

Use from Python

import pyplane

mindmap = pyplane.MindMap("Project")
backend = mindmap.root.add_child("Backend", side="right")
backend.add_child("Database", note="Choose storage")
mindmap.root.add_child("Research", side="left", link="https://example.com")
mindmap.save("project.mm")

loaded = pyplane.load("project.mm")
for node in loaded.walk():
    print(node.text)

NodeStyle supports a deliberately small presentation set: foreground and background colors, bold, italic, font size, shape, and basic edge styling. Unknown Freeplane XML attached to surviving nodes is retained when a map is loaded, edited, and saved.

Desktop shortcuts

Action Shortcut
Add child / sibling Tab / Enter
Rename / delete F2 / Delete
Cut / copy / paste subtree Ctrl+X / Ctrl+C / Ctrl+V
Fold or unfold Space
Navigate visible nodes Arrow keys
Search Ctrl+F
Save Ctrl+S
Undo / redo Ctrl+Z / Ctrl+Y
Zoom in / out Ctrl++ / Ctrl+-
Fit map Ctrl+0
Zoom Ctrl+mouse wheel

PyPlane intentionally does not attempt to reproduce Freeplane's plugins, formulas, scripting, clouds, icon library, or advanced rich-text features.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyplane_mindmap-0.1.0.tar.gz (19.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyplane_mindmap-0.1.0-py3-none-any.whl (18.8 kB view details)

Uploaded Python 3

File details

Details for the file pyplane_mindmap-0.1.0.tar.gz.

File metadata

  • Download URL: pyplane_mindmap-0.1.0.tar.gz
  • Upload date:
  • Size: 19.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for pyplane_mindmap-0.1.0.tar.gz
Algorithm Hash digest
SHA256 bbb5bd581dd307328366d076c1d282a15f21a97bda84d6151f6d93ebca45f50b
MD5 0f2cb191641628373afee763849b794f
BLAKE2b-256 6ccb7ef604486da2f21410f5dbc38f4fb7c178bd2b69e62cfed3a1e0526d4441

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyplane_mindmap-0.1.0.tar.gz:

Publisher: publish.yml on oyvinrog/pyplane

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyplane_mindmap-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pyplane_mindmap-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e510435f5436f416fe48c5c7fe92dea86386253f11fccc693e16cfb5213d78b
MD5 3b513667c2c761e98f156f1bb8e9aa5a
BLAKE2b-256 1698666f3506e930e306aae2d56f58d183b239d6b4df6a95425ba1875484e79c

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyplane_mindmap-0.1.0-py3-none-any.whl:

Publisher: publish.yml on oyvinrog/pyplane

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page