swarmauri_tool_jupyterwritenotebook 0.7.0.dev2__tar.gz
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.
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/LICENSE +201 -0
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/PKG-INFO +132 -0
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/README.md +113 -0
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/pyproject.toml +65 -0
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/swarmauri_tool_jupyterwritenotebook/JupyterWriteNotebookTool.py +127 -0
- swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/swarmauri_tool_jupyterwritenotebook/__init__.py +19 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [2025] [Jacob Stewart @ Swarmauri]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: swarmauri_tool_jupyterwritenotebook
|
|
3
|
+
Version: 0.7.0.dev2
|
|
4
|
+
Summary: A tool that writes a NotebookNode object to a file in JSON format, preserving the notebook structure.
|
|
5
|
+
License: Apache-2.0
|
|
6
|
+
Author: Jacob Stewart
|
|
7
|
+
Author-email: jacob@swarmauri.com
|
|
8
|
+
Requires-Python: >=3.10,<3.13
|
|
9
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Requires-Dist: nbformat (>=5.10.4)
|
|
15
|
+
Requires-Dist: swarmauri_base
|
|
16
|
+
Requires-Dist: swarmauri_core
|
|
17
|
+
Requires-Dist: swarmauri_standard
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
<p align="center">
|
|
23
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterwritenotebook/">
|
|
24
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterwritenotebook" alt="PyPI - Downloads"/></a>
|
|
25
|
+
<a href="https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterwritenotebook">
|
|
26
|
+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterwritenotebook&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" alt="GitHub Hits"/></a>
|
|
27
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
28
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterwritenotebook" alt="PyPI - Python Version"/></a>
|
|
29
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
30
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterwritenotebook" alt="PyPI - License"/></a>
|
|
31
|
+
<br />
|
|
32
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
33
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterwritenotebook?label=swarmauri_tool_jupyterwritenotebook&color=green" alt="PyPI - swarmauri_tool_jupyterwritenotebook"/></a>
|
|
34
|
+
</p>
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
# swarmauri_tool_jupyterwritenotebook
|
|
39
|
+
|
|
40
|
+
The "swarmauri_tool_jupyterwritenotebook" package provides a tool that writes a Jupyter NotebookNode (or a dictionary structured like a NotebookNode) to a file in JSON format, preserving notebook structure. It comes as a fully functional component ready for integration in Python projects requiring automated notebook generation or manipulation.
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
|
|
44
|
+
To install this package, make sure you have Python 3.10 or higher, then run:
|
|
45
|
+
|
|
46
|
+
• Using pip:
|
|
47
|
+
pip install swarmauri_tool_jupyterwritenotebook
|
|
48
|
+
|
|
49
|
+
• Using Poetry:
|
|
50
|
+
poetry add swarmauri_tool_jupyterwritenotebook
|
|
51
|
+
|
|
52
|
+
Once installation is complete, you can import and use the tool directly in your Python code.
|
|
53
|
+
|
|
54
|
+
## Usage
|
|
55
|
+
|
|
56
|
+
Below is a step-by-step example showing how to use JupyterWriteNotebookTool to write a notebook to disk:
|
|
57
|
+
|
|
58
|
+
1. Import the required class:
|
|
59
|
+
--------------------------------------------------------------------------------
|
|
60
|
+
from swarmauri_tool_jupyterwritenotebook import JupyterWriteNotebookTool
|
|
61
|
+
|
|
62
|
+
2. Initialize the tool:
|
|
63
|
+
--------------------------------------------------------------------------------
|
|
64
|
+
tool = JupyterWriteNotebookTool()
|
|
65
|
+
|
|
66
|
+
3. Prepare the notebook data as a dictionary. This can be a valid NotebookNode (like what nbformat produces) or a similarly structured Python dict:
|
|
67
|
+
--------------------------------------------------------------------------------
|
|
68
|
+
sample_notebook = {
|
|
69
|
+
"cells": [
|
|
70
|
+
{
|
|
71
|
+
"cell_type": "markdown",
|
|
72
|
+
"metadata": {},
|
|
73
|
+
"source": [
|
|
74
|
+
"# Hello, Swarmauri!\n",
|
|
75
|
+
"This is a sample notebook cell."
|
|
76
|
+
]
|
|
77
|
+
}
|
|
78
|
+
],
|
|
79
|
+
"metadata": {
|
|
80
|
+
"kernelspec": {
|
|
81
|
+
"display_name": "Python 3",
|
|
82
|
+
"language": "python",
|
|
83
|
+
"name": "python3"
|
|
84
|
+
},
|
|
85
|
+
"language_info": {
|
|
86
|
+
"name": "python"
|
|
87
|
+
}
|
|
88
|
+
},
|
|
89
|
+
"nbformat": 4,
|
|
90
|
+
"nbformat_minor": 5
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
4. Call the tool by providing the dictionary (or NotebookNode) and the output file path:
|
|
94
|
+
--------------------------------------------------------------------------------
|
|
95
|
+
result = tool(
|
|
96
|
+
notebook_data=sample_notebook,
|
|
97
|
+
output_file="output_notebook.ipynb",
|
|
98
|
+
encoding="utf-8"
|
|
99
|
+
)
|
|
100
|
+
print(result)
|
|
101
|
+
|
|
102
|
+
If the operation succeeds, "output_notebook.ipynb" will be created and populated with valid notebook JSON content. The returned dictionary may look like:
|
|
103
|
+
{
|
|
104
|
+
"message": "Notebook written successfully",
|
|
105
|
+
"file_path": "output_notebook.ipynb"
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
## Comprehensive Examples
|
|
109
|
+
|
|
110
|
+
• Basic Notebook Creation:
|
|
111
|
+
- You can create a minimal notebook dict with a single Markdown cell and save it.
|
|
112
|
+
- The returned information indicates whether the write was successful.
|
|
113
|
+
|
|
114
|
+
• Error Handling:
|
|
115
|
+
- If an error occurs (e.g., lack of file permissions, invalid notebook data), the tool returns a dictionary containing an "error" key with a descriptive message.
|
|
116
|
+
|
|
117
|
+
• Read-Back Verification:
|
|
118
|
+
- The tool attempts to reload the created file to ensure it was written correctly. If the read-back fails (e.g., empty or corrupted file), it returns a dictionary with an "error" key.
|
|
119
|
+
|
|
120
|
+
## Dependencies
|
|
121
|
+
|
|
122
|
+
The primary dependencies for "swarmauri_tool_jupyterwritenotebook" include:
|
|
123
|
+
|
|
124
|
+
• Python 3.10 or newer
|
|
125
|
+
• nbformat for handling notebook structures
|
|
126
|
+
• swarmauri_core and swarmauri_base for core functionality and base class definitions
|
|
127
|
+
|
|
128
|
+
You will need these installed in your environment to use this package effectively. Other dev dependencies (such as pytest) are only necessary if you plan to run or extend the existing test suite.
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
© 2023 Swarmauri. Licensed under the Apache-2.0 License.
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterwritenotebook/">
|
|
5
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterwritenotebook" alt="PyPI - Downloads"/></a>
|
|
6
|
+
<a href="https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterwritenotebook">
|
|
7
|
+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterwritenotebook&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false" alt="GitHub Hits"/></a>
|
|
8
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
9
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterwritenotebook" alt="PyPI - Python Version"/></a>
|
|
10
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
11
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterwritenotebook" alt="PyPI - License"/></a>
|
|
12
|
+
<br />
|
|
13
|
+
<a href="https://pypi.org/project/swarmauri/swarmauri_tool_jupyterwritenotebook">
|
|
14
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterwritenotebook?label=swarmauri_tool_jupyterwritenotebook&color=green" alt="PyPI - swarmauri_tool_jupyterwritenotebook"/></a>
|
|
15
|
+
</p>
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# swarmauri_tool_jupyterwritenotebook
|
|
20
|
+
|
|
21
|
+
The "swarmauri_tool_jupyterwritenotebook" package provides a tool that writes a Jupyter NotebookNode (or a dictionary structured like a NotebookNode) to a file in JSON format, preserving notebook structure. It comes as a fully functional component ready for integration in Python projects requiring automated notebook generation or manipulation.
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
To install this package, make sure you have Python 3.10 or higher, then run:
|
|
26
|
+
|
|
27
|
+
• Using pip:
|
|
28
|
+
pip install swarmauri_tool_jupyterwritenotebook
|
|
29
|
+
|
|
30
|
+
• Using Poetry:
|
|
31
|
+
poetry add swarmauri_tool_jupyterwritenotebook
|
|
32
|
+
|
|
33
|
+
Once installation is complete, you can import and use the tool directly in your Python code.
|
|
34
|
+
|
|
35
|
+
## Usage
|
|
36
|
+
|
|
37
|
+
Below is a step-by-step example showing how to use JupyterWriteNotebookTool to write a notebook to disk:
|
|
38
|
+
|
|
39
|
+
1. Import the required class:
|
|
40
|
+
--------------------------------------------------------------------------------
|
|
41
|
+
from swarmauri_tool_jupyterwritenotebook import JupyterWriteNotebookTool
|
|
42
|
+
|
|
43
|
+
2. Initialize the tool:
|
|
44
|
+
--------------------------------------------------------------------------------
|
|
45
|
+
tool = JupyterWriteNotebookTool()
|
|
46
|
+
|
|
47
|
+
3. Prepare the notebook data as a dictionary. This can be a valid NotebookNode (like what nbformat produces) or a similarly structured Python dict:
|
|
48
|
+
--------------------------------------------------------------------------------
|
|
49
|
+
sample_notebook = {
|
|
50
|
+
"cells": [
|
|
51
|
+
{
|
|
52
|
+
"cell_type": "markdown",
|
|
53
|
+
"metadata": {},
|
|
54
|
+
"source": [
|
|
55
|
+
"# Hello, Swarmauri!\n",
|
|
56
|
+
"This is a sample notebook cell."
|
|
57
|
+
]
|
|
58
|
+
}
|
|
59
|
+
],
|
|
60
|
+
"metadata": {
|
|
61
|
+
"kernelspec": {
|
|
62
|
+
"display_name": "Python 3",
|
|
63
|
+
"language": "python",
|
|
64
|
+
"name": "python3"
|
|
65
|
+
},
|
|
66
|
+
"language_info": {
|
|
67
|
+
"name": "python"
|
|
68
|
+
}
|
|
69
|
+
},
|
|
70
|
+
"nbformat": 4,
|
|
71
|
+
"nbformat_minor": 5
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
4. Call the tool by providing the dictionary (or NotebookNode) and the output file path:
|
|
75
|
+
--------------------------------------------------------------------------------
|
|
76
|
+
result = tool(
|
|
77
|
+
notebook_data=sample_notebook,
|
|
78
|
+
output_file="output_notebook.ipynb",
|
|
79
|
+
encoding="utf-8"
|
|
80
|
+
)
|
|
81
|
+
print(result)
|
|
82
|
+
|
|
83
|
+
If the operation succeeds, "output_notebook.ipynb" will be created and populated with valid notebook JSON content. The returned dictionary may look like:
|
|
84
|
+
{
|
|
85
|
+
"message": "Notebook written successfully",
|
|
86
|
+
"file_path": "output_notebook.ipynb"
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
## Comprehensive Examples
|
|
90
|
+
|
|
91
|
+
• Basic Notebook Creation:
|
|
92
|
+
- You can create a minimal notebook dict with a single Markdown cell and save it.
|
|
93
|
+
- The returned information indicates whether the write was successful.
|
|
94
|
+
|
|
95
|
+
• Error Handling:
|
|
96
|
+
- If an error occurs (e.g., lack of file permissions, invalid notebook data), the tool returns a dictionary containing an "error" key with a descriptive message.
|
|
97
|
+
|
|
98
|
+
• Read-Back Verification:
|
|
99
|
+
- The tool attempts to reload the created file to ensure it was written correctly. If the read-back fails (e.g., empty or corrupted file), it returns a dictionary with an "error" key.
|
|
100
|
+
|
|
101
|
+
## Dependencies
|
|
102
|
+
|
|
103
|
+
The primary dependencies for "swarmauri_tool_jupyterwritenotebook" include:
|
|
104
|
+
|
|
105
|
+
• Python 3.10 or newer
|
|
106
|
+
• nbformat for handling notebook structures
|
|
107
|
+
• swarmauri_core and swarmauri_base for core functionality and base class definitions
|
|
108
|
+
|
|
109
|
+
You will need these installed in your environment to use this package effectively. Other dev dependencies (such as pytest) are only necessary if you plan to run or extend the existing test suite.
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
© 2023 Swarmauri. Licensed under the Apache-2.0 License.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "swarmauri_tool_jupyterwritenotebook"
|
|
3
|
+
version = "0.7.0.dev2"
|
|
4
|
+
description = "A tool that writes a NotebookNode object to a file in JSON format, preserving the notebook structure."
|
|
5
|
+
license = "Apache-2.0"
|
|
6
|
+
readme = "README.md"
|
|
7
|
+
repository = "http://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterwritenotebook/"
|
|
8
|
+
requires-python = ">=3.10,<3.13"
|
|
9
|
+
classifiers = [
|
|
10
|
+
"License :: OSI Approved :: Apache Software License",
|
|
11
|
+
"Programming Language :: Python :: 3.10",
|
|
12
|
+
"Programming Language :: Python :: 3.11",
|
|
13
|
+
"Programming Language :: Python :: 3.12",
|
|
14
|
+
"Programming Language :: Python :: 3.13",
|
|
15
|
+
]
|
|
16
|
+
authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
|
|
17
|
+
dependencies = [
|
|
18
|
+
"nbformat>=5.10.4",
|
|
19
|
+
"swarmauri_core",
|
|
20
|
+
"swarmauri_base",
|
|
21
|
+
"swarmauri_standard",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[tool.uv.sources]
|
|
25
|
+
swarmauri_core = { workspace = true }
|
|
26
|
+
swarmauri_base = { workspace = true }
|
|
27
|
+
swarmauri_standard = { workspace = true }
|
|
28
|
+
|
|
29
|
+
[tool.pytest.ini_options]
|
|
30
|
+
norecursedirs = ["combined", "scripts"]
|
|
31
|
+
markers = [
|
|
32
|
+
"test: standard test",
|
|
33
|
+
"unit: Unit tests",
|
|
34
|
+
"i9n: Integration tests",
|
|
35
|
+
"r8n: Regression tests",
|
|
36
|
+
"timeout: mark test to timeout after X seconds",
|
|
37
|
+
"xpass: Expected passes",
|
|
38
|
+
"xfail: Expected failures",
|
|
39
|
+
"acceptance: Acceptance tests",
|
|
40
|
+
]
|
|
41
|
+
timeout = 300
|
|
42
|
+
log_cli = true
|
|
43
|
+
log_cli_level = "INFO"
|
|
44
|
+
log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
|
|
45
|
+
log_cli_date_format = "%Y-%m-%d %H:%M:%S"
|
|
46
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
47
|
+
|
|
48
|
+
[tool.project.entry-points."swarmauri.tools"]
|
|
49
|
+
jupyterwritenotebooktool = "swarmauri_tool_jupyterwritenotebook:JupyterWriteNotebookTool"
|
|
50
|
+
[build-system]
|
|
51
|
+
requires = ["poetry-core>=1.0.0"]
|
|
52
|
+
build-backend = "poetry.core.masonry.api"
|
|
53
|
+
|
|
54
|
+
[dependency-groups]
|
|
55
|
+
dev = [
|
|
56
|
+
"pytest>=8.0",
|
|
57
|
+
"pytest-asyncio>=0.24.0",
|
|
58
|
+
"pytest-xdist>=3.6.1",
|
|
59
|
+
"pytest-json-report>=1.5.0",
|
|
60
|
+
"python-dotenv",
|
|
61
|
+
"requests>=2.32.3",
|
|
62
|
+
"flake8>=7.0",
|
|
63
|
+
"pytest-timeout>=2.3.1",
|
|
64
|
+
"ruff>=0.9.9",
|
|
65
|
+
]
|
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
"""
|
|
2
|
+
JupyterWriteNotebookTool.py
|
|
3
|
+
|
|
4
|
+
This module defines the JupyterWriteNotebookTool, a component that converts a Jupyter notebook
|
|
5
|
+
structure (NotebookNode) to JSON format and writes the data to a specified file. It inherits
|
|
6
|
+
from the ToolBase class of the swarmauri framework, providing a fully-featured implementation
|
|
7
|
+
for writing notebook content to disk.
|
|
8
|
+
|
|
9
|
+
The tool validates notebook data, handles potential I/O operations, logs its actions, and
|
|
10
|
+
confirms the success of write operations to ensure notebook integrity.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
import json
|
|
14
|
+
import logging
|
|
15
|
+
from typing import List, Literal, Dict
|
|
16
|
+
from pydantic import Field
|
|
17
|
+
from swarmauri_standard.tools.Parameter import Parameter
|
|
18
|
+
from swarmauri_base.tools.ToolBase import ToolBase
|
|
19
|
+
from swarmauri_base.ComponentBase import ComponentBase
|
|
20
|
+
|
|
21
|
+
logger = logging.getLogger(__name__)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
@ComponentBase.register_type(ToolBase, "JupyterWriteNotebookTool")
|
|
25
|
+
class JupyterWriteNotebookTool(ToolBase):
|
|
26
|
+
"""
|
|
27
|
+
JupyterWriteNotebookTool is responsible for converting a Jupyter NotebookNode
|
|
28
|
+
structure into JSON and writing it to disk. It ensures the notebook format
|
|
29
|
+
remains valid, including optional read-back verification to confirm the file's
|
|
30
|
+
integrity.
|
|
31
|
+
|
|
32
|
+
Attributes:
|
|
33
|
+
version (str): The version of the JupyterWriteNotebookTool.
|
|
34
|
+
parameters (List[Parameter]): A list of parameters required to perform the write operation.
|
|
35
|
+
name (str): The name of the tool.
|
|
36
|
+
description (str): A brief description of the tool's functionality.
|
|
37
|
+
type (Literal["JupyterWriteNotebookTool"]): The type identifier for the tool.
|
|
38
|
+
"""
|
|
39
|
+
|
|
40
|
+
version: str = "1.0.0"
|
|
41
|
+
parameters: List[Parameter] = Field(
|
|
42
|
+
default_factory=lambda: [
|
|
43
|
+
Parameter(
|
|
44
|
+
name="notebook_data",
|
|
45
|
+
input_type="object",
|
|
46
|
+
description="The notebook content as a dictionary/NotebookNode structure.",
|
|
47
|
+
required=True,
|
|
48
|
+
),
|
|
49
|
+
Parameter(
|
|
50
|
+
name="output_file",
|
|
51
|
+
input_type="string",
|
|
52
|
+
description="Path to the output file where the notebook JSON will be written.",
|
|
53
|
+
required=True,
|
|
54
|
+
),
|
|
55
|
+
Parameter(
|
|
56
|
+
name="encoding",
|
|
57
|
+
input_type="string",
|
|
58
|
+
description="File encoding to use when writing the notebook JSON.",
|
|
59
|
+
required=False,
|
|
60
|
+
default="utf-8",
|
|
61
|
+
),
|
|
62
|
+
]
|
|
63
|
+
)
|
|
64
|
+
name: str = "JupyterWriteNotebookTool"
|
|
65
|
+
description: str = "Writes a Jupyter NotebookNode to a file in JSON format."
|
|
66
|
+
type: Literal["JupyterWriteNotebookTool"] = "JupyterWriteNotebookTool"
|
|
67
|
+
|
|
68
|
+
def __call__(
|
|
69
|
+
self, notebook_data: dict, output_file: str, encoding: str = "utf-8"
|
|
70
|
+
) -> Dict[str, str]:
|
|
71
|
+
"""
|
|
72
|
+
Writes the provided Jupyter notebook data (NotebookNode) to the specified
|
|
73
|
+
output file in JSON format. The method uses the selected encoding and
|
|
74
|
+
handles potential I/O exceptions.
|
|
75
|
+
|
|
76
|
+
Args:
|
|
77
|
+
notebook_data (dict): The Jupyter NotebookNode structure represented as a dictionary.
|
|
78
|
+
output_file (str): The path to the file where the notebook JSON will be written.
|
|
79
|
+
encoding (str, optional): The file encoding to use. Defaults to "utf-8".
|
|
80
|
+
|
|
81
|
+
Returns:
|
|
82
|
+
Dict[str, str]: A dictionary indicating the success of the operation or an error message.
|
|
83
|
+
For example:
|
|
84
|
+
{
|
|
85
|
+
"message": "Notebook written successfully",
|
|
86
|
+
"file_path": "path/to/notebook.ipynb"
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
Or in case of an error:
|
|
90
|
+
{
|
|
91
|
+
"error": "An error occurred: <error message>"
|
|
92
|
+
}
|
|
93
|
+
"""
|
|
94
|
+
logger.info(
|
|
95
|
+
"Attempting to write notebook to file '%s' with encoding '%s'",
|
|
96
|
+
output_file,
|
|
97
|
+
encoding,
|
|
98
|
+
)
|
|
99
|
+
|
|
100
|
+
try:
|
|
101
|
+
# Convert the notebook data to JSON text.
|
|
102
|
+
json_data = json.dumps(notebook_data, ensure_ascii=False, indent=2)
|
|
103
|
+
|
|
104
|
+
# Write the JSON data to file.
|
|
105
|
+
with open(output_file, "w", encoding=encoding) as f:
|
|
106
|
+
f.write(json_data)
|
|
107
|
+
logger.info("Notebook successfully written to '%s'", output_file)
|
|
108
|
+
|
|
109
|
+
# Optional read-back check to confirm integrity.
|
|
110
|
+
with open(output_file, "r", encoding=encoding) as f:
|
|
111
|
+
content = json.load(f)
|
|
112
|
+
if not content:
|
|
113
|
+
logger.error("Notebook data verification failed: File is empty.")
|
|
114
|
+
return {
|
|
115
|
+
"error": f"Notebook data verification failed: File '{output_file}' is empty."
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
logger.info("Notebook data verification successful for '%s'", output_file)
|
|
119
|
+
return {
|
|
120
|
+
"message": "Notebook written successfully",
|
|
121
|
+
"file_path": output_file,
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
except Exception as e:
|
|
125
|
+
error_msg = f"An error occurred during notebook write operation: {str(e)}"
|
|
126
|
+
logger.error(error_msg)
|
|
127
|
+
return {"error": error_msg}
|
swarmauri_tool_jupyterwritenotebook-0.7.0.dev2/swarmauri_tool_jupyterwritenotebook/__init__.py
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from swarmauri_tool_jupyterwritenotebook.JupyterWriteNotebookTool import (
|
|
2
|
+
JupyterWriteNotebookTool,
|
|
3
|
+
)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
__all__ = ["JupyterWriteNotebookTool"]
|
|
7
|
+
|
|
8
|
+
try:
|
|
9
|
+
# For Python 3.8 and newer
|
|
10
|
+
from importlib.metadata import version, PackageNotFoundError
|
|
11
|
+
except ImportError:
|
|
12
|
+
# For older Python versions, use the backport
|
|
13
|
+
from importlib_metadata import version, PackageNotFoundError
|
|
14
|
+
|
|
15
|
+
try:
|
|
16
|
+
__version__ = version("swarmauri_tool_jupyterwritenotebook")
|
|
17
|
+
except PackageNotFoundError:
|
|
18
|
+
# If the package is not installed (for example, during development)
|
|
19
|
+
__version__ = "0.0.0"
|