freeplane-and-yaml 0.1.1__py3-none-any.whl

freeplane_and_yaml/cli.py

@@ -0,0 +1,40 @@
+import sys
+import os
+from .convert import convert_yaml_file  # Import your conversion logic
+
+
+def main():
+    # Check for the correct number of arguments
+    if len(sys.argv) != 3:
+        print("Usage: convert input.yaml output_directory")
+        sys.exit(1)
+
+    # Parse arguments
+    input_file = sys.argv[1]
+    output_dir = sys.argv[2]
+
+    # Validate the input YAML file
+    if not input_file.endswith(".yaml"):
+        print(f"Error: {input_file} is not a valid YAML file.")
+        sys.exit(1)
+
+    if not os.path.isfile(input_file):
+        print(f"Error: Input file {input_file} does not exist.")
+        sys.exit(1)
+
+    # Validate the output directory
+    if not os.path.isdir(output_dir):
+        print(f"Error: Output directory {output_dir} does not exist.")
+        sys.exit(1)
+
+    # Generate the `.m` file name based on the input file
+    base_name = os.path.basename(input_file).replace(".yaml", ".mm")
+    output_file = os.path.join(output_dir, base_name)
+
+    # Perform the conversion
+    try:
+        convert_yaml_file(input_file, output_file)
+        print(f"Conversion complete: {output_file}")
+    except Exception as e:
+        print(f"Error during conversion: {e}")
+        sys.exit(1)

freeplane_and_yaml/convert.py

@@ -0,0 +1,100 @@
+import yaml
+from xml.etree.ElementTree import Element, SubElement, tostring
+from xml.dom import minidom
+import uuid
+import argparse
+import os
+
+def generate_node_id():
+    """Generate a unique ID for a node."""
+    return f"ID_{str(uuid.uuid4()).replace('-', '_')}"
+
+def create_note_element(note_text):
+    """Create a richcontent note element with the given text."""
+    richcontent = Element('richcontent', {
+        'TYPE': 'NOTE',
+        'CONTENT-TYPE': 'xml/'
+    })
+    html = SubElement(richcontent, 'html')
+    head = SubElement(html, 'head')
+    body = SubElement(html, 'body')
+    p = SubElement(body, 'p')
+    p.text = note_text
+    return richcontent
+
+def add_node_recursive(parent_element, node_data, position=None):
+    """Recursively add nodes to the mind map."""
+    # Create node element with basic attributes
+    node_attrs = {
+        'TEXT': node_data['title'],
+        'ID': generate_node_id()
+    }
+    if position:
+        node_attrs['POSITION'] = position
+
+    node = SubElement(parent_element, 'node', node_attrs)
+
+    # Add note if present
+    if 'note' in node_data:
+        node.append(create_note_element(node_data['note']))
+
+    # Process children if present
+    if 'children' in node_data:
+        # Alternate positions for children
+        positions = ['right', 'left']
+        position_index = 0
+        
+        for child_key, child_data in node_data['children'].items():
+            # Alternate between right and left for top-level children
+            child_position = positions[position_index % 2] if parent_element.tag == 'map' else None
+            position_index += 1
+            add_node_recursive(node, child_data, child_position)
+
+def converter(yaml_content):
+    """Convert YAML content to Freeplane mind map format."""
+    # Parse YAML content
+    data = yaml.safe_load(yaml_content)
+
+    # Create the base map element
+    map_elem = Element('map', {'version': '1.9.13'})
+
+    # Add the root node and its children
+    add_node_recursive(map_elem, data['root'])
+
+    # Convert to string and pretty print
+    rough_string = tostring(map_elem, 'utf-8')
+    reparsed = minidom.parseString(rough_string)
+    pretty_xml = reparsed.toprettyxml(indent="    ")
+
+    # Add XML declaration
+    if not pretty_xml.startswith('<?xml'):
+        pretty_xml = '<?xml version="1.0" encoding="UTF-8"?>\n' + pretty_xml
+
+    return pretty_xml
+
+def convert_yaml_file(yaml_file_path, output_file_path):
+    """Convert a YAML file to a Freeplane mind map file."""
+    with open(yaml_file_path, 'r', encoding='utf-8') as yaml_file:
+        yaml_content = yaml_file.read()
+    
+    mind_map_xml = converter(yaml_content)
+    
+    with open(output_file_path, 'w', encoding='utf-8') as mm_file:
+        mm_file.write(mind_map_xml)
+
+# Example usage:
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description='Convert YAML file to Freeplane mind map')
+    parser.add_argument('input_file', help='Input YAML file path')
+    parser.add_argument('output_dir', help='Output directory for the mind map file')
+    
+    args = parser.parse_args()
+    
+    # Create output directory if it doesn't exist
+    os.makedirs(args.output_dir, exist_ok=True)
+    
+    # Generate output filename based on input filename
+    input_basename = os.path.splitext(os.path.basename(args.input_file))[0]
+    output_file = os.path.join(args.output_dir, f"{input_basename}.mm")
+    
+    convert_yaml_file(args.input_file, output_file)

freeplane_and_yaml-0.1.1.dist-info/LICENSE

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

freeplane_and_yaml-0.1.1.dist-info/METADATA

@@ -0,0 +1,133 @@
+Metadata-Version: 2.1
+Name: freeplane-and-yaml
+Version: 0.1.1
+Summary: A tool to convert YAML files to Freeplane MM format
+Home-page: https://github.com/romilly/freeplane-and-yaml
+Author: Romilly Cocking
+Author-email: romilly.cocking@gmail.com
+License: MIT
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML
+
+# YAML to Freeplane Converter
+
+A Python tool that converts YAML files into Freeplane mind maps. This allows you to generate mind maps programmatically from structured YAML data.
+
+The YAML file can be created using [Claude AI](https://claude.ai/chat/). A suitable prompt is given [below](#converting-documents-to-mind-maps-using-claude-ai).
+
+You can read about how it got written using AI on [medium](https://medium.com/@romillyc/build-your-own-mind-map-tools-with-ai-b193564f2464?sk=b353aa7d16d6412e4aae8f3eab0ec554).
+That's a friend link so you can read it even if you're not a subscriber.
+
+## Installation
+
+First, clone this repository:
+
+```bash
+# clone the project from GitHub
+git clone https://github.com/romilly/freeplane-and-yaml.git
+cd freeplane-and-yaml
+```
+
+This project requires Python and should be run in a virtual environment:
+
+```bash
+# Create and activate virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows use: venv\Scripts\activate
+
+# Install required packages
+pip install pyyaml
+```
+
+## Usage
+
+The code should be run from the `src` directory after activating the virtual environment. Your YAML file should follow the schema defined in `schema/mindmap-schema.json`. Here's an example structure:
+
+```yaml
+root:
+  title: "Your Main Topic"
+  note: "Optional note for the main topic"
+  children:
+    subtopic1:
+      title: "Subtopic 1"
+      note: "Optional note for subtopic 1"
+      children:
+        # ... more nested topics
+    subtopic2:
+      title: "Subtopic 2"
+      # ... and so on
+```
+
+### YAML Schema Requirements
+
+The YAML must conform to these rules:
+- Must have a root node with a title and at least one child
+- Each node requires a title
+- Notes are optional
+- Child node keys must be alphanumeric (including underscores)
+- No additional properties are allowed beyond title, note, and children
+
+For full schema details, see `schema/mindmap-schema.json`.
+
+### Converting Documents to Mind Maps using Claude AI
+
+You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
+
+1. Share your document and the schema (from `schema/mindmap-schema.json`)with Claude Sonnet.
+2. Use this prompt:
+   ```
+   I've uploaded a document and a schema file.  I'd like you to summarise the document as a yaml file following the schema that I uploaded.
+   ```
+3. Claude will generate a YAML file that follows the schema
+4. Save Claude's output as a .yaml file
+5. Convert it to a mind map using this tool
+
+This workflow is useful for:
+- Summarizing academic papers
+- Converting product requirements documents (PRDs)
+- Creating structured summaries of technical documentation
+- Organizing research notes
+
+### Converting YAML to Mind Map
+
+To convert a YAML file to a Freeplane mind map:
+
+```python
+from freeplane_and_yaml.convert_yaml_to_freeplane import convert_yaml_file
+
+# Convert YAML to mind map
+convert_yaml_file('path/to/your/input.yaml', 'output.mm')
+```
+
+The generated `.mm` file can be opened in Freeplane. When you first open the file, Freeplane will show this warning dialog because the file wasn't created by Freeplane itself:
+
+![Freeplane Warning Dialog](images/warning-dialog.png)
+
+This is normal and expected — click OK to load the mind map.
+
+Here's an example of how the output looks:
+
+![Example Mind Map](images/Screenshot%20at%202025-02-12%2010-43-23.png)
+
+## Features
+
+- Converts YAML structured data to Freeplane mind map format
+- Supports hierarchical node structure
+- Includes node titles and optional notes
+- Automatically alternates between right and left positions for top-level nodes
+- Generates unique IDs for each node
+- Validates input against JSON schema
+
+## License
+
+Apologiresd to readers from the USA. This README uses UK spelling.
+
+This project is licensed under the MIT Licence — see the [LICENCE](LICENSE) file for details.
+
+

freeplane_and_yaml-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+freeplane_and_yaml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+freeplane_and_yaml/cli.py,sha256=qeUJXw2MqCf6Kv7c-K63-srGj339beL4JTrAXi5_-3c,1213
+freeplane_and_yaml/convert.py,sha256=dyQLt2FlmCgsQOnutnp1DyLXzqk-guazL8TZwTH0vHI,3440
+freeplane_and_yaml-0.1.1.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
+freeplane_and_yaml-0.1.1.dist-info/METADATA,sha256=rK9H4NH6Z7rx89SzQs8c-ZtccsPrztOl6ukMyJ0CO78,4420
+freeplane_and_yaml-0.1.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+freeplane_and_yaml-0.1.1.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
+freeplane_and_yaml-0.1.1.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
+freeplane_and_yaml-0.1.1.dist-info/RECORD,,

freeplane_and_yaml-0.1.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.45.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

freeplane_and_yaml-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+convert = freeplane_and_yaml.cli:main
+

freeplane_and_yaml-0.1.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+freeplane_and_yaml