silik-kernel 1.1__tar.gz

silik_kernel-1.1/.gitignore

@@ -0,0 +1,11 @@
+.venv
+brouillon.py
+config.yaml
+config_.yaml
+example_messages.json
+kernel-*
+**/dist
+**/**.egg-info
+**/build
+**/data_kernelspec
+octave-workspace

silik_kernel-1.1/LICENSE-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

silik_kernel-1.1/PKG-INFO

@@ -0,0 +1,284 @@
+Metadata-Version: 2.4
+Name: silik-kernel
+Version: 1.1
+Summary: Multi-kernel Manager
+Author-email: Marius Garénaux-Gruau  <marius.garenaux-gruau@irisa.fr>
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE-2.0.txt
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.12
+Requires-Dist: ipykernel>=7.1.0
+Requires-Dist: jupyter-client>=8.6.3
+Description-Content-Type: text/markdown
+
+# Silik Kernel
+
+This is a jupyter kernel that allows to interface with multiple kernels, you can:
+
+- start, stop and restart kernels,
+
+- switch between kernels,
+
+- list available kernels.
+
+As a jupyter kernel, it takes text as input, transfer it to appropriate sub-kernel; and returns the result in a cell output. It gives a **single context** that is shared between kernels. The cell history is shared with sub-kernels within the 'metadata' attribute of execution messages.
+
+> **Any kernel can be plugged to silik**
+
+![](silik_console.png)
+
+## Getting started
+
+```bash
+pip install silik-kernel
+```
+
+The kernel is then installed on the current python venv.
+
+Any jupyter frontend should be able to access the kernel, for example :
+
+• **Notebook** (you might need to restart the IDE) : select 'silik' on top right of the notebook
+
+• **CLI** : Install jupyter-console (`pip install jupyter-console`); and run `jupyter console --kernel silik`
+
+• **Silik Signal Messaging** : Access the kernel through Signal Message Application.
+
+To use diverse kernels through silik, you can install some example kernels (on the same python venv): [chatbot](./chatbot_kernel/), [rudi](./rudi_kernel/). You can also create new agent-based kernel by subclassing [pydantic-ai base kernel](./pydantic_ai_base_kernel/).
+
+> You can list the available kernels by running `jupyter kernelspec list` in a terminal.
+
+## Usage
+
+Once the kernel is started, you can :
+
+- send commands :
+  - `!start <kernel_type>` : starts a kernel; it will be assigned a label. Per example, `!start python3` starts and connect to a python3 kernel.
+  - `!restart <kernel_label>` : restart a kernel with its label.
+  - `!ls` : list started kernels.
+  - `!select <kernel_label>`: switch a started kernel with its label
+
+- run code :
+  - if you run `!ls`, you'll see which kernel you are on.
+  - all cells you send will be executed in this kernel, and the result will be given in the cell output. Silik kernel acts as a gateway for the sub-kernels.
+
+## Retrieving cells history with a custom kernel
+
+If you want to retrieve the history of the silik kernel within your custom kernel, you just have to access the 'metadata' attribute of the current message. For example (assuming you use subclass the ipykernel, and self is your kernel instance) :
+
+```python
+parent = self.get_parent()
+metadata = parent.get("metadata", {})
+if isinstance(metadata, dict) and "message_history" in metadata:
+    print(metadata["message_history"])
+```
+
+The attribute 'message_history' of the metadata is a list of dict, each with :
+
+```python
+{
+  "role": "user or assistant; user for cell input, assistant for cell output",
+  "content": "Input Code if user, output if assistant",
+  "uid": "uuidv4"
+}
+```

silik_kernel-1.1/README.md

@@ -0,0 +1,70 @@
+# Silik Kernel
+
+This is a jupyter kernel that allows to interface with multiple kernels, you can:
+
+- start, stop and restart kernels,
+
+- switch between kernels,
+
+- list available kernels.
+
+As a jupyter kernel, it takes text as input, transfer it to appropriate sub-kernel; and returns the result in a cell output. It gives a **single context** that is shared between kernels. The cell history is shared with sub-kernels within the 'metadata' attribute of execution messages.
+
+> **Any kernel can be plugged to silik**
+
+![](silik_console.png)
+
+## Getting started
+
+```bash
+pip install silik-kernel
+```
+
+The kernel is then installed on the current python venv.
+
+Any jupyter frontend should be able to access the kernel, for example :
+
+• **Notebook** (you might need to restart the IDE) : select 'silik' on top right of the notebook
+
+• **CLI** : Install jupyter-console (`pip install jupyter-console`); and run `jupyter console --kernel silik`
+
+• **Silik Signal Messaging** : Access the kernel through Signal Message Application.
+
+To use diverse kernels through silik, you can install some example kernels (on the same python venv): [chatbot](./chatbot_kernel/), [rudi](./rudi_kernel/). You can also create new agent-based kernel by subclassing [pydantic-ai base kernel](./pydantic_ai_base_kernel/).
+
+> You can list the available kernels by running `jupyter kernelspec list` in a terminal.
+
+## Usage
+
+Once the kernel is started, you can :
+
+- send commands :
+  - `!start <kernel_type>` : starts a kernel; it will be assigned a label. Per example, `!start python3` starts and connect to a python3 kernel.
+  - `!restart <kernel_label>` : restart a kernel with its label.
+  - `!ls` : list started kernels.
+  - `!select <kernel_label>`: switch a started kernel with its label
+
+- run code :
+  - if you run `!ls`, you'll see which kernel you are on.
+  - all cells you send will be executed in this kernel, and the result will be given in the cell output. Silik kernel acts as a gateway for the sub-kernels.
+
+## Retrieving cells history with a custom kernel
+
+If you want to retrieve the history of the silik kernel within your custom kernel, you just have to access the 'metadata' attribute of the current message. For example (assuming you use subclass the ipykernel, and self is your kernel instance) :
+
+```python
+parent = self.get_parent()
+metadata = parent.get("metadata", {})
+if isinstance(metadata, dict) and "message_history" in metadata:
+    print(metadata["message_history"])
+```
+
+The attribute 'message_history' of the metadata is a list of dict, each with :
+
+```python
+{
+  "role": "user or assistant; user for cell input, assistant for cell output",
+  "content": "Input Code if user, output if assistant",
+  "uid": "uuidv4"
+}
+```

silik_kernel-1.1/hatch_build.py

@@ -0,0 +1,43 @@
+import os
+import sys
+from hatchling.builders.hooks.plugin.interface import BuildHookInterface
+
+
+import json
+import shutil
+
+from jupyter_client.kernelspec import KernelSpecManager
+from tempfile import TemporaryDirectory
+
+# use 'python' executable for portable wheels
+#
+kernel_json = {
+    "argv": ["python", "-m", "silik", "-f", "{connection_file}"],
+    "display_name": "Silik Base Kernel",
+    "language": "text",
+}
+
+
+class CustomHook(BuildHookInterface):
+    def initialize(self, version, build_data):
+        here = os.path.abspath(os.path.dirname(__file__))
+        sys.path.insert(0, here)
+        prefix = os.path.join(here, "data_kernelspec")
+
+        with TemporaryDirectory() as td:
+            os.chmod(td, 0o755)  # Starts off as 700, not user readable
+            with open(os.path.join(td, "kernel.json"), "w") as f:
+                json.dump(kernel_json, f, sort_keys=True)
+            print("Installing Jupyter kernel spec")
+
+            # Requires logo files in kernel root directory
+            cur_path = os.path.dirname(os.path.realpath(__file__))
+            for logo in ["logo-32x32.png", "logo-64x64.png"]:
+                try:
+                    shutil.copy(os.path.join(cur_path, logo), td)
+                except FileNotFoundError:
+                    print("Custom logo files not found. Default logos will be used.")
+
+            KernelSpecManager().install_kernel_spec(
+                td, "silik", user=False, prefix=prefix
+            )

silik_kernel-1.1/pyproject.toml

@@ -0,0 +1,32 @@
+[build-system]
+requires = ["hatchling>=1.10.0", "ipykernel"]
+build-backend = "hatchling.build"
+
+[project]
+name = "silik-kernel"
+dynamic = ["version"]
+description = "Multi-kernel Manager"
+readme = "README.md"
+license = { file = "LICENSE-2.0.txt" }
+authors = [
+    { name = "Marius Garénaux-Gruau ", email = "marius.garenaux-gruau@irisa.fr" },
+]
+classifiers = ["Programming Language :: Python :: 3"]
+requires-python = ">=3.12"
+dependencies = ["ipykernel>=7.1.0", "jupyter-client>=8.6.3"]
+
+
+# [project.urls]
+# Homepage = "https://github.com/jupyter/echo_kernel"
+
+[tool.hatch.version]
+path = "silik_kernel/__init__.py"
+
+# Used to call hatch_build.py
+[tool.hatch.build.hooks.custom]
+
+[tool.hatch.build.targets.sdist]
+include = ["/silik_kernel"]
+
+[tool.hatch.build.targets.wheel.shared-data]
+"data_kernelspec/share" = "share"

silik_kernel-1.1/silik_kernel/__init__.py

@@ -0,0 +1,5 @@
+"""Silik Base Kernel : Multi Kernel Interaction"""
+
+__version__ = "1.1"
+
+from .kernel import SilikBaseKernel  # noqa: F401

silik_kernel-1.1/silik_kernel/__main__.py

@@ -0,0 +1,4 @@
+from ipykernel.kernelapp import IPKernelApp
+from . import SilikBaseKernel
+
+IPKernelApp.launch_instance(kernel_class=SilikBaseKernel)

silik_kernel-1.1/silik_kernel/kernel.py

@@ -0,0 +1,539 @@
+# Base python dependencies
+import re
+import os
+from dataclasses import dataclass, asdict
+from uuid import uuid4
+import random
+from pathlib import Path
+import logging
+
+# External dependencies
+from ipykernel.kernelbase import Kernel
+from jupyter_client.multikernelmanager import AsyncMultiKernelManager
+
+
+ALL_KERNELS_LABELS = [
+    "lion",
+    "tiger",
+    "bear",
+    "wolf",
+    "deer",
+    "fox",
+    "cat",
+    "dog",
+    "bird",
+    "fish",
+    "horse",
+    "cow",
+    "pig",
+    "sheep",
+    "goat",
+    "duck",
+    "chicken",
+    "turkey",
+    "frog",
+    "toad",
+    "snake",
+    "lizard",
+    "turtle",
+    "rabbit",
+    "mouse",
+    "rat",
+    "bat",
+    "frog",
+    "fern",
+    "ivy",
+    "lily",
+    "rose",
+    "sage",
+    "thyme",
+    "mint",
+    "basil",
+    "parsley",
+    "daisy",
+    "sunflower",
+    "violet",
+    "poppy",
+    "orchid",
+    "jasmine",
+    "heather",
+    "lavender",
+    "geranium",
+    "begonia",
+    "camellia",
+    "azalea",
+    "gardenia",
+    "hibiscus",
+    "magnolia",
+    "petunia",
+    "primrose",
+    "snapdragon",
+    "sweetpea",
+    "tulip",
+    "veronica",
+    "oak",
+    "pine",
+    "maple",
+    "elm",
+    "ash",
+    "beech",
+    "birch",
+    "cherry",
+    "cypress",
+    "ebony",
+    "fir",
+    "hazel",
+    "juniper",
+    "larch",
+    "mahogany",
+    "mulberry",
+    "olive",
+    "palm",
+    "pecan",
+    "poplar",
+    "quaking",
+    "redwood",
+    "spruce",
+    "sycamore",
+    "teak",
+    "walnut",
+    "willow",
+    "yew",
+    "bee",
+    "ant",
+    "fly",
+    "moth",
+    "wasp",
+    "bug",
+    "flea",
+    "tick",
+    "mite",
+    "louse",
+    "roach",
+    "cricket",
+    "grasshopper",
+    "cicada",
+    "katydid",
+    "earwig",
+    "silverfish",
+    "spider",
+    "scorpion",
+    "centipede",
+    "millipede",
+    "dragonfly",
+    "damselfly",
+    "butterfly",
+    "ladybug",
+    "firefly",
+    "stick",
+    "aphid",
+    "termite",
+    "beet",
+    "carrot",
+    "potato",
+    "onion",
+    "garlic",
+    "leek",
+    "radish",
+    "turnip",
+    "parsnip",
+    "celery",
+    "kale",
+    "spinach",
+    "peas",
+    "cucumber",
+    "eggplant",
+    "okra",
+    "squash",
+    "pumpkin",
+    "corn",
+    "broccoli",
+    "cauliflower",
+    "mushroom",
+    "asparagus",
+    "fennel",
+    "rhubarb",
+    "zucchini",
+    "yam",
+    "ginger",
+    "horseradish",
+    "apple",
+    "banana",
+    "cherry",
+    "date",
+    "elderberry",
+    "fig",
+    "grape",
+    "guava",
+    "jackfruit",
+    "kiwi",
+    "lemon",
+    "mango",
+    "melon",
+    "nectarine",
+    "orange",
+    "papaya",
+    "pear",
+    "pineapple",
+    "pomegranate",
+    "quince",
+    "raspberry",
+    "strawberry",
+    "tangerine",
+    "ugli",
+    "victoria",
+    "watermelon",
+    "xigua",
+    "yuzu",
+    "ziziphus",
+]
+
+
+def setup_kernel_logger(name, log_dir="~/.silik_logs"):
+    """
+    Creates a logger for the kernel. Set up SILIK_KERNEL_LOG environment
+    variable to True before running the kernel, and create the following
+    dir : ~/.silik_logs
+    """
+    log_dir = Path(log_dir).expanduser()
+    if not os.path.isdir(log_dir):
+        raise Exception(f"Please create a dir for kernel logs at {log_dir}")
+
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+    logger.propagate = False
+
+    if not logger.handlers:
+        fh = logging.FileHandler(log_dir / f"{name}.log", encoding="utf-8")
+        fmt = logging.Formatter("%(asctime)s | %(levelname)s | %(name)s | %(message)s")
+        fh.setFormatter(fmt)
+        logger.addHandler(fh)
+
+    return logger
+
+
+@dataclass
+class KernelMetadata:
+    """
+    Custom dataclass used to describe kernels
+    """
+
+    label: str
+    type: str
+    id: str
+
+
+class SilikBaseKernel(Kernel):
+    """
+    Base Kernel for Silik, is used as a gateway to distribute
+    code cells towards different kernels, e.g. :
+
+    - octave
+    - pydantic ai agent based kernel
+    - python
+    - ...
+
+    See https://github.com/Tariqve/jupyter-kernels for available
+    kernels.
+    """
+
+    implementation = "Silik"
+    implementation_version = "1.0"
+    language = "no-op"
+    language_version = "0.1"
+    language_info = {
+        "name": "silik",
+        "mimetype": "text/plain",
+        "file_extension": ".txt",
+    }
+    banner = "Silik Kernel - Multikernel Manager - Send !help for commands"
+    active_kernel: KernelMetadata | None = None
+    all_kernels: list[KernelMetadata] = []
+    all_kernels_labels: list[str] = ALL_KERNELS_LABELS
+    mkm: AsyncMultiKernelManager = AsyncMultiKernelManager()
+    message_history: list[dict] = []
+
+    def __init__(self, **kwargs):
+        super().__init__(**kwargs)
+
+        should_custom_log = os.environ.get("SILIK_KERNEL_LOG", "False")
+        should_custom_log = (
+            True if should_custom_log in ["True", "true", "1"] else False
+        )
+
+        if should_custom_log:
+            logger = setup_kernel_logger(__name__)
+            logger.debug("Started kernel and initalized logger")
+            self.logger = logger
+        else:
+            self.logger = self.log
+
+    def get_kernel_with_id(self, kernel_id: str) -> KernelMetadata | None:
+        """
+        Returns a kernel metadata from its id.
+
+        Parameters :
+        ---
+            - kernel_id : the uuidv4 (str) of the wanted kernel
+
+        Returns :
+        ---
+        The matching kernel metadata if found, else None.
+        """
+        for each_kernel in self.all_kernels:
+            if each_kernel.id == kernel_id:
+                return each_kernel
+
+    def get_kernel_with_label(self, kernel_label: str) -> KernelMetadata | None:
+        """
+        Returns a kernel metadata from its label.
+
+        Parameters :
+        ---
+            - kernel_label : the label (str) of the wanted kernel
+
+        Returns :
+        ---
+        The matching kernel metadata if found, else None.
+        """
+        for each_kernel in self.all_kernels:
+            if each_kernel.label == kernel_label:
+                return each_kernel
+
+    async def _do_execute(
+        self, code, silent, store_history, user_expressions, allow_stdin
+    ):
+        """
+        Custom do_execute function that :
+
+            - retrieve the uuid of the living kernel
+            - pass the code to it, and displays its result
+        """
+        self.logger.debug(f"Active kernel : {self.active_kernel}")
+        if self.active_kernel is None:
+            self.send_response(
+                self.iopub_socket,
+                "display_data",
+                {
+                    "data": {
+                        "text/plain": "Please start a kernel. Run '!start <kernel_type>'"
+                    },
+                    "metadata": {},
+                },
+            )
+            return {
+                "status": "ok",
+                "execution_count": self.execution_count,
+                "payload": [],
+                "user_expressions": {},
+            }
+
+        km = self.mkm.get_kernel(self.active_kernel.id)
+        kc = km.client()
+
+        # synchronous call
+        kc.start_channels()
+
+        # msg_id = kc.execute(code)
+        content = {
+            "code": code,
+            "silent": silent,
+            "store_history": store_history,
+            "user_expressions": user_expressions,
+            "allow_stdin": allow_stdin,
+            "stop_on_error": True,
+        }
+        msg = kc.session.msg(
+            "execute_request",
+            content,
+            metadata={"message_history": self.message_history},
+        )
+        kc.shell_channel.send(msg)
+        msg_id = msg["header"]["msg_id"]
+        output = []
+
+        while True:
+            msg = await kc._async_get_iopub_msg()
+            if msg["parent_header"].get("msg_id") != msg_id:
+                continue
+
+            msg_type = msg["msg_type"]
+
+            if msg_type == "stream":
+                output.append(msg["content"]["text"])
+
+            elif msg_type == "execute_result":
+                output.append(msg["content"]["data"]["text/plain"])
+
+            elif msg_type == "error":
+                output.append("\n".join(msg["content"]["traceback"]))
+                self.logger.debug(f"Error : {msg}")
+                return {
+                    "status": "error",
+                    "ename": msg["content"]["ename"],
+                    "evalue": msg["content"]["evalue"],
+                    "traceback": msg["content"]["traceback"],
+                }
+            elif msg_type == "status" and msg["content"]["execution_state"] == "idle":
+                break
+
+        # synchronous call
+        kc.stop_channels()
+
+        if not silent and output:
+            self.send_response(
+                self.iopub_socket,
+                "display_data",
+                {
+                    "data": {"text/plain": output[0]},
+                    "metadata": {},
+                },
+            )
+
+            self.message_history.append(
+                {"role": "user", "content": code, "uid": str(uuid4())}
+            )
+            self.message_history.append(
+                {"role": "assistant", "content": output[0], "uid": str(uuid4())}
+            )
+
+        return {
+            "status": "ok",
+            "execution_count": self.execution_count,
+            "payload": [],
+            "user_expressions": {},
+        }
+
+    def select_kernel(self, kernel_label: str) -> KernelMetadata | None:
+        """
+        Moves the selected kernel to kernel_label.
+        """
+        found_kernel = self.get_kernel_with_label(kernel_label)
+        if found_kernel is not None:
+            self.active_kernel = found_kernel
+            return found_kernel
+
+    async def start_kernel(self, kernel_name: str) -> KernelMetadata | None:
+        """
+        Finds a living kernel and returns its ID. If it does not exists,
+        starts it.
+
+        Returns :
+        ---
+            KernelMetadata or None
+        """
+        self.logger.debug(f"Starting new kernel of type : {kernel_name}")
+        kernel_id = await self.mkm.start_kernel(kernel_name=kernel_name)
+        kernel_label = random.choice(self.all_kernels_labels)
+        new_kernel = KernelMetadata(label=kernel_label, type=kernel_name, id=kernel_id)
+        self.active_kernel = new_kernel
+        self.logger.debug(f"Successfully started kernel {new_kernel}")
+        self.all_kernels.append(new_kernel)
+        self.logger.debug(f"No kernel with label {kernel_name} is available.")
+        return new_kernel
+
+    async def do_execute(  # pyright: ignore
+        self,
+        code: str,
+        silent,
+        store_history=True,
+        user_expressions=None,
+        allow_stdin=False,
+    ):
+        try:
+            if not silent:
+                out = self.parse_command(code)
+                self.logger.debug(f"Parsed {out} from {code}")
+                if out is None:
+                    result = await self._do_execute(
+                        code, silent, store_history, user_expressions, allow_stdin
+                    )
+                    return result
+                cmd, arg = out
+                match cmd:
+                    case "start":
+                        found_kernel = await self.start_kernel(arg)
+                        if found_kernel is None:
+                            content = f"Could not create kernel with name {arg}"
+                        else:
+                            content = f"Connected to kernel {found_kernel}. Now, cells are executed on this kernel."
+                    case "select":
+                        found_kernel = self.select_kernel(arg)
+                        if found_kernel is None:
+                            content = f"Could not find kernel with name {arg}"
+                        else:
+                            content = f"Connected to kernel {found_kernel}. Now, cells are executed on this kernel."
+                    case "restart":
+                        found_kernel = self.get_kernel_with_label(arg)
+                        if found_kernel is None:
+                            content = f"Could not find kernel with label {arg}"
+                        else:
+                            await self.mkm.restart_kernel(found_kernel.id)
+                            content = f"Restarted kernel {found_kernel}"
+                    case "ls":
+                        content = "silik\n"
+                        for k in range(len(self.all_kernels)):
+                            knl = self.all_kernels[k]
+                            label = (
+                                f">> {knl.label} <<"
+                                if knl == self.active_kernel
+                                else knl.label
+                            )
+                            dec = "╰──  " if k == len(self.all_kernels) - 1 else "├──  "
+                            content += f"{dec}{label} [{knl.type}]\n"
+                    case "pwd":
+                        if self.active_kernel is None:
+                            content = "No kernel is running. Start one with `!start <kernel_name>`."
+                        else:
+                            content = asdict(self.active_kernel)
+                    case "help":
+                        content = "• !ls : prints living kernels\n• !start <kernel_type> : starts a kernel\n• !restart <kernel_label> : restart a kernel with its label\n• !select <kernel_label> : moves the selected kernel to the one with this label - nexts cells will be executed on this kernel"
+                    case _:
+                        content = f"Unknown command {cmd}."
+
+                self.send_response(
+                    self.iopub_socket,
+                    "execute_result",
+                    {
+                        "execution_count": self.execution_count,
+                        "data": {"text/plain": content},
+                        "metadata": {},
+                    },
+                )
+        except Exception as e:
+            # TODO : send to error socket
+            content = str(e)
+            self.send_response(
+                self.iopub_socket,
+                "execute_result",
+                {
+                    "execution_count": self.execution_count,
+                    "data": {"text/plain": content},
+                    "metadata": {},
+                },
+            )
+
+        return {
+            "status": "ok",
+            "execution_count": self.execution_count,
+            "payload": [],
+            "user_expressions": {},
+        }
+
+    def parse_command(self, cell_input: str):
+        """
+        Parses the text to find a command. A command
+        must start with !.
+        """
+        matched = re.match(r"^!(\w+)(?: ([\w.]+))?$", cell_input)
+        try:
+            cmd_name = matched.group(1)  # Extract the command name # pyright: ignore
+            argument = matched.group(2)  # Extract the argument # pyright: ignore
+            return cmd_name, argument
+        except Exception as e:
+            self.logger.debug(f"Could not parse info on {cell_input}, because {e}")
+            return
+
+    def do_shutdown(self, restart):
+        self.mkm.shutdown_all()
+        return super().do_shutdown(restart)