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

{freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplane-and-yaml
-Version: 0.1.1
+Version: 0.1.3
 Summary: A tool to convert YAML files to Freeplane MM format
 Home-page: https://github.com/romilly/freeplane-and-yaml
 Author: Romilly Cocking
@@ -26,28 +26,98 @@ 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
+# Create and activate virtual environment in the direcoty of your choice
 python -m venv venv
 source venv/bin/activate  # On Windows use: venv\Scripts\activate
-
-# Install required packages
-pip install pyyaml
+pip install freeplane-and-yaml
 ```
 
+
 ## 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:
+Your YAML file should follow this schema:
+
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Mind Map Schema",
+  "description": "Schema for Freeplane-compatible mind map YAML format",
+  
+  "definitions": {
+    "node": {
+      "type": "object",
+      "required": ["title"],
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "The display text for the node"
+        },
+        "note": {
+          "type": "string",
+          "description": "Rich text note attached to the node"
+        },
+        "children": {
+          "type": "object",
+          "description": "Child nodes of this node",
+          "patternProperties": {
+            "^[a-zA-Z0-9_]+$": {
+              "$ref": "#/definitions/node"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+
+  "type": "object",
+  "required": ["root"],
+  "properties": {
+    "root": {
+      "allOf": [
+        { "$ref": "#/definitions/node" },
+        { 
+          "required": ["children"],
+          "description": "The root node must have at least one child"
+        }
+      ]
+    }
+  },
+  "additionalProperties": false,
+
+  "examples": [
+    {
+      "root": {
+        "title": "Example Mind Map",
+        "note": "This is the root node",
+        "children": {
+          "topic1": {
+            "title": "First Topic",
+            "note": "Note for first topic",
+            "children": {
+              "subtopic1": {
+                "title": "Subtopic 1",
+                "note": "Note for subtopic"
+              }
+            }
+          },
+          "topic2": {
+            "title": "Second Topic",
+            "note": "Note for second topic"
+          }
+        }
+      }
+    }
+  ]
+}
+
+```
+
+Here's an example structure:
 
 ```yaml
 root:
@@ -64,6 +134,16 @@ root:
       # ... and so on
 ```
 
+### Converting YAML to Mind Map
+
+To convert a YAML file to a Freeplane mind map:
+
+```bash
+
+# Convert YAML and store mind map in temp
+convert data/marr.yaml temp
+```
+
 ### YAML Schema Requirements
 
 The YAML must conform to these rules:
@@ -73,13 +153,13 @@ The YAML must conform to these rules:
 - 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`.
+For full schema details, see above.
 
-### Converting Documents to Mind Maps using Claude AI
+### Converting Documents to YAML 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.
+1. Share your document and the schema (above) 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.
@@ -94,16 +174,6 @@ This workflow is useful for:
 - 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:
 
@@ -126,7 +196,7 @@ Here's an example of how the output looks:
 
 ## License
 
-Apologiresd to readers from the USA. This README uses UK spelling.
+_Apologies 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.3.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.3.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
+freeplane_and_yaml-0.1.3.dist-info/METADATA,sha256=MCf8NWb6YiHUf6K22xJy_sGOOoSI9TNiyXdw5Mb_rEc,5751
+freeplane_and_yaml-0.1.3.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+freeplane_and_yaml-0.1.3.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
+freeplane_and_yaml-0.1.3.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
+freeplane_and_yaml-0.1.3.dist-info/RECORD,,

freeplane_and_yaml-0.1.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-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,,