freeplane-and-yaml 0.1.1__tar.gz → 0.1.2__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.1/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.2}/PKG-INFO +19 -28
  2. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/README.md +18 -27
  3. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/setup.py +1 -1
  4. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2/src/freeplane_and_yaml.egg-info}/PKG-INFO +19 -28
  5. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/LICENSE +0 -0
  6. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/MANIFEST.in +0 -0
  7. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/setup.cfg +0 -0
  8. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml/__init__.py +0 -0
  9. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml/cli.py +0 -0
  10. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml/convert.py +0 -0
  11. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml.egg-info/SOURCES.txt +0 -0
  12. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml.egg-info/dependency_links.txt +0 -0
  13. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml.egg-info/entry_points.txt +0 -0
  14. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml.egg-info/requires.txt +0 -0
  15. {freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/src/freeplane_and_yaml.egg-info/top_level.txt +0 -0
{freeplane-and-yaml-0.1.1/src/freeplane_and_yaml.egg-info → freeplane-and-yaml-0.1.2}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: freeplane-and-yaml
3
- Version: 0.1.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
@@ -25,28 +25,19 @@ That's a friend link so you can read it even if you're not a subscriber.
25
25
 
26
26
  ## Installation
27
27
 
28
- First, clone this repository:
29
-
30
- ```bash
31
- # clone the project from GitHub
32
- git clone https://github.com/romilly/freeplane-and-yaml.git
33
- cd freeplane-and-yaml
34
- ```
35
-
36
28
  This project requires Python and should be run in a virtual environment:
37
29
 
38
30
  ```bash
39
- # Create and activate virtual environment
31
+ # Create and activate virtual environment in the direcoty of your choice
40
32
  python -m venv venv
41
33
  source venv/bin/activate # On Windows use: venv\Scripts\activate
42
-
43
- # Install required packages
44
- pip install pyyaml
34
+ pip install freeplane-and-yaml
45
35
  ```
46
36
 
37
+
47
38
  ## Usage
48
39
 
49
- The code should be run from the `src` directory after activating the virtual environment. Your YAML file should follow the schema defined in `schema/mindmap-schema.json`. Here's an example structure:
40
+ Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
50
41
 
51
42
  ```yaml
52
43
  root:
@@ -63,6 +54,16 @@ root:
63
54
  # ... and so on
64
55
  ```
65
56
 
57
+ ### Converting YAML to Mind Map
58
+
59
+ To convert a YAML file to a Freeplane mind map:
60
+
61
+ ```bash
62
+
63
+ # Convert YAML and store mind map in temp
64
+ convert data/marr.yaml temp
65
+ ```
66
+
66
67
  ### YAML Schema Requirements
67
68
 
68
69
  The YAML must conform to these rules:
@@ -72,13 +73,13 @@ The YAML must conform to these rules:
72
73
  - Child node keys must be alphanumeric (including underscores)
73
74
  - No additional properties are allowed beyond title, note, and children
74
75
 
75
- For full schema details, see `schema/mindmap-schema.json`.
76
+ For full schema details, see [schema](src/schema/mindmap-schema.json).
76
77
 
77
- ### Converting Documents to Mind Maps using Claude AI
78
+ ### Converting Documents to YAML using Claude AI
78
79
 
79
80
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
80
81
 
81
- 1. Share your document and the schema (from `schema/mindmap-schema.json`)with Claude Sonnet.
82
+ 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
82
83
  2. Use this prompt:
83
84
  ```
84
85
  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.
@@ -93,16 +94,6 @@ This workflow is useful for:
93
94
  - Creating structured summaries of technical documentation
94
95
  - Organizing research notes
95
96
 
96
- ### Converting YAML to Mind Map
97
-
98
- To convert a YAML file to a Freeplane mind map:
99
-
100
- ```python
101
- from freeplane_and_yaml.convert_yaml_to_freeplane import convert_yaml_file
102
-
103
- # Convert YAML to mind map
104
- convert_yaml_file('path/to/your/input.yaml', 'output.mm')
105
- ```
106
97
 
107
98
  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:
108
99
 
@@ -125,7 +116,7 @@ Here's an example of how the output looks:
125
116
 
126
117
  ## License
127
118
 
128
- Apologiresd to readers from the USA. This README uses UK spelling.
119
+ _Apologies to readers from the USA. This README uses UK spelling._
129
120
 
130
121
  This project is licensed under the MIT Licence — see the [LICENCE](LICENSE) file for details.
131
122
 
{freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/README.md RENAMED
@@ -9,28 +9,19 @@ That's a friend link so you can read it even if you're not a subscriber.
9
9
 
10
10
  ## Installation
11
11
 
12
- First, clone this repository:
13
-
14
- ```bash
15
- # clone the project from GitHub
16
- git clone https://github.com/romilly/freeplane-and-yaml.git
17
- cd freeplane-and-yaml
18
- ```
19
-
20
12
  This project requires Python and should be run in a virtual environment:
21
13
 
22
14
  ```bash
23
- # Create and activate virtual environment
15
+ # Create and activate virtual environment in the direcoty of your choice
24
16
  python -m venv venv
25
17
  source venv/bin/activate # On Windows use: venv\Scripts\activate
26
-
27
- # Install required packages
28
- pip install pyyaml
18
+ pip install freeplane-and-yaml
29
19
  ```
30
20
 
21
+
31
22
  ## Usage
32
23
 
33
- The code should be run from the `src` directory after activating the virtual environment. Your YAML file should follow the schema defined in `schema/mindmap-schema.json`. Here's an example structure:
24
+ Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
34
25
 
35
26
  ```yaml
36
27
  root:
@@ -47,6 +38,16 @@ root:
47
38
  # ... and so on
48
39
  ```
49
40
 
41
+ ### Converting YAML to Mind Map
42
+
43
+ To convert a YAML file to a Freeplane mind map:
44
+
45
+ ```bash
46
+
47
+ # Convert YAML and store mind map in temp
48
+ convert data/marr.yaml temp
49
+ ```
50
+
50
51
  ### YAML Schema Requirements
51
52
 
52
53
  The YAML must conform to these rules:
@@ -56,13 +57,13 @@ The YAML must conform to these rules:
56
57
  - Child node keys must be alphanumeric (including underscores)
57
58
  - No additional properties are allowed beyond title, note, and children
58
59
 
59
- For full schema details, see `schema/mindmap-schema.json`.
60
+ For full schema details, see [schema](src/schema/mindmap-schema.json).
60
61
 
61
- ### Converting Documents to Mind Maps using Claude AI
62
+ ### Converting Documents to YAML using Claude AI
62
63
 
63
64
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
64
65
 
65
- 1. Share your document and the schema (from `schema/mindmap-schema.json`)with Claude Sonnet.
66
+ 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
66
67
  2. Use this prompt:
67
68
  ```
68
69
  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.
@@ -77,16 +78,6 @@ This workflow is useful for:
77
78
  - Creating structured summaries of technical documentation
78
79
  - Organizing research notes
79
80
 
80
- ### Converting YAML to Mind Map
81
-
82
- To convert a YAML file to a Freeplane mind map:
83
-
84
- ```python
85
- from freeplane_and_yaml.convert_yaml_to_freeplane import convert_yaml_file
86
-
87
- # Convert YAML to mind map
88
- convert_yaml_file('path/to/your/input.yaml', 'output.mm')
89
- ```
90
81
 
91
82
  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:
92
83
 
@@ -109,6 +100,6 @@ Here's an example of how the output looks:
109
100
 
110
101
  ## License
111
102
 
112
- Apologiresd to readers from the USA. This README uses UK spelling.
103
+ _Apologies to readers from the USA. This README uses UK spelling._
113
104
 
114
105
  This project is licensed under the MIT Licence — see the [LICENCE](LICENSE) file for details.
{freeplane-and-yaml-0.1.1 → freeplane-and-yaml-0.1.2}/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.1", # Initial release version
5
+ version="0.1.2", # 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.1 → freeplane-and-yaml-0.1.2/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.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
@@ -25,28 +25,19 @@ That's a friend link so you can read it even if you're not a subscriber.
25
25
 
26
26
  ## Installation
27
27
 
28
- First, clone this repository:
29
-
30
- ```bash
31
- # clone the project from GitHub
32
- git clone https://github.com/romilly/freeplane-and-yaml.git
33
- cd freeplane-and-yaml
34
- ```
35
-
36
28
  This project requires Python and should be run in a virtual environment:
37
29
 
38
30
  ```bash
39
- # Create and activate virtual environment
31
+ # Create and activate virtual environment in the direcoty of your choice
40
32
  python -m venv venv
41
33
  source venv/bin/activate # On Windows use: venv\Scripts\activate
42
-
43
- # Install required packages
44
- pip install pyyaml
34
+ pip install freeplane-and-yaml
45
35
  ```
46
36
 
37
+
47
38
  ## Usage
48
39
 
49
- The code should be run from the `src` directory after activating the virtual environment. Your YAML file should follow the schema defined in `schema/mindmap-schema.json`. Here's an example structure:
40
+ Your YAML file should follow [this schema](src/schema/mindmap-schema.json). Here's an example structure:
50
41
 
51
42
  ```yaml
52
43
  root:
@@ -63,6 +54,16 @@ root:
63
54
  # ... and so on
64
55
  ```
65
56
 
57
+ ### Converting YAML to Mind Map
58
+
59
+ To convert a YAML file to a Freeplane mind map:
60
+
61
+ ```bash
62
+
63
+ # Convert YAML and store mind map in temp
64
+ convert data/marr.yaml temp
65
+ ```
66
+
66
67
  ### YAML Schema Requirements
67
68
 
68
69
  The YAML must conform to these rules:
@@ -72,13 +73,13 @@ The YAML must conform to these rules:
72
73
  - Child node keys must be alphanumeric (including underscores)
73
74
  - No additional properties are allowed beyond title, note, and children
74
75
 
75
- For full schema details, see `schema/mindmap-schema.json`.
76
+ For full schema details, see [schema](src/schema/mindmap-schema.json).
76
77
 
77
- ### Converting Documents to Mind Maps using Claude AI
78
+ ### Converting Documents to YAML using Claude AI
78
79
 
79
80
  You can use Claude Sonnet to automatically convert documents (PDFs, articles, specifications, etc.) into the required YAML format. Here's the workflow:
80
81
 
81
- 1. Share your document and the schema (from `schema/mindmap-schema.json`)with Claude Sonnet.
82
+ 1. Share your document and the [schema](src/schema/mindmap-schema.json) with Claude Sonnet.
82
83
  2. Use this prompt:
83
84
  ```
84
85
  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.
@@ -93,16 +94,6 @@ This workflow is useful for:
93
94
  - Creating structured summaries of technical documentation
94
95
  - Organizing research notes
95
96
 
96
- ### Converting YAML to Mind Map
97
-
98
- To convert a YAML file to a Freeplane mind map:
99
-
100
- ```python
101
- from freeplane_and_yaml.convert_yaml_to_freeplane import convert_yaml_file
102
-
103
- # Convert YAML to mind map
104
- convert_yaml_file('path/to/your/input.yaml', 'output.mm')
105
- ```
106
97
 
107
98
  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:
108
99
 
@@ -125,7 +116,7 @@ Here's an example of how the output looks:
125
116
 
126
117
  ## License
127
118
 
128
- Apologiresd to readers from the USA. This README uses UK spelling.
119
+ _Apologies to readers from the USA. This README uses UK spelling._
129
120
 
130
121
  This project is licensed under the MIT Licence — see the [LICENCE](LICENSE) file for details.
131
122