freeplane-and-yaml 0.1.3__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.3/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.4}/PKG-INFO +7 -23
  2. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/README.md +6 -22
  3. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/setup.py +1 -1
  4. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4/src/freeplane_and_yaml.egg-info}/PKG-INFO +7 -23
  5. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/LICENSE +0 -0
  6. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/MANIFEST.in +0 -0
  7. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/setup.cfg +0 -0
  8. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/__init__.py +0 -0
  9. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/cli.py +0 -0
  10. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml/convert.py +0 -0
  11. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/SOURCES.txt +0 -0
  12. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/dependency_links.txt +0 -0
  13. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/entry_points.txt +0 -0
  14. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/requires.txt +0 -0
  15. {freeplane-and-yaml-0.1.3 → freeplane-and-yaml-0.1.4}/src/freeplane_and_yaml.egg-info/top_level.txt +0 -0
{freeplane-and-yaml-0.1.3/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.3
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,7 +38,7 @@ pip install freeplane-and-yaml
37
38
 
38
39
  ## Usage
39
40
 
40
- Your YAML file should follow this schema:
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.
41
42
 
42
43
  ```json
43
44
  {
@@ -116,23 +117,6 @@ Your YAML file should follow this schema:
116
117
 
117
118
  ```
118
119
 
119
- Here's an example structure:
120
-
121
- ```yaml
122
- root:
123
- title: "Your Main Topic"
124
- note: "Optional note for the main topic"
125
- children:
126
- subtopic1:
127
- title: "Subtopic 1"
128
- note: "Optional note for subtopic 1"
129
- children:
130
- # ... more nested topics
131
- subtopic2:
132
- title: "Subtopic 2"
133
- # ... and so on
134
- ```
135
-
136
120
  ### Converting YAML to Mind Map
137
121
 
138
122
  To convert a YAML file to a Freeplane mind map:
@@ -143,9 +127,9 @@ To convert a YAML file to a Freeplane mind map:
143
127
  convert data/marr.yaml temp
144
128
  ```
145
129
 
146
- ### YAML Schema Requirements
130
+ ### YAML Schema requirements explained
147
131
 
148
- The YAML must conform to these rules:
132
+ As the schema specifies, The YAML must conform to these rules:
149
133
  - Must have a root node with a title and at least one child
150
134
  - Each node requires a title
151
135
  - Notes are optional
{freeplane-and-yaml-0.1.3 → 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,7 +22,7 @@ pip install freeplane-and-yaml
21
22
 
22
23
  ## Usage
23
24
 
24
- Your YAML file should follow this schema:
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.
25
26
 
26
27
  ```json
27
28
  {
@@ -100,23 +101,6 @@ Your YAML file should follow this schema:
100
101
 
101
102
  ```
102
103
 
103
- Here's an example structure:
104
-
105
- ```yaml
106
- root:
107
- title: "Your Main Topic"
108
- note: "Optional note for the main topic"
109
- children:
110
- subtopic1:
111
- title: "Subtopic 1"
112
- note: "Optional note for subtopic 1"
113
- children:
114
- # ... more nested topics
115
- subtopic2:
116
- title: "Subtopic 2"
117
- # ... and so on
118
- ```
119
-
120
104
  ### Converting YAML to Mind Map
121
105
 
122
106
  To convert a YAML file to a Freeplane mind map:
@@ -127,9 +111,9 @@ To convert a YAML file to a Freeplane mind map:
127
111
  convert data/marr.yaml temp
128
112
  ```
129
113
 
130
- ### YAML Schema Requirements
114
+ ### YAML Schema requirements explained
131
115
 
132
- The YAML must conform to these rules:
116
+ As the schema specifies, The YAML must conform to these rules:
133
117
  - Must have a root node with a title and at least one child
134
118
  - Each node requires a title
135
119
  - Notes are optional
{freeplane-and-yaml-0.1.3 → 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.3", # 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.3 → 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.3
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,7 +38,7 @@ pip install freeplane-and-yaml
37
38
 
38
39
  ## Usage
39
40
 
40
- Your YAML file should follow this schema:
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.
41
42
 
42
43
  ```json
43
44
  {
@@ -116,23 +117,6 @@ Your YAML file should follow this schema:
116
117
 
117
118
  ```
118
119
 
119
- Here's an example structure:
120
-
121
- ```yaml
122
- root:
123
- title: "Your Main Topic"
124
- note: "Optional note for the main topic"
125
- children:
126
- subtopic1:
127
- title: "Subtopic 1"
128
- note: "Optional note for subtopic 1"
129
- children:
130
- # ... more nested topics
131
- subtopic2:
132
- title: "Subtopic 2"
133
- # ... and so on
134
- ```
135
-
136
120
  ### Converting YAML to Mind Map
137
121
 
138
122
  To convert a YAML file to a Freeplane mind map:
@@ -143,9 +127,9 @@ To convert a YAML file to a Freeplane mind map:
143
127
  convert data/marr.yaml temp
144
128
  ```
145
129
 
146
- ### YAML Schema Requirements
130
+ ### YAML Schema requirements explained
147
131
 
148
- The YAML must conform to these rules:
132
+ As the schema specifies, The YAML must conform to these rules:
149
133
  - Must have a root node with a title and at least one child
150
134
  - Each node requires a title
151
135
  - Notes are optional