swarmauri_tool_jupyterstartkernel 0.9.0__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.
@@ -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,182 @@
1
+ Metadata-Version: 2.4
2
+ Name: swarmauri_tool_jupyterstartkernel
3
+ Version: 0.9.0
4
+ Summary: A tool designed to start a new Jupyter kernel programmatically using jupyter_client, enabling execution of notebook cells.
5
+ License-Expression: Apache-2.0
6
+ License-File: LICENSE
7
+ Keywords: swarmauri,tool,jupyterstartkernel,designed,start,new,jupyter,kernel,programmatically,client,enabling,execution,notebook,cells
8
+ Author: Jacob Stewart
9
+ Author-email: jacob@swarmauri.com
10
+ Requires-Python: >=3.10,<3.13
11
+ Classifier: License :: OSI Approved :: Apache Software License
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Natural Language :: English
17
+ Classifier: Development Status :: 3 - Alpha
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
20
+ Requires-Dist: ipykernel (>=6.29.5)
21
+ Requires-Dist: jupyter_client (>=8.6.3)
22
+ Requires-Dist: swarmauri_base
23
+ Requires-Dist: swarmauri_core
24
+ Requires-Dist: swarmauri_standard
25
+ Description-Content-Type: text/markdown
26
+
27
+ ![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
28
+
29
+ <p align="center">
30
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
31
+ <img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterstartkernel" alt="PyPI - Downloads"/></a>
32
+ <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_jupyterstartkernel/">
33
+ <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_jupyterstartkernel.svg"/></a>
34
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
35
+ <img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterstartkernel" alt="PyPI - Python Version"/></a>
36
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
37
+ <img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterstartkernel" alt="PyPI - License"/></a>
38
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
39
+ <img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterstartkernel?label=swarmauri_tool_jupyterstartkernel&color=green" alt="PyPI - swarmauri_tool_jupyterstartkernel"/></a>
40
+ </p>
41
+
42
+ ---
43
+
44
+ # Swarmauri Tool · Jupyter Start Kernel
45
+
46
+ A Swarmauri orchestration tool that spins up Jupyter kernels on demand using `jupyter_client`. The helper wraps connection-file management, kernel specification, and timeout handling so automation pipelines, notebook CI, or Swarmauri agents can acquire fresh kernels with one function call.
47
+
48
+ - Launches kernels with configurable names and kernel-spec overrides.
49
+ - Surfaces ready-to-use connection metadata for downstream orchestration.
50
+ - Keeps a reference to the underlying `KernelManager` so you can interact with the kernel lifecycle after launch.
51
+
52
+ ## Requirements
53
+
54
+ - Python 3.10 – 3.13.
55
+ - The environment must have Jupyter kernel specs installed (for example the default `python3`).
56
+ - Dependencies (`jupyter_client`, `swarmauri_base`, `swarmauri_standard`, `pydantic`) install automatically.
57
+
58
+ ## Installation
59
+
60
+ Install via the packaging tool that matches your workflow. Each command fetches transitive dependencies.
61
+
62
+ **pip**
63
+
64
+ ```bash
65
+ pip install swarmauri_tool_jupyterstartkernel
66
+ ```
67
+
68
+ **Poetry**
69
+
70
+ ```bash
71
+ poetry add swarmauri_tool_jupyterstartkernel
72
+ ```
73
+
74
+ **uv**
75
+
76
+ ```bash
77
+ # Add to the current project and update uv.lock
78
+ uv add swarmauri_tool_jupyterstartkernel
79
+
80
+ # or install into the active environment without touching pyproject.toml
81
+ uv pip install swarmauri_tool_jupyterstartkernel
82
+ ```
83
+
84
+ > Tip: When using uv inside this repository, run commands from the repository root so `uv` can resolve the shared `pyproject.toml`.
85
+
86
+ ## Quick Start
87
+
88
+ The tool behaves like a callable. Instantiate it and optionally pass a `kernel_name`, timeout, or kernel spec.
89
+
90
+ ```python
91
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
92
+
93
+ start_kernel = JupyterStartKernelTool()
94
+ result = start_kernel() # defaults to python3
95
+
96
+ print(result)
97
+ # {
98
+ # 'status': 'success',
99
+ # 'kernel_id': '03c7d8f9-ec4d-4a8a-8a90-cdb35ff9e6c9',
100
+ # 'kernel_name': 'python3',
101
+ # 'connection_file': '/Users/.../jupyter/runtime/kernel-03c7d8f9.json'
102
+ # }
103
+ ```
104
+
105
+ A non-success status signals the kernel failed to spawn (missing kernelspec, permission issue, etc.).
106
+
107
+ ## Usage Scenarios
108
+
109
+ ### Launch With Custom Specification
110
+
111
+ ```python
112
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
113
+
114
+ start_kernel = JupyterStartKernelTool()
115
+ config = {
116
+ "env": {"EXPERIMENT_FLAG": "1"},
117
+ "resource_limits": {"memory": "1G"}
118
+ }
119
+
120
+ custom = start_kernel(kernel_name="python3", kernel_spec=config, startup_timeout=20)
121
+
122
+ if custom["status"] == "success":
123
+ print(f"Kernel ready at {custom['connection_file']}")
124
+ else:
125
+ raise RuntimeError(custom["message"])
126
+ ```
127
+
128
+ Pass a `kernel_spec` dict to tweak environment variables or other launch parameters that the underlying `KernelManager` accepts.
129
+
130
+ ### Pair With the Shutdown Tool in an Automated Flow
131
+
132
+ ```python
133
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
134
+ from swarmauri_tool_jupytershutdownkernel import JupyterShutdownKernelTool
135
+
136
+ start_kernel = JupyterStartKernelTool()
137
+ shutdown_kernel = JupyterShutdownKernelTool()
138
+
139
+ launch = start_kernel(kernel_name="python3")
140
+ if launch["status"] != "success":
141
+ raise RuntimeError(launch["message"])
142
+
143
+ kernel_id = launch["kernel_id"]
144
+ print(f"Kernel started: {kernel_id}")
145
+
146
+ # ... run your notebook execution workflow ...
147
+
148
+ cleanup = shutdown_kernel(kernel_id=kernel_id, shutdown_timeout=10)
149
+ print(cleanup)
150
+ ```
151
+
152
+ Use this pairing in CI pipelines or agent flows that must guarantee kernels are torn down after execution.
153
+
154
+ ### Integrate Inside a Swarmauri Agent
155
+
156
+ ```python
157
+ from swarmauri_core.agent.Agent import Agent
158
+ from swarmauri_core.messages.HumanMessage import HumanMessage
159
+ from swarmauri_standard.tools.registry import ToolRegistry
160
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
161
+
162
+ registry = ToolRegistry()
163
+ registry.register(JupyterStartKernelTool())
164
+
165
+ agent = Agent(tool_registry=registry)
166
+ message = HumanMessage(content="start a python3 kernel for my notebook batch job")
167
+ response = agent.run(message)
168
+ print(response)
169
+ ```
170
+
171
+ The agent resolves the registered tool, starts a kernel, and returns the connection metadata to the conversation context.
172
+
173
+ ## Troubleshooting
174
+
175
+ - **`No such kernel`** – The requested `kernel_name` is not installed. Check `jupyter kernelspec list`.
176
+ - **`Kernel start timeout exceeded`** – Increase `startup_timeout` for slow environments or pre-warm interpreters.
177
+ - **Permission errors** – Ensure the process can create files inside Jupyter's runtime directory (usually `~/.local/share/jupyter/runtime`).
178
+
179
+ ## License
180
+
181
+ `swarmauri_tool_jupyterstartkernel` is released under the Apache 2.0 License. See `LICENSE` for details.
182
+
@@ -0,0 +1,155 @@
1
+ ![Swarmauri Logo](https://github.com/swarmauri/swarmauri-sdk/blob/3d4d1cfa949399d7019ae9d8f296afba773dfb7f/assets/swarmauri.brand.theme.svg)
2
+
3
+ <p align="center">
4
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
5
+ <img src="https://img.shields.io/pypi/dm/swarmauri_tool_jupyterstartkernel" alt="PyPI - Downloads"/></a>
6
+ <a href="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_jupyterstartkernel/">
7
+ <img alt="Hits" src="https://hits.sh/github.com/swarmauri/swarmauri-sdk/tree/master/pkgs/community/swarmauri_tool_jupyterstartkernel.svg"/></a>
8
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
9
+ <img src="https://img.shields.io/pypi/pyversions/swarmauri_tool_jupyterstartkernel" alt="PyPI - Python Version"/></a>
10
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
11
+ <img src="https://img.shields.io/pypi/l/swarmauri_tool_jupyterstartkernel" alt="PyPI - License"/></a>
12
+ <a href="https://pypi.org/project/swarmauri_tool_jupyterstartkernel/">
13
+ <img src="https://img.shields.io/pypi/v/swarmauri_tool_jupyterstartkernel?label=swarmauri_tool_jupyterstartkernel&color=green" alt="PyPI - swarmauri_tool_jupyterstartkernel"/></a>
14
+ </p>
15
+
16
+ ---
17
+
18
+ # Swarmauri Tool · Jupyter Start Kernel
19
+
20
+ A Swarmauri orchestration tool that spins up Jupyter kernels on demand using `jupyter_client`. The helper wraps connection-file management, kernel specification, and timeout handling so automation pipelines, notebook CI, or Swarmauri agents can acquire fresh kernels with one function call.
21
+
22
+ - Launches kernels with configurable names and kernel-spec overrides.
23
+ - Surfaces ready-to-use connection metadata for downstream orchestration.
24
+ - Keeps a reference to the underlying `KernelManager` so you can interact with the kernel lifecycle after launch.
25
+
26
+ ## Requirements
27
+
28
+ - Python 3.10 – 3.13.
29
+ - The environment must have Jupyter kernel specs installed (for example the default `python3`).
30
+ - Dependencies (`jupyter_client`, `swarmauri_base`, `swarmauri_standard`, `pydantic`) install automatically.
31
+
32
+ ## Installation
33
+
34
+ Install via the packaging tool that matches your workflow. Each command fetches transitive dependencies.
35
+
36
+ **pip**
37
+
38
+ ```bash
39
+ pip install swarmauri_tool_jupyterstartkernel
40
+ ```
41
+
42
+ **Poetry**
43
+
44
+ ```bash
45
+ poetry add swarmauri_tool_jupyterstartkernel
46
+ ```
47
+
48
+ **uv**
49
+
50
+ ```bash
51
+ # Add to the current project and update uv.lock
52
+ uv add swarmauri_tool_jupyterstartkernel
53
+
54
+ # or install into the active environment without touching pyproject.toml
55
+ uv pip install swarmauri_tool_jupyterstartkernel
56
+ ```
57
+
58
+ > Tip: When using uv inside this repository, run commands from the repository root so `uv` can resolve the shared `pyproject.toml`.
59
+
60
+ ## Quick Start
61
+
62
+ The tool behaves like a callable. Instantiate it and optionally pass a `kernel_name`, timeout, or kernel spec.
63
+
64
+ ```python
65
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
66
+
67
+ start_kernel = JupyterStartKernelTool()
68
+ result = start_kernel() # defaults to python3
69
+
70
+ print(result)
71
+ # {
72
+ # 'status': 'success',
73
+ # 'kernel_id': '03c7d8f9-ec4d-4a8a-8a90-cdb35ff9e6c9',
74
+ # 'kernel_name': 'python3',
75
+ # 'connection_file': '/Users/.../jupyter/runtime/kernel-03c7d8f9.json'
76
+ # }
77
+ ```
78
+
79
+ A non-success status signals the kernel failed to spawn (missing kernelspec, permission issue, etc.).
80
+
81
+ ## Usage Scenarios
82
+
83
+ ### Launch With Custom Specification
84
+
85
+ ```python
86
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
87
+
88
+ start_kernel = JupyterStartKernelTool()
89
+ config = {
90
+ "env": {"EXPERIMENT_FLAG": "1"},
91
+ "resource_limits": {"memory": "1G"}
92
+ }
93
+
94
+ custom = start_kernel(kernel_name="python3", kernel_spec=config, startup_timeout=20)
95
+
96
+ if custom["status"] == "success":
97
+ print(f"Kernel ready at {custom['connection_file']}")
98
+ else:
99
+ raise RuntimeError(custom["message"])
100
+ ```
101
+
102
+ Pass a `kernel_spec` dict to tweak environment variables or other launch parameters that the underlying `KernelManager` accepts.
103
+
104
+ ### Pair With the Shutdown Tool in an Automated Flow
105
+
106
+ ```python
107
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
108
+ from swarmauri_tool_jupytershutdownkernel import JupyterShutdownKernelTool
109
+
110
+ start_kernel = JupyterStartKernelTool()
111
+ shutdown_kernel = JupyterShutdownKernelTool()
112
+
113
+ launch = start_kernel(kernel_name="python3")
114
+ if launch["status"] != "success":
115
+ raise RuntimeError(launch["message"])
116
+
117
+ kernel_id = launch["kernel_id"]
118
+ print(f"Kernel started: {kernel_id}")
119
+
120
+ # ... run your notebook execution workflow ...
121
+
122
+ cleanup = shutdown_kernel(kernel_id=kernel_id, shutdown_timeout=10)
123
+ print(cleanup)
124
+ ```
125
+
126
+ Use this pairing in CI pipelines or agent flows that must guarantee kernels are torn down after execution.
127
+
128
+ ### Integrate Inside a Swarmauri Agent
129
+
130
+ ```python
131
+ from swarmauri_core.agent.Agent import Agent
132
+ from swarmauri_core.messages.HumanMessage import HumanMessage
133
+ from swarmauri_standard.tools.registry import ToolRegistry
134
+ from swarmauri_tool_jupyterstartkernel import JupyterStartKernelTool
135
+
136
+ registry = ToolRegistry()
137
+ registry.register(JupyterStartKernelTool())
138
+
139
+ agent = Agent(tool_registry=registry)
140
+ message = HumanMessage(content="start a python3 kernel for my notebook batch job")
141
+ response = agent.run(message)
142
+ print(response)
143
+ ```
144
+
145
+ The agent resolves the registered tool, starts a kernel, and returns the connection metadata to the conversation context.
146
+
147
+ ## Troubleshooting
148
+
149
+ - **`No such kernel`** – The requested `kernel_name` is not installed. Check `jupyter kernelspec list`.
150
+ - **`Kernel start timeout exceeded`** – Increase `startup_timeout` for slow environments or pre-warm interpreters.
151
+ - **Permission errors** – Ensure the process can create files inside Jupyter's runtime directory (usually `~/.local/share/jupyter/runtime`).
152
+
153
+ ## License
154
+
155
+ `swarmauri_tool_jupyterstartkernel` is released under the Apache 2.0 License. See `LICENSE` for details.
@@ -0,0 +1,89 @@
1
+ [project]
2
+ name = "swarmauri_tool_jupyterstartkernel"
3
+ version = "0.9.0"
4
+ description = "A tool designed to start a new Jupyter kernel programmatically using jupyter_client, enabling execution of notebook cells."
5
+ license = "Apache-2.0"
6
+ readme = "README.md"
7
+ repository = "http://github.com/swarmauri/swarmauri-sdk/pkgs/community/swarmauri_tool_jupyterstartkernel/"
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
+ "Natural Language :: English",
16
+ "Development Status :: 3 - Alpha",
17
+ "Intended Audience :: Developers",
18
+ "Topic :: Software Development :: Libraries :: Application Frameworks",
19
+ ]
20
+ authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
21
+ dependencies = [
22
+ "jupyter_client>=8.6.3",
23
+ "ipykernel>=6.29.5",
24
+ "swarmauri_core",
25
+ "swarmauri_base",
26
+ "swarmauri_standard",
27
+ ]
28
+ keywords = [
29
+ "swarmauri",
30
+ "tool",
31
+ "jupyterstartkernel",
32
+ "designed",
33
+ "start",
34
+ "new",
35
+ "jupyter",
36
+ "kernel",
37
+ "programmatically",
38
+ "client",
39
+ "enabling",
40
+ "execution",
41
+ "notebook",
42
+ "cells",
43
+ ]
44
+
45
+ [tool.uv.sources]
46
+ swarmauri_core = { workspace = true }
47
+ swarmauri_base = { workspace = true }
48
+ swarmauri_standard = { workspace = true }
49
+
50
+ [tool.pytest.ini_options]
51
+ norecursedirs = ["combined", "scripts"]
52
+ markers = [
53
+ "test: standard test",
54
+ "unit: Unit tests",
55
+ "i9n: Integration tests",
56
+ "r8n: Regression tests",
57
+ "timeout: mark test to timeout after X seconds",
58
+ "xpass: Expected passes",
59
+ "xfail: Expected failures",
60
+ "acceptance: Acceptance tests",
61
+ "perf: Performance tests that measure execution time and resource usage",
62
+ ]
63
+ timeout = 300
64
+ log_cli = true
65
+ log_cli_level = "INFO"
66
+ log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
67
+ log_cli_date_format = "%Y-%m-%d %H:%M:%S"
68
+ asyncio_default_fixture_loop_scope = "function"
69
+
70
+ [project.entry-points.'swarmauri.tools']
71
+ JupyterStartKernelTool = "swarmauri_tool_jupyterstartkernel:JupyterStartKernelTool"
72
+
73
+ [build-system]
74
+ requires = ["poetry-core>=1.0.0"]
75
+ build-backend = "poetry.core.masonry.api"
76
+
77
+ [dependency-groups]
78
+ dev = [
79
+ "pytest>=8.0",
80
+ "pytest-asyncio>=0.24.0",
81
+ "pytest-xdist>=3.6.1",
82
+ "pytest-json-report>=1.5.0",
83
+ "python-dotenv",
84
+ "requests>=2.32.3",
85
+ "flake8>=7.0",
86
+ "pytest-timeout>=2.3.1",
87
+ "ruff>=0.9.9",
88
+ "pytest-benchmark>=4.0.0",
89
+ ]
@@ -0,0 +1,92 @@
1
+ """
2
+ JupyterStartKernelTool.py
3
+
4
+ This module defines the JupyterStartKernelTool, a component that starts a Jupyter kernel instance.
5
+ It leverages the ToolBase and ComponentBase classes from the swarmauri framework to integrate
6
+ seamlessly with the system's tool architecture.
7
+
8
+ The JupyterStartKernelTool supports initializing and configuring a new Jupyter kernel instance,
9
+ logging kernel start events, handling startup errors gracefully, and returning the kernel ID for
10
+ reference. It can also integrate with further tools that execute cells within the started kernel.
11
+ """
12
+
13
+ import logging
14
+ from typing import List, Literal, Dict, Optional, Any, ClassVar
15
+ from pydantic import Field
16
+ from jupyter_client import KernelManager
17
+
18
+ from swarmauri_standard.tools.Parameter import Parameter
19
+ from swarmauri_base.ComponentBase import ComponentBase
20
+ from swarmauri_base.tools.ToolBase import ToolBase
21
+
22
+ logger = logging.getLogger(__name__)
23
+
24
+
25
+ @ComponentBase.register_type(ToolBase, "JupyterStartKernelTool")
26
+ class JupyterStartKernelTool(ToolBase):
27
+ """
28
+ JupyterStartKernelTool is a tool that initializes and configures a Jupyter kernel instance.
29
+ """
30
+
31
+ version: str = "1.0.0"
32
+ parameters: List[Parameter] = Field(
33
+ default_factory=lambda: [
34
+ Parameter(
35
+ name="kernel_name",
36
+ input_type="string",
37
+ description="The name of the Jupyter kernel to start (e.g., 'python3').",
38
+ required=False,
39
+ default="python3",
40
+ ),
41
+ Parameter(
42
+ name="kernel_spec",
43
+ input_type="object",
44
+ description="Optional dictionary to configure kernel specifications (if supported).",
45
+ required=False,
46
+ default=None,
47
+ ),
48
+ ]
49
+ )
50
+ name: str = "JupyterStartKernelTool"
51
+ description: str = "Initializes and configures a Jupyter kernel instance."
52
+ type: Literal["JupyterStartKernelTool"] = "JupyterStartKernelTool"
53
+
54
+ # Expose KernelManager for patching in tests
55
+ KernelManager: ClassVar = KernelManager
56
+
57
+ def __call__(
58
+ self, kernel_name: str = "python3", kernel_spec: Optional[Dict[str, Any]] = None
59
+ ) -> Dict[str, str]:
60
+ """
61
+ Starts a new Jupyter kernel instance with the provided kernel name and optional specifications.
62
+ """
63
+ try:
64
+ # Initialize the kernel manager using the class attribute
65
+ km = KernelManager(kernel_name=kernel_name)
66
+
67
+ if kernel_spec:
68
+ logger.debug(f"Applying kernel specification: {kernel_spec}")
69
+
70
+ km.start_kernel()
71
+ kernel_id = km.kernel_id
72
+
73
+ # Store the KernelManager for further interactions
74
+ self._kernel_manager = km
75
+
76
+ # Log the successful start
77
+ logger.info(
78
+ f"Started Jupyter kernel '{kernel_name}' with ID '{kernel_id}'."
79
+ )
80
+ return {"kernel_name": kernel_name, "kernel_id": kernel_id}
81
+
82
+ except Exception as ex:
83
+ logger.error(f"Failed to start Jupyter kernel '{kernel_name}': {ex}")
84
+ # Ensure that we don't store an invalid manager
85
+ self._kernel_manager = None
86
+ return {"error": str(ex)}
87
+
88
+ def get_kernel_manager(self) -> Optional[KernelManager]:
89
+ """
90
+ Retrieves the KernelManager instance for the active Jupyter kernel.
91
+ """
92
+ return getattr(self, "_kernel_manager", None)
@@ -0,0 +1,19 @@
1
+ from swarmauri_tool_jupyterstartkernel.JupyterStartKernelTool import (
2
+ JupyterStartKernelTool,
3
+ )
4
+
5
+
6
+ __all__ = ["JupyterStartKernelTool"]
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_jupyterstartkernel")
17
+ except PackageNotFoundError:
18
+ # If the package is not installed (for example, during development)
19
+ __version__ = "0.0.0"