freeplane-and-yaml 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

{freeplane_and_yaml-0.1.2.dist-info → freeplane_and_yaml-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplane-and-yaml
-Version: 0.1.2
+Version: 0.1.4
 Summary: A tool to convert YAML files to Freeplane MM format
 Home-page: https://github.com/romilly/freeplane-and-yaml
 Author: Romilly Cocking
@@ -19,10 +19,11 @@ Requires-Dist: PyYAML
 
 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).
+The YAML file can be created using [Claude AI](https://claude.ai/chat/). 
+A suitable prompt is given [below](https://github.com/romilly/freeplane-and-yaml?tab=readme-ov-file#converting-documents-to-yaml-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.
+That's a _friend link_ so you can read it even if you're not a subscriber.
 
 ## Installation
 
@@ -38,21 +39,83 @@ pip install freeplane-and-yaml
 
 ## Usage
 
-Your YAML file should follow [this schema](src/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
+Your YAML file should follow this [schema](https://raw.githubusercontent.com/romilly/freeplane-and-yaml/refs/heads/main/src/schema/mindmap-schema.json). It includes an example.
+
+```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"
+          }
+        }
+      }
+    }
+  ]
+}
+
 ```
 
 ### Converting YAML to Mind Map
@@ -65,22 +128,22 @@ To convert a YAML file to a Freeplane mind map:
 convert data/marr.yaml temp
 ```
 
-### YAML Schema Requirements
+### YAML Schema requirements explained
 
-The YAML must conform to these rules:
+As the schema specifies, 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](src/schema/mindmap-schema.json).
+For full schema details, see above.
 
 ### 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](src/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.

freeplane_and_yaml-0.1.4.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.4.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
+freeplane_and_yaml-0.1.4.dist-info/METADATA,sha256=BVBe-V68MU9x5nvP1OZQD5cZHcjZqXgOtpZrOG7_7l4,5656
+freeplane_and_yaml-0.1.4.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+freeplane_and_yaml-0.1.4.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
+freeplane_and_yaml-0.1.4.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
+freeplane_and_yaml-0.1.4.dist-info/RECORD,,

freeplane_and_yaml-0.1.2.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.2.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
-freeplane_and_yaml-0.1.2.dist-info/METADATA,sha256=kTtNNw4SJFhFIfUbpOrMunKQnElit7T7zq08zrzuUzI,4097
-freeplane_and_yaml-0.1.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-freeplane_and_yaml-0.1.2.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
-freeplane_and_yaml-0.1.2.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
-freeplane_and_yaml-0.1.2.dist-info/RECORD,,