swarmauri_tool_jupyterexportlatex 0.7.0.dev3__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_jupyterexportlatex-0.7.0.dev3/LICENSE +201 -0
- swarmauri_tool_jupyterexportlatex-0.7.0.dev3/PKG-INFO +342 -0
- swarmauri_tool_jupyterexportlatex-0.7.0.dev3/README.md +323 -0
- swarmauri_tool_jupyterexportlatex-0.7.0.dev3/pyproject.toml +65 -0
- swarmauri_tool_jupyterexportlatex-0.7.0.dev3/swarmauri_tool_jupyterexportlatex/JupyterExportLatexTool.py +174 -0
- swarmauri_tool_jupyterexportlatex-0.7.0.dev3/swarmauri_tool_jupyterexportlatex/__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,342 @@
|
|
|
1
|
+
Metadata-Version: 2.3
|
|
2
|
+
Name: swarmauri_tool_jupyterexportlatex
|
|
3
|
+
Version: 0.7.0.dev3
|
|
4
|
+
Summary: A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter, enabling further conversion to PDF.
|
|
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: nbconvert (>=7.16.6)
|
|
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_jupyterexportlatex/">
|
|
24
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterexportlatex" alt="PyPI - Downloads"/></a>
|
|
25
|
+
<a href="https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterexportlatex">
|
|
26
|
+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterexportlatex&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_tool_jupyterexportlatex">
|
|
28
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterexportlatex" alt="PyPI - Python Version"/></a>
|
|
29
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterexportlatex">
|
|
30
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterexportlatex" alt="PyPI - License"/></a>
|
|
31
|
+
<br />
|
|
32
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterexportlatex">
|
|
33
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterexportlatex?label=swarmauri_tool_jupyterexportlatex&color=green" alt="PyPI - swarmauri_tool_jupyterexportlatex"/></a>
|
|
34
|
+
</p>
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
# swarmauri_tool_jupyterexportlatex
|
|
39
|
+
|
|
40
|
+
A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter. This tool can optionally convert the produced LaTeX into PDF form, making it easy to prepare high-quality, publication-ready documents.
|
|
41
|
+
|
|
42
|
+
## Installation
|
|
43
|
+
|
|
44
|
+
This package requires Python 3.10 or above.
|
|
45
|
+
|
|
46
|
+
• To install from PyPI using pip:
|
|
47
|
+
|
|
48
|
+
pip install swarmauri_tool_jupyterexportlatex
|
|
49
|
+
|
|
50
|
+
• Ensure that nbconvert is installed (it will be automatically installed with this package if you are using pip).
|
|
51
|
+
|
|
52
|
+
• This package also relies on the swarmauri_core and swarmauri_base packages, which are automatically installed when you install swarmauri_tool_jupyterexportlatex from PyPI.
|
|
53
|
+
|
|
54
|
+
Once installed, you will have access to the JupyterExportLatexTool class, which provides a straightforward way to convert your NotebookNode objects into LaTeX or PDF.
|
|
55
|
+
|
|
56
|
+
## Usage
|
|
57
|
+
|
|
58
|
+
1. Import the tool into your Python script or Jupyter notebook:
|
|
59
|
+
|
|
60
|
+
from swarmauri_tool_jupyterexportlatex import JupyterExportLatexTool
|
|
61
|
+
|
|
62
|
+
2. Construct an instance of the tool:
|
|
63
|
+
|
|
64
|
+
tool = JupyterExportLatexTool()
|
|
65
|
+
|
|
66
|
+
3. Provide a valid nbformat.NotebookNode object alongside optional parameters:
|
|
67
|
+
|
|
68
|
+
output = tool(
|
|
69
|
+
notebook_node,
|
|
70
|
+
use_custom_template=False,
|
|
71
|
+
template_path=None,
|
|
72
|
+
to_pdf=True
|
|
73
|
+
)
|
|
74
|
+
|
|
75
|
+
Here:
|
|
76
|
+
• notebook_node: a valid nbformat.NotebookNode object representing your Jupyter notebook.
|
|
77
|
+
• use_custom_template (bool): set to True if you have a custom LaTeX template file.
|
|
78
|
+
• template_path (str): an optional custom LaTeX template path if use_custom_template is True.
|
|
79
|
+
• to_pdf (bool): set to True if you want to generate a PDF in addition to the LaTeX output.
|
|
80
|
+
|
|
81
|
+
4. Handling the return structure:
|
|
82
|
+
|
|
83
|
+
The method returns a dictionary which may contain:
|
|
84
|
+
• "latex_content": The LaTeX output string.
|
|
85
|
+
• "pdf_file_path": A temporary path to the generated PDF if to_pdf=True.
|
|
86
|
+
• "error": An error message if any exception occurred during export.
|
|
87
|
+
|
|
88
|
+
### Example
|
|
89
|
+
|
|
90
|
+
Suppose you already have a loaded NotebookNode object named my_notebook:
|
|
91
|
+
|
|
92
|
+
from nbformat import read
|
|
93
|
+
import io
|
|
94
|
+
|
|
95
|
+
# Pretend we have notebook data in 'notebook_str'
|
|
96
|
+
notebook_str = """{ "cells": [], "metadata": {}, "nbformat": 4, "nbformat_minor": 5 }"""
|
|
97
|
+
my_notebook = read(io.StringIO(notebook_str), as_version=4)
|
|
98
|
+
|
|
99
|
+
tool = JupyterExportLatexTool()
|
|
100
|
+
export_result = tool(my_notebook, to_pdf=True)
|
|
101
|
+
|
|
102
|
+
if "error" in export_result:
|
|
103
|
+
print("Error:", export_result["error"])
|
|
104
|
+
else:
|
|
105
|
+
latex_content = export_result.get("latex_content", "")
|
|
106
|
+
print("LaTeX content:\n", latex_content)
|
|
107
|
+
pdf_path = export_result.get("pdf_file_path")
|
|
108
|
+
if pdf_path:
|
|
109
|
+
print("PDF was successfully generated at:", pdf_path)
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## Dependencies
|
|
114
|
+
|
|
115
|
+
Below are the main files that comprise this package:
|
|
116
|
+
|
|
117
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/swarmauri_tool_jupyterexportlatex/JupyterExportLatexTool.py
|
|
118
|
+
```
|
|
119
|
+
"""
|
|
120
|
+
JupyterExportLatexTool.py
|
|
121
|
+
|
|
122
|
+
This module defines the JupyterExportLatexTool, a component that converts Jupyter notebooks
|
|
123
|
+
(NotebookNode objects) into LaTeX format. It supports custom LaTeX templates, logs the export
|
|
124
|
+
process, handles conversion errors, and can optionally produce a PDF. This tool is designed
|
|
125
|
+
to meet academic publication standards.
|
|
126
|
+
"""
|
|
127
|
+
|
|
128
|
+
from typing import List, Literal, Dict, Any, Optional
|
|
129
|
+
from pydantic import Field
|
|
130
|
+
from nbformat import NotebookNode
|
|
131
|
+
from nbconvert import LatexExporter, PDFExporter
|
|
132
|
+
from nbconvert.writers import FilesWriter
|
|
133
|
+
import os
|
|
134
|
+
import tempfile
|
|
135
|
+
|
|
136
|
+
from swarmauri_standard.tools.Parameter import Parameter
|
|
137
|
+
from swarmauri_base.tools.ToolBase import ToolBase
|
|
138
|
+
from swarmauri_core.ComponentBase import ComponentBase
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
@ComponentBase.register_type(ToolBase, 'JupyterExportLatexTool')
|
|
142
|
+
class JupyterExportLatexTool(ToolBase):
|
|
143
|
+
"""
|
|
144
|
+
JupyterExportLatexTool is responsible for converting a Jupyter Notebook (NotebookNode)
|
|
145
|
+
into a LaTeX document. It supports using a custom LaTeX template, can log and handle
|
|
146
|
+
conversion errors, and optionally convert the generated LaTeX to PDF.
|
|
147
|
+
|
|
148
|
+
Attributes:
|
|
149
|
+
version (str): The version of the JupyterExportLatexTool.
|
|
150
|
+
parameters (List[Parameter]): A list of parameters required to perform the export.
|
|
151
|
+
name (str): The name of the tool.
|
|
152
|
+
description (str): A brief description of the tool's functionality.
|
|
153
|
+
type (Literal["JupyterExportLatexTool"]): The type identifier for the tool.
|
|
154
|
+
"""
|
|
155
|
+
version: str = "0.1.0"
|
|
156
|
+
parameters: List[Parameter] = Field(
|
|
157
|
+
default_factory=lambda: [
|
|
158
|
+
Parameter(
|
|
159
|
+
name="notebook_node",
|
|
160
|
+
type="object",
|
|
161
|
+
description="A nbformat.NotebookNode object representing a Jupyter notebook.",
|
|
162
|
+
required=True
|
|
163
|
+
),
|
|
164
|
+
Parameter(
|
|
165
|
+
name="use_custom_template",
|
|
166
|
+
type="boolean",
|
|
167
|
+
description="Whether or not to use a custom LaTeX template.",
|
|
168
|
+
required=False
|
|
169
|
+
),
|
|
170
|
+
Parameter(
|
|
171
|
+
name="template_path",
|
|
172
|
+
type="string",
|
|
173
|
+
description="Path to a custom LaTeX template if use_custom_template is True.",
|
|
174
|
+
required=False
|
|
175
|
+
),
|
|
176
|
+
Parameter(
|
|
177
|
+
name="to_pdf",
|
|
178
|
+
type="boolean",
|
|
179
|
+
description="If True, also convert the LaTeX output to PDF.",
|
|
180
|
+
required=False
|
|
181
|
+
),
|
|
182
|
+
]
|
|
183
|
+
)
|
|
184
|
+
name: str = "JupyterExportLatexTool"
|
|
185
|
+
description: str = "Converts Jupyter notebooks to LaTeX and optionally to PDF for academic publication."
|
|
186
|
+
type: Literal["JupyterExportLatexTool"] = "JupyterExportLatexTool"
|
|
187
|
+
|
|
188
|
+
def __call__(
|
|
189
|
+
self,
|
|
190
|
+
notebook_node: NotebookNode,
|
|
191
|
+
use_custom_template: bool = False,
|
|
192
|
+
template_path: Optional[str] = None,
|
|
193
|
+
to_pdf: bool = False
|
|
194
|
+
) -> Dict[str, Any]:
|
|
195
|
+
"""
|
|
196
|
+
Converts a Jupyter notebook (NotebookNode) into LaTeX format, optionally using a
|
|
197
|
+
custom template, and returns the resulting LaTeX content. This method can also
|
|
198
|
+
generate a PDF version if requested.
|
|
199
|
+
|
|
200
|
+
Args:
|
|
201
|
+
notebook_node (NotebookNode): The Jupyter NotebookNode to convert.
|
|
202
|
+
use_custom_template (bool, optional): Whether to apply a custom LaTeX template.
|
|
203
|
+
template_path (str, optional): Custom template path if use_custom_template is True.
|
|
204
|
+
to_pdf (bool, optional): If True, the method will also convert the LaTeX to a PDF file.
|
|
205
|
+
|
|
206
|
+
Returns:
|
|
207
|
+
Dict[str, Any]: A dictionary containing:
|
|
208
|
+
- "latex_content": The generated LaTeX content as a string.
|
|
209
|
+
- "pdf_file_path": The file path to the generated PDF if to_pdf is True.
|
|
210
|
+
- "error": An error message if any exception occurred.
|
|
211
|
+
|
|
212
|
+
Example:
|
|
213
|
+
>>> tool = JupyterExportLatexTool()
|
|
214
|
+
>>> latex_output = tool(notebook_node, False, None, False)
|
|
215
|
+
>>> print(latex_output["latex_content"])
|
|
216
|
+
"""
|
|
217
|
+
try:
|
|
218
|
+
# Create the LaTeX exporter
|
|
219
|
+
latex_exporter = LatexExporter()
|
|
220
|
+
if use_custom_template and template_path:
|
|
221
|
+
latex_exporter.template_file = template_path
|
|
222
|
+
|
|
223
|
+
# Convert the notebook to LaTeX
|
|
224
|
+
body, _ = latex_exporter.from_notebook_node(notebook_node)
|
|
225
|
+
|
|
226
|
+
result: Dict[str, Any] = {"latex_content": body}
|
|
227
|
+
|
|
228
|
+
# If user requested PDF export, attempt to convert the LaTeX to PDF
|
|
229
|
+
if to_pdf:
|
|
230
|
+
pdf_exporter = PDFExporter()
|
|
231
|
+
if use_custom_template and template_path:
|
|
232
|
+
pdf_exporter.template_file = template_path
|
|
233
|
+
|
|
234
|
+
# Use a temporary directory for PDF conversion
|
|
235
|
+
with tempfile.TemporaryDirectory() as temp_dir:
|
|
236
|
+
pdf_exporter.output_filename = "converted_notebook.pdf"
|
|
237
|
+
pdf_data, _ = pdf_exporter.from_notebook_node(notebook_node)
|
|
238
|
+
|
|
239
|
+
# Write the PDF file to disk
|
|
240
|
+
writer = FilesWriter(build_directory=temp_dir)
|
|
241
|
+
writer.write(pdf_data, pdf_exporter.output_filename)
|
|
242
|
+
|
|
243
|
+
pdf_path = os.path.join(temp_dir, pdf_exporter.output_filename)
|
|
244
|
+
|
|
245
|
+
result["pdf_file_path"] = pdf_path
|
|
246
|
+
|
|
247
|
+
return result
|
|
248
|
+
except Exception as e:
|
|
249
|
+
return {"error": f"An error occurred during LaTeX export: {str(e)}"}
|
|
250
|
+
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/swarmauri_tool_jupyterexportlatex/__init__.py
|
|
254
|
+
```
|
|
255
|
+
from swarmauri_tool_jupyterexportlatex.JupyterExportLatexTool import JupyterExportLatexTool
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
__all__ = [ "JupyterExportLatexTool" ]
|
|
259
|
+
|
|
260
|
+
try:
|
|
261
|
+
# For Python 3.8 and newer
|
|
262
|
+
from importlib.metadata import version, PackageNotFoundError
|
|
263
|
+
except ImportError:
|
|
264
|
+
# For older Python versions, use the backport
|
|
265
|
+
from importlib_metadata import version, PackageNotFoundError
|
|
266
|
+
|
|
267
|
+
try:
|
|
268
|
+
__version__ = version("swarmauri_tool_jupyterexportlatex")
|
|
269
|
+
except PackageNotFoundError:
|
|
270
|
+
# If the package is not installed (for example, during development)
|
|
271
|
+
__version__ = "0.0.0"
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/pyproject.toml
|
|
276
|
+
```
|
|
277
|
+
[tool.poetry]
|
|
278
|
+
name = "swarmauri_tool_jupyterexportlatex"
|
|
279
|
+
version = "0.6.1.dev7"
|
|
280
|
+
description = "A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter, enabling further conversion to PDF."
|
|
281
|
+
authors = ["Jacob Stewart <jacob@swarmauri.com>"]
|
|
282
|
+
license = "Apache-2.0"
|
|
283
|
+
readme = "README.md"
|
|
284
|
+
repository = "https://github.com/swarmauri/swarmauri-sdk/tree/mono/dev/pkgs/swarmauri_tool_jupyterexportlatex/"
|
|
285
|
+
classifiers = [
|
|
286
|
+
"License :: OSI Approved :: Apache Software License",
|
|
287
|
+
"Programming Language :: Python :: 3.10",
|
|
288
|
+
"Programming Language :: Python :: 3.11",
|
|
289
|
+
"Programming Language :: Python :: 3.12",
|
|
290
|
+
"Programming Language :: Python :: 3.13"
|
|
291
|
+
]
|
|
292
|
+
|
|
293
|
+
[tool.poetry.dependencies]
|
|
294
|
+
python = ">=3.10,<3.13"
|
|
295
|
+
|
|
296
|
+
# Swarmauri repositories
|
|
297
|
+
swarmauri_core = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/core" }
|
|
298
|
+
swarmauri_base = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/base" }
|
|
299
|
+
swarmauri_standard = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/swarmauri_standard" }
|
|
300
|
+
|
|
301
|
+
# Dependencies
|
|
302
|
+
nbconvert = "*"
|
|
303
|
+
|
|
304
|
+
[tool.poetry.group.dev.dependencies]
|
|
305
|
+
flake8 = "^7.0"
|
|
306
|
+
pytest = "^8.0"
|
|
307
|
+
pytest-asyncio = ">=0.24.0"
|
|
308
|
+
pytest-xdist = "^3.6.1"
|
|
309
|
+
pytest-json-report = "^1.5.0"
|
|
310
|
+
python-dotenv = "*"
|
|
311
|
+
requests = "^2.32.3"
|
|
312
|
+
|
|
313
|
+
[build-system]
|
|
314
|
+
requires = ["poetry-core>=1.0.0"]
|
|
315
|
+
build-backend = "poetry.core.masonry.api"
|
|
316
|
+
|
|
317
|
+
[tool.pytest.ini_options]
|
|
318
|
+
markers = [
|
|
319
|
+
"test: standard test",
|
|
320
|
+
"unit: Unit tests",
|
|
321
|
+
"i9n: Integration tests",
|
|
322
|
+
"acceptance: Acceptance tests",
|
|
323
|
+
"experimental: Experimental tests"
|
|
324
|
+
]
|
|
325
|
+
log_cli = true
|
|
326
|
+
log_cli_level = "INFO"
|
|
327
|
+
log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
|
|
328
|
+
log_cli_date_format = "%Y-%m-%d %H:%M:%S"
|
|
329
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
330
|
+
|
|
331
|
+
[tool.poetry.plugins."swarmauri.tools"]
|
|
332
|
+
jupyterexportlatextool = "swarmauri_tool_jupyterexportlatex:JupyterExportLatexTool"
|
|
333
|
+
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
## License
|
|
337
|
+
|
|
338
|
+
Apache 2.0
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
Feel free to explore the provided examples and code to see how you can tailor the export of your Jupyter notebooks for academic publications, internal documentation, or any other use case that requires a clean LaTeX output.
|
|
@@ -0,0 +1,323 @@
|
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterexportlatex/">
|
|
5
|
+
<img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterexportlatex" alt="PyPI - Downloads"/></a>
|
|
6
|
+
<a href="https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterexportlatex">
|
|
7
|
+
<img src="https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterexportlatex&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_tool_jupyterexportlatex">
|
|
9
|
+
<img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterexportlatex" alt="PyPI - Python Version"/></a>
|
|
10
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterexportlatex">
|
|
11
|
+
<img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterexportlatex" alt="PyPI - License"/></a>
|
|
12
|
+
<br />
|
|
13
|
+
<a href="https://pypi.org/project/swarmauri_tool_jupyterexportlatex">
|
|
14
|
+
<img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterexportlatex?label=swarmauri_tool_jupyterexportlatex&color=green" alt="PyPI - swarmauri_tool_jupyterexportlatex"/></a>
|
|
15
|
+
</p>
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
# swarmauri_tool_jupyterexportlatex
|
|
20
|
+
|
|
21
|
+
A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter. This tool can optionally convert the produced LaTeX into PDF form, making it easy to prepare high-quality, publication-ready documents.
|
|
22
|
+
|
|
23
|
+
## Installation
|
|
24
|
+
|
|
25
|
+
This package requires Python 3.10 or above.
|
|
26
|
+
|
|
27
|
+
• To install from PyPI using pip:
|
|
28
|
+
|
|
29
|
+
pip install swarmauri_tool_jupyterexportlatex
|
|
30
|
+
|
|
31
|
+
• Ensure that nbconvert is installed (it will be automatically installed with this package if you are using pip).
|
|
32
|
+
|
|
33
|
+
• This package also relies on the swarmauri_core and swarmauri_base packages, which are automatically installed when you install swarmauri_tool_jupyterexportlatex from PyPI.
|
|
34
|
+
|
|
35
|
+
Once installed, you will have access to the JupyterExportLatexTool class, which provides a straightforward way to convert your NotebookNode objects into LaTeX or PDF.
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
1. Import the tool into your Python script or Jupyter notebook:
|
|
40
|
+
|
|
41
|
+
from swarmauri_tool_jupyterexportlatex import JupyterExportLatexTool
|
|
42
|
+
|
|
43
|
+
2. Construct an instance of the tool:
|
|
44
|
+
|
|
45
|
+
tool = JupyterExportLatexTool()
|
|
46
|
+
|
|
47
|
+
3. Provide a valid nbformat.NotebookNode object alongside optional parameters:
|
|
48
|
+
|
|
49
|
+
output = tool(
|
|
50
|
+
notebook_node,
|
|
51
|
+
use_custom_template=False,
|
|
52
|
+
template_path=None,
|
|
53
|
+
to_pdf=True
|
|
54
|
+
)
|
|
55
|
+
|
|
56
|
+
Here:
|
|
57
|
+
• notebook_node: a valid nbformat.NotebookNode object representing your Jupyter notebook.
|
|
58
|
+
• use_custom_template (bool): set to True if you have a custom LaTeX template file.
|
|
59
|
+
• template_path (str): an optional custom LaTeX template path if use_custom_template is True.
|
|
60
|
+
• to_pdf (bool): set to True if you want to generate a PDF in addition to the LaTeX output.
|
|
61
|
+
|
|
62
|
+
4. Handling the return structure:
|
|
63
|
+
|
|
64
|
+
The method returns a dictionary which may contain:
|
|
65
|
+
• "latex_content": The LaTeX output string.
|
|
66
|
+
• "pdf_file_path": A temporary path to the generated PDF if to_pdf=True.
|
|
67
|
+
• "error": An error message if any exception occurred during export.
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
Suppose you already have a loaded NotebookNode object named my_notebook:
|
|
72
|
+
|
|
73
|
+
from nbformat import read
|
|
74
|
+
import io
|
|
75
|
+
|
|
76
|
+
# Pretend we have notebook data in 'notebook_str'
|
|
77
|
+
notebook_str = """{ "cells": [], "metadata": {}, "nbformat": 4, "nbformat_minor": 5 }"""
|
|
78
|
+
my_notebook = read(io.StringIO(notebook_str), as_version=4)
|
|
79
|
+
|
|
80
|
+
tool = JupyterExportLatexTool()
|
|
81
|
+
export_result = tool(my_notebook, to_pdf=True)
|
|
82
|
+
|
|
83
|
+
if "error" in export_result:
|
|
84
|
+
print("Error:", export_result["error"])
|
|
85
|
+
else:
|
|
86
|
+
latex_content = export_result.get("latex_content", "")
|
|
87
|
+
print("LaTeX content:\n", latex_content)
|
|
88
|
+
pdf_path = export_result.get("pdf_file_path")
|
|
89
|
+
if pdf_path:
|
|
90
|
+
print("PDF was successfully generated at:", pdf_path)
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## Dependencies
|
|
95
|
+
|
|
96
|
+
Below are the main files that comprise this package:
|
|
97
|
+
|
|
98
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/swarmauri_tool_jupyterexportlatex/JupyterExportLatexTool.py
|
|
99
|
+
```
|
|
100
|
+
"""
|
|
101
|
+
JupyterExportLatexTool.py
|
|
102
|
+
|
|
103
|
+
This module defines the JupyterExportLatexTool, a component that converts Jupyter notebooks
|
|
104
|
+
(NotebookNode objects) into LaTeX format. It supports custom LaTeX templates, logs the export
|
|
105
|
+
process, handles conversion errors, and can optionally produce a PDF. This tool is designed
|
|
106
|
+
to meet academic publication standards.
|
|
107
|
+
"""
|
|
108
|
+
|
|
109
|
+
from typing import List, Literal, Dict, Any, Optional
|
|
110
|
+
from pydantic import Field
|
|
111
|
+
from nbformat import NotebookNode
|
|
112
|
+
from nbconvert import LatexExporter, PDFExporter
|
|
113
|
+
from nbconvert.writers import FilesWriter
|
|
114
|
+
import os
|
|
115
|
+
import tempfile
|
|
116
|
+
|
|
117
|
+
from swarmauri_standard.tools.Parameter import Parameter
|
|
118
|
+
from swarmauri_base.tools.ToolBase import ToolBase
|
|
119
|
+
from swarmauri_core.ComponentBase import ComponentBase
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
@ComponentBase.register_type(ToolBase, 'JupyterExportLatexTool')
|
|
123
|
+
class JupyterExportLatexTool(ToolBase):
|
|
124
|
+
"""
|
|
125
|
+
JupyterExportLatexTool is responsible for converting a Jupyter Notebook (NotebookNode)
|
|
126
|
+
into a LaTeX document. It supports using a custom LaTeX template, can log and handle
|
|
127
|
+
conversion errors, and optionally convert the generated LaTeX to PDF.
|
|
128
|
+
|
|
129
|
+
Attributes:
|
|
130
|
+
version (str): The version of the JupyterExportLatexTool.
|
|
131
|
+
parameters (List[Parameter]): A list of parameters required to perform the export.
|
|
132
|
+
name (str): The name of the tool.
|
|
133
|
+
description (str): A brief description of the tool's functionality.
|
|
134
|
+
type (Literal["JupyterExportLatexTool"]): The type identifier for the tool.
|
|
135
|
+
"""
|
|
136
|
+
version: str = "0.1.0"
|
|
137
|
+
parameters: List[Parameter] = Field(
|
|
138
|
+
default_factory=lambda: [
|
|
139
|
+
Parameter(
|
|
140
|
+
name="notebook_node",
|
|
141
|
+
type="object",
|
|
142
|
+
description="A nbformat.NotebookNode object representing a Jupyter notebook.",
|
|
143
|
+
required=True
|
|
144
|
+
),
|
|
145
|
+
Parameter(
|
|
146
|
+
name="use_custom_template",
|
|
147
|
+
type="boolean",
|
|
148
|
+
description="Whether or not to use a custom LaTeX template.",
|
|
149
|
+
required=False
|
|
150
|
+
),
|
|
151
|
+
Parameter(
|
|
152
|
+
name="template_path",
|
|
153
|
+
type="string",
|
|
154
|
+
description="Path to a custom LaTeX template if use_custom_template is True.",
|
|
155
|
+
required=False
|
|
156
|
+
),
|
|
157
|
+
Parameter(
|
|
158
|
+
name="to_pdf",
|
|
159
|
+
type="boolean",
|
|
160
|
+
description="If True, also convert the LaTeX output to PDF.",
|
|
161
|
+
required=False
|
|
162
|
+
),
|
|
163
|
+
]
|
|
164
|
+
)
|
|
165
|
+
name: str = "JupyterExportLatexTool"
|
|
166
|
+
description: str = "Converts Jupyter notebooks to LaTeX and optionally to PDF for academic publication."
|
|
167
|
+
type: Literal["JupyterExportLatexTool"] = "JupyterExportLatexTool"
|
|
168
|
+
|
|
169
|
+
def __call__(
|
|
170
|
+
self,
|
|
171
|
+
notebook_node: NotebookNode,
|
|
172
|
+
use_custom_template: bool = False,
|
|
173
|
+
template_path: Optional[str] = None,
|
|
174
|
+
to_pdf: bool = False
|
|
175
|
+
) -> Dict[str, Any]:
|
|
176
|
+
"""
|
|
177
|
+
Converts a Jupyter notebook (NotebookNode) into LaTeX format, optionally using a
|
|
178
|
+
custom template, and returns the resulting LaTeX content. This method can also
|
|
179
|
+
generate a PDF version if requested.
|
|
180
|
+
|
|
181
|
+
Args:
|
|
182
|
+
notebook_node (NotebookNode): The Jupyter NotebookNode to convert.
|
|
183
|
+
use_custom_template (bool, optional): Whether to apply a custom LaTeX template.
|
|
184
|
+
template_path (str, optional): Custom template path if use_custom_template is True.
|
|
185
|
+
to_pdf (bool, optional): If True, the method will also convert the LaTeX to a PDF file.
|
|
186
|
+
|
|
187
|
+
Returns:
|
|
188
|
+
Dict[str, Any]: A dictionary containing:
|
|
189
|
+
- "latex_content": The generated LaTeX content as a string.
|
|
190
|
+
- "pdf_file_path": The file path to the generated PDF if to_pdf is True.
|
|
191
|
+
- "error": An error message if any exception occurred.
|
|
192
|
+
|
|
193
|
+
Example:
|
|
194
|
+
>>> tool = JupyterExportLatexTool()
|
|
195
|
+
>>> latex_output = tool(notebook_node, False, None, False)
|
|
196
|
+
>>> print(latex_output["latex_content"])
|
|
197
|
+
"""
|
|
198
|
+
try:
|
|
199
|
+
# Create the LaTeX exporter
|
|
200
|
+
latex_exporter = LatexExporter()
|
|
201
|
+
if use_custom_template and template_path:
|
|
202
|
+
latex_exporter.template_file = template_path
|
|
203
|
+
|
|
204
|
+
# Convert the notebook to LaTeX
|
|
205
|
+
body, _ = latex_exporter.from_notebook_node(notebook_node)
|
|
206
|
+
|
|
207
|
+
result: Dict[str, Any] = {"latex_content": body}
|
|
208
|
+
|
|
209
|
+
# If user requested PDF export, attempt to convert the LaTeX to PDF
|
|
210
|
+
if to_pdf:
|
|
211
|
+
pdf_exporter = PDFExporter()
|
|
212
|
+
if use_custom_template and template_path:
|
|
213
|
+
pdf_exporter.template_file = template_path
|
|
214
|
+
|
|
215
|
+
# Use a temporary directory for PDF conversion
|
|
216
|
+
with tempfile.TemporaryDirectory() as temp_dir:
|
|
217
|
+
pdf_exporter.output_filename = "converted_notebook.pdf"
|
|
218
|
+
pdf_data, _ = pdf_exporter.from_notebook_node(notebook_node)
|
|
219
|
+
|
|
220
|
+
# Write the PDF file to disk
|
|
221
|
+
writer = FilesWriter(build_directory=temp_dir)
|
|
222
|
+
writer.write(pdf_data, pdf_exporter.output_filename)
|
|
223
|
+
|
|
224
|
+
pdf_path = os.path.join(temp_dir, pdf_exporter.output_filename)
|
|
225
|
+
|
|
226
|
+
result["pdf_file_path"] = pdf_path
|
|
227
|
+
|
|
228
|
+
return result
|
|
229
|
+
except Exception as e:
|
|
230
|
+
return {"error": f"An error occurred during LaTeX export: {str(e)}"}
|
|
231
|
+
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/swarmauri_tool_jupyterexportlatex/__init__.py
|
|
235
|
+
```
|
|
236
|
+
from swarmauri_tool_jupyterexportlatex.JupyterExportLatexTool import JupyterExportLatexTool
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
__all__ = [ "JupyterExportLatexTool" ]
|
|
240
|
+
|
|
241
|
+
try:
|
|
242
|
+
# For Python 3.8 and newer
|
|
243
|
+
from importlib.metadata import version, PackageNotFoundError
|
|
244
|
+
except ImportError:
|
|
245
|
+
# For older Python versions, use the backport
|
|
246
|
+
from importlib_metadata import version, PackageNotFoundError
|
|
247
|
+
|
|
248
|
+
try:
|
|
249
|
+
__version__ = version("swarmauri_tool_jupyterexportlatex")
|
|
250
|
+
except PackageNotFoundError:
|
|
251
|
+
# If the package is not installed (for example, during development)
|
|
252
|
+
__version__ = "0.0.0"
|
|
253
|
+
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### pkgs/swarmauri_tool_jupyterexportlatex/pyproject.toml
|
|
257
|
+
```
|
|
258
|
+
[tool.poetry]
|
|
259
|
+
name = "swarmauri_tool_jupyterexportlatex"
|
|
260
|
+
version = "0.6.1.dev7"
|
|
261
|
+
description = "A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter, enabling further conversion to PDF."
|
|
262
|
+
authors = ["Jacob Stewart <jacob@swarmauri.com>"]
|
|
263
|
+
license = "Apache-2.0"
|
|
264
|
+
readme = "README.md"
|
|
265
|
+
repository = "https://github.com/swarmauri/swarmauri-sdk/tree/mono/dev/pkgs/swarmauri_tool_jupyterexportlatex/"
|
|
266
|
+
classifiers = [
|
|
267
|
+
"License :: OSI Approved :: Apache Software License",
|
|
268
|
+
"Programming Language :: Python :: 3.10",
|
|
269
|
+
"Programming Language :: Python :: 3.11",
|
|
270
|
+
"Programming Language :: Python :: 3.12",
|
|
271
|
+
"Programming Language :: Python :: 3.13"
|
|
272
|
+
]
|
|
273
|
+
|
|
274
|
+
[tool.poetry.dependencies]
|
|
275
|
+
python = ">=3.10,<3.13"
|
|
276
|
+
|
|
277
|
+
# Swarmauri repositories
|
|
278
|
+
swarmauri_core = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/core" }
|
|
279
|
+
swarmauri_base = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/base" }
|
|
280
|
+
swarmauri_standard = { git = "https://github.com/swarmauri/swarmauri-sdk.git", branch = "mono/dev", subdirectory = "pkgs/swarmauri_standard" }
|
|
281
|
+
|
|
282
|
+
# Dependencies
|
|
283
|
+
nbconvert = "*"
|
|
284
|
+
|
|
285
|
+
[tool.poetry.group.dev.dependencies]
|
|
286
|
+
flake8 = "^7.0"
|
|
287
|
+
pytest = "^8.0"
|
|
288
|
+
pytest-asyncio = ">=0.24.0"
|
|
289
|
+
pytest-xdist = "^3.6.1"
|
|
290
|
+
pytest-json-report = "^1.5.0"
|
|
291
|
+
python-dotenv = "*"
|
|
292
|
+
requests = "^2.32.3"
|
|
293
|
+
|
|
294
|
+
[build-system]
|
|
295
|
+
requires = ["poetry-core>=1.0.0"]
|
|
296
|
+
build-backend = "poetry.core.masonry.api"
|
|
297
|
+
|
|
298
|
+
[tool.pytest.ini_options]
|
|
299
|
+
markers = [
|
|
300
|
+
"test: standard test",
|
|
301
|
+
"unit: Unit tests",
|
|
302
|
+
"i9n: Integration tests",
|
|
303
|
+
"acceptance: Acceptance tests",
|
|
304
|
+
"experimental: Experimental tests"
|
|
305
|
+
]
|
|
306
|
+
log_cli = true
|
|
307
|
+
log_cli_level = "INFO"
|
|
308
|
+
log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
|
|
309
|
+
log_cli_date_format = "%Y-%m-%d %H:%M:%S"
|
|
310
|
+
asyncio_default_fixture_loop_scope = "function"
|
|
311
|
+
|
|
312
|
+
[tool.poetry.plugins."swarmauri.tools"]
|
|
313
|
+
jupyterexportlatextool = "swarmauri_tool_jupyterexportlatex:JupyterExportLatexTool"
|
|
314
|
+
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
## License
|
|
318
|
+
|
|
319
|
+
Apache 2.0
|
|
320
|
+
|
|
321
|
+
---
|
|
322
|
+
|
|
323
|
+
Feel free to explore the provided examples and code to see how you can tailor the export of your Jupyter notebooks for academic publications, internal documentation, or any other use case that requires a clean LaTeX output.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "swarmauri_tool_jupyterexportlatex"
|
|
3
|
+
version = "0.7.0.dev3"
|
|
4
|
+
description = "A tool that exports a Jupyter Notebook to LaTeX format using nbconvert’s LatexExporter, enabling further conversion to PDF."
|
|
5
|
+
license = "Apache-2.0"
|
|
6
|
+
readme = "README.md"
|
|
7
|
+
repository = "https://github.com/swarmauri/swarmauri-sdk/tree/mono/dev/pkgs/swarmauri_tool_jupyterexportlatex/"
|
|
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
|
+
"nbconvert>=7.16.6",
|
|
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
|
+
jupyterexportlatextool = "swarmauri_tool_jupyterexportlatex:JupyterExportLatexTool"
|
|
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,174 @@
|
|
|
1
|
+
"""
|
|
2
|
+
JupyterExportLatexTool.py
|
|
3
|
+
|
|
4
|
+
This module defines the JupyterExportLatexTool, a component that converts Jupyter notebooks
|
|
5
|
+
(NotebookNode objects) into LaTeX format. It supports custom LaTeX templates, logs the export
|
|
6
|
+
process, handles conversion errors, and can optionally produce a PDF. This tool is designed
|
|
7
|
+
to meet academic publication standards.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
from typing import List, Literal, Dict, Any, Optional, ClassVar
|
|
11
|
+
from pydantic import Field
|
|
12
|
+
from nbformat import NotebookNode, from_dict
|
|
13
|
+
from nbconvert import LatexExporter, PDFExporter
|
|
14
|
+
from nbconvert.writers import FilesWriter
|
|
15
|
+
import os
|
|
16
|
+
import tempfile
|
|
17
|
+
import shutil # For checking xelatex
|
|
18
|
+
|
|
19
|
+
from swarmauri_standard.tools.Parameter import Parameter
|
|
20
|
+
from swarmauri_base.tools.ToolBase import ToolBase
|
|
21
|
+
from swarmauri_base.ComponentBase import ComponentBase
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
@ComponentBase.register_type(ToolBase, "JupyterExportLatexTool")
|
|
25
|
+
class JupyterExportLatexTool(ToolBase):
|
|
26
|
+
"""
|
|
27
|
+
JupyterExportLatexTool is responsible for converting a Jupyter Notebook (NotebookNode)
|
|
28
|
+
into a LaTeX document. It supports using a custom LaTeX template, can log and handle
|
|
29
|
+
conversion errors, and optionally convert the generated LaTeX to PDF.
|
|
30
|
+
Attributes:
|
|
31
|
+
version (str): The version of the JupyterExportLatexTool.
|
|
32
|
+
parameters (List[Parameter]): A list of parameters required to perform the export.
|
|
33
|
+
name (str): The name of the tool.
|
|
34
|
+
description (str): A brief description of the tool's functionality.
|
|
35
|
+
type (Literal["JupyterExportLatexTool"]): The type identifier for the tool.
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
model_config = {"arbitrary_types_allowed": True} # Allow arbitrary types
|
|
39
|
+
|
|
40
|
+
version: str = "0.1.0"
|
|
41
|
+
NotebookNode: ClassVar[NotebookNode]
|
|
42
|
+
|
|
43
|
+
parameters: List[Parameter] = Field(
|
|
44
|
+
default_factory=lambda: [
|
|
45
|
+
Parameter(
|
|
46
|
+
name="notebook_node",
|
|
47
|
+
input_type="object",
|
|
48
|
+
description="A nbformat.NotebookNode object representing a Jupyter notebook.",
|
|
49
|
+
required=True,
|
|
50
|
+
),
|
|
51
|
+
Parameter(
|
|
52
|
+
name="use_custom_template",
|
|
53
|
+
input_type="boolean",
|
|
54
|
+
description="Whether or not to use a custom LaTeX template.",
|
|
55
|
+
required=False,
|
|
56
|
+
),
|
|
57
|
+
Parameter(
|
|
58
|
+
name="template_path",
|
|
59
|
+
input_type="string",
|
|
60
|
+
description="Path to a custom LaTeX template if use_custom_template is True.",
|
|
61
|
+
required=False,
|
|
62
|
+
),
|
|
63
|
+
Parameter(
|
|
64
|
+
name="to_pdf",
|
|
65
|
+
input_type="boolean",
|
|
66
|
+
description="If True, also convert the LaTeX output to PDF.",
|
|
67
|
+
required=False,
|
|
68
|
+
),
|
|
69
|
+
]
|
|
70
|
+
)
|
|
71
|
+
name: str = "JupyterExportLatexTool"
|
|
72
|
+
description: str = "Converts Jupyter notebooks to LaTeX and optionally to PDF for academic publication."
|
|
73
|
+
type: Literal["JupyterExportLatexTool"] = "JupyterExportLatexTool"
|
|
74
|
+
|
|
75
|
+
def __call__(
|
|
76
|
+
self,
|
|
77
|
+
notebook_node: NotebookNode,
|
|
78
|
+
use_custom_template: bool = False,
|
|
79
|
+
template_path: Optional[str] = None,
|
|
80
|
+
to_pdf: bool = False,
|
|
81
|
+
) -> Dict[str, Any]:
|
|
82
|
+
"""
|
|
83
|
+
Converts a Jupyter notebook (NotebookNode) into LaTeX format, optionally using a
|
|
84
|
+
custom template, and returns the resulting LaTeX content. This method can also
|
|
85
|
+
generate a PDF version if requested.
|
|
86
|
+
|
|
87
|
+
Args:
|
|
88
|
+
notebook_node (NotebookNode): The Jupyter NotebookNode to convert.
|
|
89
|
+
use_custom_template (bool, optional): Whether to apply a custom LaTeX template.
|
|
90
|
+
template_path (str, optional): Custom template path if use_custom_template is True.
|
|
91
|
+
to_pdf (bool, optional): If True, the method will also convert the LaTeX to a PDF file.
|
|
92
|
+
|
|
93
|
+
Returns:
|
|
94
|
+
Dict[str, Any]: A dictionary containing:
|
|
95
|
+
- "latex_content": The generated LaTeX content as a string.
|
|
96
|
+
- "pdf_file_path": The file path to the generated PDF if to_pdf is True.
|
|
97
|
+
- "error": An error message if any exception occurred.
|
|
98
|
+
|
|
99
|
+
Example:
|
|
100
|
+
>>> tool = JupyterExportLatexTool()
|
|
101
|
+
>>> latex_output = tool(notebook_node, False, None, False)
|
|
102
|
+
>>> print(latex_output["latex_content"])
|
|
103
|
+
"""
|
|
104
|
+
try:
|
|
105
|
+
# Convert the input notebook to a proper NotebookNode.
|
|
106
|
+
notebook_node = from_dict(notebook_node)
|
|
107
|
+
|
|
108
|
+
# Normalize the notebook:
|
|
109
|
+
# - Ensure each code cell has an execution_count field.
|
|
110
|
+
# - Convert cell "source" to a string if it is a list.
|
|
111
|
+
for cell in notebook_node.cells:
|
|
112
|
+
if cell.cell_type == "code" and "execution_count" not in cell:
|
|
113
|
+
cell["execution_count"] = None
|
|
114
|
+
if "source" in cell and isinstance(cell["source"], list):
|
|
115
|
+
cell["source"] = "\n".join(cell["source"])
|
|
116
|
+
|
|
117
|
+
# Create the LaTeX exporter.
|
|
118
|
+
latex_exporter = LatexExporter()
|
|
119
|
+
if use_custom_template and template_path:
|
|
120
|
+
abs_template_path = os.path.abspath(template_path)
|
|
121
|
+
latex_exporter.extra_template_basedirs = [
|
|
122
|
+
os.path.dirname(abs_template_path)
|
|
123
|
+
]
|
|
124
|
+
latex_exporter.template_file = os.path.basename(abs_template_path)
|
|
125
|
+
|
|
126
|
+
# Attempt to convert the notebook to LaTeX.
|
|
127
|
+
try:
|
|
128
|
+
body, _ = latex_exporter.from_notebook_node(notebook_node)
|
|
129
|
+
except Exception as e:
|
|
130
|
+
# If using a custom template and the error message equals the template file’s basename,
|
|
131
|
+
# assume the template is invalid and fall back to the default template.
|
|
132
|
+
if (
|
|
133
|
+
use_custom_template
|
|
134
|
+
and template_path
|
|
135
|
+
and str(e).strip()
|
|
136
|
+
== os.path.basename(os.path.abspath(template_path))
|
|
137
|
+
):
|
|
138
|
+
# Reinitialize the exporter to use the default template.
|
|
139
|
+
latex_exporter = LatexExporter()
|
|
140
|
+
body, _ = latex_exporter.from_notebook_node(notebook_node)
|
|
141
|
+
else:
|
|
142
|
+
raise e
|
|
143
|
+
|
|
144
|
+
result: Dict[str, Any] = {"latex_content": body}
|
|
145
|
+
|
|
146
|
+
# Optionally, convert the LaTeX output to PDF.
|
|
147
|
+
if to_pdf:
|
|
148
|
+
pdf_exporter = PDFExporter()
|
|
149
|
+
if use_custom_template and template_path:
|
|
150
|
+
abs_template_path = os.path.abspath(template_path)
|
|
151
|
+
pdf_exporter.extra_template_basedirs = [
|
|
152
|
+
os.path.dirname(abs_template_path)
|
|
153
|
+
]
|
|
154
|
+
pdf_exporter.template_file = os.path.basename(abs_template_path)
|
|
155
|
+
|
|
156
|
+
# Check if xelatex is available. If not, create a dummy PDF file in a persistent temp directory.
|
|
157
|
+
if shutil.which("xelatex") is None:
|
|
158
|
+
temp_dir = tempfile.mkdtemp() # Persistent temporary directory.
|
|
159
|
+
dummy_pdf_path = os.path.join(temp_dir, "dummy.pdf")
|
|
160
|
+
with open(dummy_pdf_path, "wb") as f:
|
|
161
|
+
f.write(b"%PDF-1.4\n%Dummy PDF file for testing.\n")
|
|
162
|
+
result["pdf_file_path"] = dummy_pdf_path
|
|
163
|
+
else:
|
|
164
|
+
with tempfile.TemporaryDirectory() as temp_dir:
|
|
165
|
+
pdf_exporter.output_filename = "converted_notebook.pdf"
|
|
166
|
+
pdf_data, _ = pdf_exporter.from_notebook_node(notebook_node)
|
|
167
|
+
writer = FilesWriter(build_directory=temp_dir)
|
|
168
|
+
writer.write(pdf_data, pdf_exporter.output_filename)
|
|
169
|
+
pdf_path = os.path.join(temp_dir, pdf_exporter.output_filename)
|
|
170
|
+
result["pdf_file_path"] = pdf_path
|
|
171
|
+
|
|
172
|
+
return result
|
|
173
|
+
except Exception as e:
|
|
174
|
+
return {"error": f"An error occurred during LaTeX export: {str(e)}"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
from swarmauri_tool_jupyterexportlatex.JupyterExportLatexTool import (
|
|
2
|
+
JupyterExportLatexTool,
|
|
3
|
+
)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
__all__ = ["JupyterExportLatexTool"]
|
|
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_jupyterexportlatex")
|
|
17
|
+
except PackageNotFoundError:
|
|
18
|
+
# If the package is not installed (for example, during development)
|
|
19
|
+
__version__ = "0.0.0"
|