freeplane-and-yaml 0.1.1__py3-none-any.whl → 0.1.2__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.2.dist-info}/METADATA +19 -28
- freeplane_and_yaml-0.1.2.dist-info/RECORD +9 -0
- freeplane_and_yaml-0.1.1.dist-info/RECORD +0 -9
- {freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.2.dist-info}/LICENSE +0 -0
- {freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.2.dist-info}/WHEEL +0 -0
- {freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.2.dist-info}/entry_points.txt +0 -0
- {freeplane_and_yaml-0.1.1.dist-info → freeplane_and_yaml-0.1.2.dist-info}/top_level.txt +0 -0
@@ -1,6 +1,6 @@
|
|
1
1
|
Metadata-Version: 2.1
|
2
2
|
Name: freeplane-and-yaml
|
3
|
-
Version: 0.1.
|
3
|
+
Version: 0.1.2
|
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
|
@@ -26,28 +26,19 @@ That's a friend link so you can read it even if you're not a subscriber.
|
|
26
26
|
|
27
27
|
## Installation
|
28
28
|
|
29
|
-
First, clone this repository:
|
30
|
-
|
31
|
-
```bash
|
32
|
-
# clone the project from GitHub
|
33
|
-
git clone https://github.com/romilly/freeplane-and-yaml.git
|
34
|
-
cd freeplane-and-yaml
|
35
|
-
```
|
36
|
-
|
37
29
|
This project requires Python and should be run in a virtual environment:
|
38
30
|
|
39
31
|
```bash
|
40
|
-
# Create and activate virtual environment
|
32
|
+
# Create and activate virtual environment in the direcoty of your choice
|
41
33
|
python -m venv venv
|
42
34
|
source venv/bin/activate # On Windows use: venv\Scripts\activate
|
43
|
-
|
44
|
-
# Install required packages
|
45
|
-
pip install pyyaml
|
35
|
+
pip install freeplane-and-yaml
|
46
36
|
```
|
47
37
|
|
38
|
+
|
48
39
|
## Usage
|
49
40
|
|
50
|
-
|
41
|
+
Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
|
51
42
|
|
52
43
|
```yaml
|
53
44
|
root:
|
@@ -64,6 +55,16 @@ root:
|
|
64
55
|
# ... and so on
|
65
56
|
```
|
66
57
|
|
58
|
+
### Converting YAML to Mind Map
|
59
|
+
|
60
|
+
To convert a YAML file to a Freeplane mind map:
|
61
|
+
|
62
|
+
```bash
|
63
|
+
|
64
|
+
# Convert YAML and store mind map in temp
|
65
|
+
convert data/marr.yaml temp
|
66
|
+
```
|
67
|
+
|
67
68
|
### YAML Schema Requirements
|
68
69
|
|
69
70
|
The YAML must conform to these rules:
|
@@ -73,13 +74,13 @@ The YAML must conform to these rules:
|
|
73
74
|
- Child node keys must be alphanumeric (including underscores)
|
74
75
|
- No additional properties are allowed beyond title, note, and children
|
75
76
|
|
76
|
-
For full schema details, see
|
77
|
+
For full schema details, see [schema](src/schema/mindmap-schema.json).
|
77
78
|
|
78
|
-
### Converting Documents to
|
79
|
+
### Converting Documents to YAML using Claude AI
|
79
80
|
|
80
81
|
You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
|
81
82
|
|
82
|
-
1. Share your document and the schema
|
83
|
+
1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
|
83
84
|
2. Use this prompt:
|
84
85
|
```
|
85
86
|
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 +95,6 @@ This workflow is useful for:
|
|
94
95
|
- Creating structured summaries of technical documentation
|
95
96
|
- Organizing research notes
|
96
97
|
|
97
|
-
### Converting YAML to Mind Map
|
98
|
-
|
99
|
-
To convert a YAML file to a Freeplane mind map:
|
100
|
-
|
101
|
-
```python
|
102
|
-
from freeplane_and_yaml.convert_yaml_to_freeplane import convert_yaml_file
|
103
|
-
|
104
|
-
# Convert YAML to mind map
|
105
|
-
convert_yaml_file('path/to/your/input.yaml', 'output.mm')
|
106
|
-
```
|
107
98
|
|
108
99
|
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:
|
109
100
|
|
@@ -126,7 +117,7 @@ Here's an example of how the output looks:
|
|
126
117
|
|
127
118
|
## License
|
128
119
|
|
129
|
-
|
120
|
+
_Apologies to readers from the USA. This README uses UK spelling._
|
130
121
|
|
131
122
|
This project is licensed under the MIT Licence — see the [LICENCE](LICENSE) file for details.
|
132
123
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
freeplane_and_yaml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
2
|
+
freeplane_and_yaml/cli.py,sha256=qeUJXw2MqCf6Kv7c-K63-srGj339beL4JTrAXi5_-3c,1213
|
3
|
+
freeplane_and_yaml/convert.py,sha256=dyQLt2FlmCgsQOnutnp1DyLXzqk-guazL8TZwTH0vHI,3440
|
4
|
+
freeplane_and_yaml-0.1.2.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
|
5
|
+
freeplane_and_yaml-0.1.2.dist-info/METADATA,sha256=kTtNNw4SJFhFIfUbpOrMunKQnElit7T7zq08zrzuUzI,4097
|
6
|
+
freeplane_and_yaml-0.1.2.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
|
7
|
+
freeplane_and_yaml-0.1.2.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
|
8
|
+
freeplane_and_yaml-0.1.2.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
|
9
|
+
freeplane_and_yaml-0.1.2.dist-info/RECORD,,
|
@@ -1,9 +0,0 @@
|
|
1
|
-
freeplane_and_yaml/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
2
|
-
freeplane_and_yaml/cli.py,sha256=qeUJXw2MqCf6Kv7c-K63-srGj339beL4JTrAXi5_-3c,1213
|
3
|
-
freeplane_and_yaml/convert.py,sha256=dyQLt2FlmCgsQOnutnp1DyLXzqk-guazL8TZwTH0vHI,3440
|
4
|
-
freeplane_and_yaml-0.1.1.dist-info/LICENSE,sha256=gCmvBRHqGZibjt4wyMG81SeYWMKuhoGFVQh_Kn1wZ98,1072
|
5
|
-
freeplane_and_yaml-0.1.1.dist-info/METADATA,sha256=rK9H4NH6Z7rx89SzQs8c-ZtccsPrztOl6ukMyJ0CO78,4420
|
6
|
-
freeplane_and_yaml-0.1.1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
|
7
|
-
freeplane_and_yaml-0.1.1.dist-info/entry_points.txt,sha256=kWuCk_RZlzcO9h7yk7uJ4dtJiccQxBocEuQPVt6qzxo,57
|
8
|
-
freeplane_and_yaml-0.1.1.dist-info/top_level.txt,sha256=UY6T4vy985r4DAfWpM1D_n6t0cEis5SxtfkPPd-xDhQ,19
|
9
|
-
freeplane_and_yaml-0.1.1.dist-info/RECORD,,
|
File without changes
|
File without changes
|
File without changes
|
File without changes
|