uvk 0.0.1__tar.gz

uvk-0.0.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: uvk
+Version: 0.0.1
+Summary: Fully isolated IPython kernels based on uv
+Keywords: jupyter,kernel,ipython,ipykernel,uv
+Author: Benoit Hamelin
+Author-email: Benoit Hamelin <benoit.hamelin@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Operating System :: OS Independent
+Requires-Dist: ipykernel>=7.0.0
+Requires-Dist: jupyter-core>=5.9.1
+Requires-Dist: uv>=0.10.2
+Maintainer: Benoit Hamelin
+Maintainer-email: Benoit Hamelin <benoit.hamelin@gmail.com>
+Requires-Python: >=3.10
+Project-URL: Homepage, https://github.com/hamelin/uvk
+Description-Content-Type: text/markdown
+
+# uvk -- Fully isolated IPython kernels based on uv
+
+Proper documentation TBD... In the meantime:
+
+1. Install `uvk` in an environment from which you run Jupyter Lab / Notebook.
+1. Invoke `uvk` from this environment to install the UVK kernel attached to the Python executable of your environment.
+    - Distinct icon TBD
+1. Use kernel `UVK (Python 3.xx)` in your notebooks
+
+and 🎉 your Python kernel runs out of a temporary, isolated environment.
+Check it out by running a notebook with a code cell going
+
+```python
+import sys
+sys.prefix
+```
+
+and see how every time you restart the kernel, the prefix directory changes.
+
+Feature wishlist:
+
+- Python version validation against a constraint with a magic
+- Magic for adding dependencies on the fly
+- Magic for including [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#inline-script-metadata)
+- Integration with uv project workflows
+- Python version and executable management through duly-named alternate kernels

uvk-0.0.1/README.md

@@ -0,0 +1,26 @@
+# uvk -- Fully isolated IPython kernels based on uv
+
+Proper documentation TBD... In the meantime:
+
+1. Install `uvk` in an environment from which you run Jupyter Lab / Notebook.
+1. Invoke `uvk` from this environment to install the UVK kernel attached to the Python executable of your environment.
+    - Distinct icon TBD
+1. Use kernel `UVK (Python 3.xx)` in your notebooks
+
+and 🎉 your Python kernel runs out of a temporary, isolated environment.
+Check it out by running a notebook with a code cell going
+
+```python
+import sys
+sys.prefix
+```
+
+and see how every time you restart the kernel, the prefix directory changes.
+
+Feature wishlist:
+
+- Python version validation against a constraint with a magic
+- Magic for adding dependencies on the fly
+- Magic for including [inline script metadata](https://packaging.python.org/en/latest/specifications/inline-script-metadata/#inline-script-metadata)
+- Integration with uv project workflows
+- Python version and executable management through duly-named alternate kernels

uvk-0.0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[build-system]
+requires = ["uv_build>=0.10.2"]
+build-backend = "uv_build"
+
+[project]
+name = "uvk"
+version = "0.0.1"
+authors = [{name = "Benoit Hamelin", email = "benoit.hamelin@gmail.com"}]
+maintainers = [{name = "Benoit Hamelin", email = "benoit.hamelin@gmail.com"}]
+description = "Fully isolated IPython kernels based on uv"
+readme = "README.md"
+keywords = ["jupyter", "kernel", "ipython", "ipykernel", "uv"]
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Development Status :: 2 - Pre-Alpha",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.10"
+dependencies = [
+    "ipykernel>=7.0.0",
+    "jupyter-core>=5.9.1",
+    "uv>=0.10.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/hamelin/uvk"
+
+[project.scripts]
+uvk = "uvk.__main__:main"
+
+[tool.setuptools]
+zip-safe = true
+include-package-data = true
+packages = ["uvk"]

uvk-0.0.1/src/uvk/__init__.py

@@ -0,0 +1,47 @@
+"""
+The uvk IPython extension provides magicks to manage the dependencies
+of an isolated kernel. It also ensures that the uv executable is visible
+by the IPython process, as shelling out to uv is how most of the kernel's
+specific functionalities are delivered.
+"""
+
+
+from IPython.core.magic import cell_magic, line_magic, line_cell_magic
+import subprocess as sp
+import warnings
+
+
+class CannotFindUV(Exception):
+
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(
+            (
+                "uv executable cannot be found; "
+                "it is critical for the features provided by "
+                f"extension {__name__}."
+            ),
+            *args,
+            **kwargs,
+        )
+
+
+def load_ipython_extension(ipython) -> None:
+    try:
+        sp.run(["uv"], stdout=sp.DEVNULL, stderr=sp.DEVNULL)
+    except OSError:
+        raise CannotFindUV()
+
+
+@cell_magic
+def script_metadata(cell: str) -> None:
+    print("TBD")
+
+
+@line_magic
+def python_version(line: str) -> None:
+    print("TBD")
+
+
+@line_cell_magic
+def dependencies(line: str) -> None:
+    print("TBD")

uvk-0.0.1/src/uvk/__main__.py

@@ -0,0 +1,108 @@
+from argparse import ArgumentParser
+import json
+import logging as lg
+from pathlib import Path
+import shutil
+import subprocess as sp
+import sys
+
+
+LOG = lg.getLogger("uvk")
+
+
+def main():
+    lg.basicConfig(level=lg.DEBUG, format="%(levelname)-10s %(message)s")
+
+    parser = ArgumentParser(
+        description="Deploys the UVK kernel",
+    )
+    parser.add_argument(
+        "--name",
+        help="Name of the kernelspec. Default is `uvk`.",
+        default="uvk",
+    )
+    displayname_default = f"UVK (Python {sys.version_info.major}.{sys.version_info.minor})"
+    parser.add_argument(
+        "--display-name",
+        help=(
+            "Pretty name for the kernelspec that will show in Jupyter "
+            f"interface. Default is `{displayname_default}`."
+        ),
+        default=displayname_default,
+    )
+    parser.add_argument(
+        "--tmp",
+        help="Location of the temporary directory. Default is the system's.",
+        default="",
+    )
+    args = parser.parse_args()
+
+    path_uv = shutil.which("uv")
+    if not path_uv:
+        LOG.error("Cannot find jupyter executable. Abort")
+        sys.exit(cp.returncode)
+
+    cp = sp.run(["jupyter", "--paths", "--json"], stdout=sp.PIPE)
+    paths_data = list(json.loads(cp.stdout).get("data") or [])
+    if not paths_data:
+        LOG.error("Cannot interpret the output of jupyter --paths. Abort")
+        sys.exit(1)
+    for p in paths_data:
+        dir = Path(p)
+        if dir.is_relative_to(Path.home() / ".local"):
+            dir_kernelspecs_user = dir / "kernels"
+            break
+    else:
+        LOG.error(
+            "Cannot find the user data path where Jupyter would find "
+            "user-specific kernelspecs. Abort"
+        )
+        sys.exit(2)
+
+    path_kernelspec_resources = Path(sys.prefix) / "share" / "jupyter" / "kernels" / "python3"
+    if not path_kernelspec_resources.is_dir():
+        LOG.error(
+            "The directory we expected to find kernelspec resources in does"
+            "not exist. Abort"
+        )
+        sys.exit(3)
+    dir_kernelspec_new = dir_kernelspecs_user / args.name
+    if dir_kernelspec_new.is_dir():
+        LOG.warn(
+            f"Kernel directory {dir_kernelspec_new} already exists. "
+            "Since carrying on would overwrite it, "
+            "we err on the side of caution and abort. "
+            "Delete it yourself and retry if you would rather overwrite."
+        )
+        sys.exit(4)
+    dir_kernelspec_new.mkdir(parents=True, exist_ok=False)
+    for p in path_kernelspec_resources.iterdir():
+        shutil.copy(p, dir_kernelspec_new / p.name, follow_symlinks=True)
+
+    path_kernel_json = dir_kernelspec_new / "kernel.json"
+    if not path_kernel_json.is_file():
+        LOG.error("Copying kernelspec resources failed somehow. Abort")
+        sys.exit(5)
+    kernel_json = json.loads(path_kernel_json.read_text(encoding="utf-8"))
+    kernel_json["argv"] = [
+        str(path_uv),
+        "run",
+        "--with",
+        "uvk",
+        "--isolated",
+        "--no-cache",
+        "python",
+        "-m",
+        "ipykernel_launcher",
+        "-f",
+        "{connection_file}",
+    ]
+    kernel_json["display_name"] = args.display_name
+    if args.tmp:
+        kernel_json["env"] = {"TMPDIR": args.tmp}
+    path_kernel_json.write_text(json.dumps(kernel_json, indent=2), encoding="utf-8")
+    LOG.info(f"UVK kernelspec added at {dir_kernelspec_new}")
+
+
+if __name__ == "__main__":
+    main()