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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. {freeplane-and-yaml-0.1.2/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.4}/PKG-INFO +85 -22
  2. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/README.md +84 -21
  3. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/setup.py +1 -1
  4. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4/src/freeplane_and_yaml.egg-info}/PKG-INFO +85 -22
  5. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/LICENSE +0 -0
  6. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/MANIFEST.in +0 -0
  7. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/setup.cfg +0 -0
  8. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/__init__.py +0 -0
  9. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/cli.py +0 -0
  10. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/convert.py +0 -0
  11. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/SOURCES.txt +0 -0
  12. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/dependency_links.txt +0 -0
  13. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/entry_points.txt +0 -0
  14. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/requires.txt +0 -0
  15. {freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/top_level.txt +0 -0
{freeplane-and-yaml-0.1.2/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.4}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: freeplane-and-yaml
3
- Version: 0.1.2
3
+ Version: 0.1.4
4
4
  Summary: A tool to convert YAML files to Freeplane MM format
5
5
  Home-page: https://github.com/romilly/freeplane-and-yaml
6
6
  Author: Romilly Cocking
@@ -18,10 +18,11 @@ License-File: LICENSE
18
18
 
19
19
  A Python tool that converts YAML files into Freeplane mind maps. This allows you to generate mind maps programmatically from structured YAML data.
20
20
 
21
- 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).
21
+ The YAML file can be created using [Claude AI](https://claude.ai/chat/).
22
+ A suitable prompt is given [below](https://github.com/romilly/freeplane-and-yaml?tab=readme-ov-file#converting-documents-to-yaml-using-claude-ai).
22
23
 
23
24
  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).
24
- That's a friend link so you can read it even if you're not a subscriber.
25
+ That's a _friend link_ so you can read it even if you're not a subscriber.
25
26
 
26
27
  ## Installation
27
28
 
@@ -37,21 +38,83 @@ pip install freeplane-and-yaml
37
38
 
38
39
  ## Usage
39
40
 
40
- Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
41
-
42
- ```yaml
43
- root:
44
- title: "Your Main Topic"
45
- note: "Optional note for the main topic"
46
- children:
47
- subtopic1:
48
- title: "Subtopic 1"
49
- note: "Optional note for subtopic 1"
50
- children:
51
- # ... more nested topics
52
- subtopic2:
53
- title: "Subtopic 2"
54
- # ... and so on
41
+ 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.
42
+
43
+ ```json
44
+ {
45
+ "$schema": "http://json-schema.org/draft-07/schema#",
46
+ "title": "Mind Map Schema",
47
+ "description": "Schema for Freeplane-compatible mind map YAML format",
48
+
49
+ "definitions": {
50
+ "node": {
51
+ "type": "object",
52
+ "required": ["title"],
53
+ "properties": {
54
+ "title": {
55
+ "type": "string",
56
+ "description": "The display text for the node"
57
+ },
58
+ "note": {
59
+ "type": "string",
60
+ "description": "Rich text note attached to the node"
61
+ },
62
+ "children": {
63
+ "type": "object",
64
+ "description": "Child nodes of this node",
65
+ "patternProperties": {
66
+ "^[a-zA-Z0-9_]+$": {
67
+ "$ref": "#/definitions/node"
68
+ }
69
+ },
70
+ "additionalProperties": false
71
+ }
72
+ },
73
+ "additionalProperties": false
74
+ }
75
+ },
76
+
77
+ "type": "object",
78
+ "required": ["root"],
79
+ "properties": {
80
+ "root": {
81
+ "allOf": [
82
+ { "$ref": "#/definitions/node" },
83
+ {
84
+ "required": ["children"],
85
+ "description": "The root node must have at least one child"
86
+ }
87
+ ]
88
+ }
89
+ },
90
+ "additionalProperties": false,
91
+
92
+ "examples": [
93
+ {
94
+ "root": {
95
+ "title": "Example Mind Map",
96
+ "note": "This is the root node",
97
+ "children": {
98
+ "topic1": {
99
+ "title": "First Topic",
100
+ "note": "Note for first topic",
101
+ "children": {
102
+ "subtopic1": {
103
+ "title": "Subtopic 1",
104
+ "note": "Note for subtopic"
105
+ }
106
+ }
107
+ },
108
+ "topic2": {
109
+ "title": "Second Topic",
110
+ "note": "Note for second topic"
111
+ }
112
+ }
113
+ }
114
+ }
115
+ ]
116
+ }
117
+
55
118
  ```
56
119
 
57
120
  ### Converting YAML to Mind Map
@@ -64,22 +127,22 @@ To convert a YAML file to a Freeplane mind map:
64
127
  convert data/marr.yaml temp
65
128
  ```
66
129
 
67
- ### YAML Schema Requirements
130
+ ### YAML Schema requirements explained
68
131
 
69
- The YAML must conform to these rules:
132
+ As the schema specifies, The YAML must conform to these rules:
70
133
  - Must have a root node with a title and at least one child
71
134
  - Each node requires a title
72
135
  - Notes are optional
73
136
  - Child node keys must be alphanumeric (including underscores)
74
137
  - No additional properties are allowed beyond title, note, and children
75
138
 
76
- For full schema details, see [schema](src/schema/mindmap-schema.json).
139
+ For full schema details, see above.
77
140
 
78
141
  ### Converting Documents to YAML using Claude AI
79
142
 
80
143
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
81
144
 
82
- 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
145
+ 1. Share your document and the schema (above) with Claude Sonnet.
83
146
  2. Use this prompt:
84
147
  ```
85
148
  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.4}/README.md RENAMED
@@ -2,10 +2,11 @@
2
2
 
3
3
  A Python tool that converts YAML files into Freeplane mind maps. This allows you to generate mind maps programmatically from structured YAML data.
4
4
 
5
- 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).
5
+ The YAML file can be created using [Claude AI](https://claude.ai/chat/).
6
+ A suitable prompt is given [below](https://github.com/romilly/freeplane-and-yaml?tab=readme-ov-file#converting-documents-to-yaml-using-claude-ai).
6
7
 
7
8
  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).
8
- That's a friend link so you can read it even if you're not a subscriber.
9
+ That's a _friend link_ so you can read it even if you're not a subscriber.
9
10
 
10
11
  ## Installation
11
12
 
@@ -21,21 +22,83 @@ pip install freeplane-and-yaml
21
22
 
22
23
  ## Usage
23
24
 
24
- Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
25
-
26
- ```yaml
27
- root:
28
- title: "Your Main Topic"
29
- note: "Optional note for the main topic"
30
- children:
31
- subtopic1:
32
- title: "Subtopic 1"
33
- note: "Optional note for subtopic 1"
34
- children:
35
- # ... more nested topics
36
- subtopic2:
37
- title: "Subtopic 2"
38
- # ... and so on
25
+ 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.
26
+
27
+ ```json
28
+ {
29
+ "$schema": "http://json-schema.org/draft-07/schema#",
30
+ "title": "Mind Map Schema",
31
+ "description": "Schema for Freeplane-compatible mind map YAML format",
32
+
33
+ "definitions": {
34
+ "node": {
35
+ "type": "object",
36
+ "required": ["title"],
37
+ "properties": {
38
+ "title": {
39
+ "type": "string",
40
+ "description": "The display text for the node"
41
+ },
42
+ "note": {
43
+ "type": "string",
44
+ "description": "Rich text note attached to the node"
45
+ },
46
+ "children": {
47
+ "type": "object",
48
+ "description": "Child nodes of this node",
49
+ "patternProperties": {
50
+ "^[a-zA-Z0-9_]+$": {
51
+ "$ref": "#/definitions/node"
52
+ }
53
+ },
54
+ "additionalProperties": false
55
+ }
56
+ },
57
+ "additionalProperties": false
58
+ }
59
+ },
60
+
61
+ "type": "object",
62
+ "required": ["root"],
63
+ "properties": {
64
+ "root": {
65
+ "allOf": [
66
+ { "$ref": "#/definitions/node" },
67
+ {
68
+ "required": ["children"],
69
+ "description": "The root node must have at least one child"
70
+ }
71
+ ]
72
+ }
73
+ },
74
+ "additionalProperties": false,
75
+
76
+ "examples": [
77
+ {
78
+ "root": {
79
+ "title": "Example Mind Map",
80
+ "note": "This is the root node",
81
+ "children": {
82
+ "topic1": {
83
+ "title": "First Topic",
84
+ "note": "Note for first topic",
85
+ "children": {
86
+ "subtopic1": {
87
+ "title": "Subtopic 1",
88
+ "note": "Note for subtopic"
89
+ }
90
+ }
91
+ },
92
+ "topic2": {
93
+ "title": "Second Topic",
94
+ "note": "Note for second topic"
95
+ }
96
+ }
97
+ }
98
+ }
99
+ ]
100
+ }
101
+
39
102
  ```
40
103
 
41
104
  ### Converting YAML to Mind Map
@@ -48,22 +111,22 @@ To convert a YAML file to a Freeplane mind map:
48
111
  convert data/marr.yaml temp
49
112
  ```
50
113
 
51
- ### YAML Schema Requirements
114
+ ### YAML Schema requirements explained
52
115
 
53
- The YAML must conform to these rules:
116
+ As the schema specifies, The YAML must conform to these rules:
54
117
  - Must have a root node with a title and at least one child
55
118
  - Each node requires a title
56
119
  - Notes are optional
57
120
  - Child node keys must be alphanumeric (including underscores)
58
121
  - No additional properties are allowed beyond title, note, and children
59
122
 
60
- For full schema details, see [schema](src/schema/mindmap-schema.json).
123
+ For full schema details, see above.
61
124
 
62
125
  ### Converting Documents to YAML using Claude AI
63
126
 
64
127
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
65
128
 
66
- 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
129
+ 1. Share your document and the schema (above) with Claude Sonnet.
67
130
  2. Use this prompt:
68
131
  ```
69
132
  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.4}/setup.py RENAMED
@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
2
2
 
3
3
  setup(
4
4
  name="freeplane-and-yaml", # Your package name (it must be unique on PyPI)
5
- version="0.1.2", # Initial release version
5
+ version="0.1.4", # Initial release version
6
6
  description="A tool to convert YAML files to Freeplane MM format",
7
7
  long_description=open("README.md").read(),
8
8
  long_description_content_type="text/markdown", # Use Markdown for PyPI description
{freeplane-and-yaml-0.1.2 → freeplane-and-yaml-0.1.4/src/freeplane_and_yaml.egg-info}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: freeplane-and-yaml
3
- Version: 0.1.2
3
+ Version: 0.1.4
4
4
  Summary: A tool to convert YAML files to Freeplane MM format
5
5
  Home-page: https://github.com/romilly/freeplane-and-yaml
6
6
  Author: Romilly Cocking
@@ -18,10 +18,11 @@ License-File: LICENSE
18
18
 
19
19
  A Python tool that converts YAML files into Freeplane mind maps. This allows you to generate mind maps programmatically from structured YAML data.
20
20
 
21
- 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).
21
+ The YAML file can be created using [Claude AI](https://claude.ai/chat/).
22
+ A suitable prompt is given [below](https://github.com/romilly/freeplane-and-yaml?tab=readme-ov-file#converting-documents-to-yaml-using-claude-ai).
22
23
 
23
24
  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).
24
- That's a friend link so you can read it even if you're not a subscriber.
25
+ That's a _friend link_ so you can read it even if you're not a subscriber.
25
26
 
26
27
  ## Installation
27
28
 
@@ -37,21 +38,83 @@ pip install freeplane-and-yaml
37
38
 
38
39
  ## Usage
39
40
 
40
- Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
41
-
42
- ```yaml
43
- root:
44
- title: "Your Main Topic"
45
- note: "Optional note for the main topic"
46
- children:
47
- subtopic1:
48
- title: "Subtopic 1"
49
- note: "Optional note for subtopic 1"
50
- children:
51
- # ... more nested topics
52
- subtopic2:
53
- title: "Subtopic 2"
54
- # ... and so on
41
+ 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.
42
+
43
+ ```json
44
+ {
45
+ "$schema": "http://json-schema.org/draft-07/schema#",
46
+ "title": "Mind Map Schema",
47
+ "description": "Schema for Freeplane-compatible mind map YAML format",
48
+
49
+ "definitions": {
50
+ "node": {
51
+ "type": "object",
52
+ "required": ["title"],
53
+ "properties": {
54
+ "title": {
55
+ "type": "string",
56
+ "description": "The display text for the node"
57
+ },
58
+ "note": {
59
+ "type": "string",
60
+ "description": "Rich text note attached to the node"
61
+ },
62
+ "children": {
63
+ "type": "object",
64
+ "description": "Child nodes of this node",
65
+ "patternProperties": {
66
+ "^[a-zA-Z0-9_]+$": {
67
+ "$ref": "#/definitions/node"
68
+ }
69
+ },
70
+ "additionalProperties": false
71
+ }
72
+ },
73
+ "additionalProperties": false
74
+ }
75
+ },
76
+
77
+ "type": "object",
78
+ "required": ["root"],
79
+ "properties": {
80
+ "root": {
81
+ "allOf": [
82
+ { "$ref": "#/definitions/node" },
83
+ {
84
+ "required": ["children"],
85
+ "description": "The root node must have at least one child"
86
+ }
87
+ ]
88
+ }
89
+ },
90
+ "additionalProperties": false,
91
+
92
+ "examples": [
93
+ {
94
+ "root": {
95
+ "title": "Example Mind Map",
96
+ "note": "This is the root node",
97
+ "children": {
98
+ "topic1": {
99
+ "title": "First Topic",
100
+ "note": "Note for first topic",
101
+ "children": {
102
+ "subtopic1": {
103
+ "title": "Subtopic 1",
104
+ "note": "Note for subtopic"
105
+ }
106
+ }
107
+ },
108
+ "topic2": {
109
+ "title": "Second Topic",
110
+ "note": "Note for second topic"
111
+ }
112
+ }
113
+ }
114
+ }
115
+ ]
116
+ }
117
+
55
118
  ```
56
119
 
57
120
  ### Converting YAML to Mind Map
@@ -64,22 +127,22 @@ To convert a YAML file to a Freeplane mind map:
64
127
  convert data/marr.yaml temp
65
128
  ```
66
129
 
67
- ### YAML Schema Requirements
130
+ ### YAML Schema requirements explained
68
131
 
69
- The YAML must conform to these rules:
132
+ As the schema specifies, The YAML must conform to these rules:
70
133
  - Must have a root node with a title and at least one child
71
134
  - Each node requires a title
72
135
  - Notes are optional
73
136
  - Child node keys must be alphanumeric (including underscores)
74
137
  - No additional properties are allowed beyond title, note, and children
75
138
 
76
- For full schema details, see [schema](src/schema/mindmap-schema.json).
139
+ For full schema details, see above.
77
140
 
78
141
  ### Converting Documents to YAML using Claude AI
79
142
 
80
143
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
81
144
 
82
- 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
145
+ 1. Share your document and the schema (above) with Claude Sonnet.
83
146
  2. Use this prompt:
84
147
  ```
85
148
  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.