freeplane-and-yaml 0.1.2__tar.gz → 0.1.3__tar.gz

{freeplane-and-yaml-0.1.2/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplane-and-yaml
-Version: 0.1.2
+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
@@ -37,7 +37,86 @@ pip install freeplane-and-yaml
 
 ## Usage
 
-Your YAML file should follow [this schema](src/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:
@@ -73,13 +152,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](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.2 → freeplane-and-yaml-0.1.3}/README.md

@@ -21,7 +21,86 @@ pip install freeplane-and-yaml
 
 ## Usage
 
-Your YAML file should follow [this schema](src/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:
@@ -57,13 +136,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](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.2 → freeplane-and-yaml-0.1.3}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="freeplane-and-yaml",  # Your package name (it must be unique on PyPI)
-    version="0.1.2",  # Initial release version
+    version="0.1.3",  # Initial release version
     description="A tool to convert YAML files to Freeplane MM format",
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",  # Use Markdown for PyPI description

{freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.3/src/freeplane_and_yaml.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: freeplane-and-yaml
-Version: 0.1.2
+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
@@ -37,7 +37,86 @@ pip install freeplane-and-yaml
 
 ## Usage
 
-Your YAML file should follow [this schema](src/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:
@@ -73,13 +152,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](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.