kernelcontract 0.1.0a3__tar.gz

kernelcontract-0.1.0a3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KernelContract contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kernelcontract-0.1.0a3/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: kernelcontract
+Version: 0.1.0a3
+Summary: Read-only diagnostics for Jupyter kernels and Python environments
+Author: KernelContract contributors
+License: MIT License
+        
+        Copyright (c) 2026 KernelContract contributors
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Keywords: jupyter,notebook,kernel,diagnostics,python-environments
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Dynamic: license-file
+
+# KernelContract
+
+**Local-first, read-only diagnostics for Jupyter kernels, kernelspecs, and notebook environments.**
+
+KernelContract inspects registered Jupyter kernelspecs, checks whether their configured executables resolve, probes Python kernel environments, and compares notebook kernel metadata with the kernels available to the current Jupyter CLI. It reports likely configuration mismatches, missing interpreters, and safe next steps without modifying the machine.
+
+> **Alpha Software — Candidate 0.1.0a3 (Latest tagged pre-release: [v0.1.0a2](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2)).** KernelContract is an early-stage diagnostic tool under active development. The latest published GitHub pre-release is `v0.1.0a2`, and the current default branch is preparing candidate `0.1.0a3` for PyPI Trusted Publishing. It has **not** yet been published to PyPI. The project name is provisional and has not been trademark- or registry-cleared.
+
+---
+
+## Quick start
+
+### Prerequisites
+
+* **Python 3.10 or newer.**
+* **Jupyter CLI on PATH:** KernelContract has zero external runtime dependencies (it uses the Python standard library only), but it requires that the `jupyter` command is available on your `PATH` (such as via `jupyter-core`) to discover registered kernels via `jupyter kernelspec list --json`.
+
+### End-user installation (pre-release)
+
+Install the tagged alpha pre-release directly from GitHub using `pip`:
+
+```bash
+python -m pip install "git+https://github.com/Ayushxsingh100/kernelcontract.git@v0.1.0a3"
+```
+
+Or install the latest development snapshot from the default `master` branch:
+
+```bash
+python -m pip install "git+https://github.com/Ayushxsingh100/kernelcontract.git"
+```
+
+> **Note on PyPI:** The command `pip install kernelcontract` is reserved for future distribution once the package is officially published to the Python Package Index.
+
+---
+
+## Core usage
+
+### 1. Diagnose registered Jupyter kernels
+
+Run the `doctor` command to inspect all discovered kernelspecs, verify their executables, and check the active Python environment:
+
+```bash
+kernelcontract doctor
+```
+
+### 2. Validate notebook kernel metadata
+
+Inspect whether a `.ipynb` file's declared kernel exists and matches currently registered kernelspecs:
+
+```bash
+kernelcontract notebook path/to/notebook.ipynb
+```
+
+If the notebook requests an unavailable kernel or if the kernel's stored display name has drifted from disk, KernelContract reports the issue with actionable next steps.
+
+### 3. Machine-readable JSON output
+
+Produce structured, versioned JSON suitable for automated tooling, pre-commit hooks, or CI pipelines:
+
+```bash
+kernelcontract doctor --json
+kernelcontract notebook path/to/notebook.ipynb --json
+```
+
+The JSON schema output includes `schema_version`, `status` (`PASS`, `WARN`, `FAIL`), check details, and specific remediation suggestions.
+
+### 4. Strict CI mode
+
+By default, `FAIL` makes the command exit with status 1, while warnings exit with status 0. To fail CI on warnings as well as failures, pass `--strict`:
+
+```bash
+kernelcontract doctor --strict
+```
+
+### 5. Probing external Python kernels (opt-in)
+
+```bash
+kernelcontract doctor --probe-python
+```
+
+* **Security Note:** By default, KernelContract only executes package inspection on the current control interpreter and kernels that resolve to the exact same executable. Interpreters outside the current environment are **not** executed unless you pass `--probe-python`. Use `--probe-python` only with kernelspecs and environments you trust.
+
+---
+
+## What it checks
+
+* **CLI Discovery:** Whether the Jupyter CLI can enumerate kernelspecs using `jupyter kernelspec list --json`.
+* **JSON Structure Safety:** Whether kernelspec outputs have valid root structures and dictionary objects.
+* **Executable Resolution:** Whether each registered kernelspec has a resolvable `argv[0]` executable (including Windows `PATHEXT` resolution for `.exe`, `.cmd`, `.bat`, quoted paths with spaces, and environment variable expansion).
+* **Environment Integrity:** Whether the control Python (and, when opted in, external Python kernels) can start and whether `ipykernel` is installed in that interpreter.
+* **Environment Drift:** Whether a probed kernel's Python prefix differs from the control interpreter.
+* **Widget Companion Check:** A narrow check for presence of `jupyterlab_widgets` when the control environment contains JupyterLab and a probed kernel contains `ipywidgets`.
+* **Notebook Metadata Check:** Whether a notebook file declares a kernel name that is currently registered and whether the recorded display name matches the kernelspec on disk.
+
+---
+
+## Server vs. kernel environments
+
+KernelContract cannot reliably infer which Python interpreter belongs to an already-running Jupyter server across diverse setups (e.g. systemd services, Docker containers, remote SSH tunnels, JupyterHub). By default, it uses the Python interpreter launching KernelContract as its **control environment**.
+
+If you know the specific Python interpreter running the Jupyter server, pass it explicitly:
+
+```bash
+kernelcontract doctor --server-python /absolute/path/to/server/python
+```
+
+---
+
+## Safety and privacy guarantees
+
+* **Strictly Read-Only:** KernelContract modifies no packages, rewrites no files, and changes no configuration.
+* **No Telemetry:** Zero analytics, telemetry, or network calls are made by KernelContract.
+* **Bounded Subprocesses:** Subprocess probes use strict execution timeouts to avoid hanging indefinitely.
+* **No Shell Execution:** Commands are executed directly with argument lists (`shell=False`).
+
+---
+
+## Development
+
+To contribute or run the test suite locally from source:
+
+```bash
+git clone https://github.com/Ayushxsingh100/kernelcontract.git
+cd kernelcontract
+python -m venv .venv
+# Activate .venv (Windows: .venv\Scripts\activate | Unix: source .venv/bin/activate)
+python -m pip install -e ".[test]"
+python -m unittest discover -s tests -v
+python -m pytest -q
+```
+
+---
+
+## Status
+
+* **Version:** `0.1.0a3` (alpha candidate; latest tagged pre-release: [`v0.1.0a2`](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2))
+* **Repository:** [https://github.com/Ayushxsingh100/kernelcontract](https://github.com/Ayushxsingh100/kernelcontract)
+* **Pre-release Notes:** [v0.1.0a2 Release](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2)
+* **License:** [MIT](LICENSE)
+* **Stability:** Alpha

kernelcontract-0.1.0a3/README.md

@@ -0,0 +1,140 @@
+# KernelContract
+
+**Local-first, read-only diagnostics for Jupyter kernels, kernelspecs, and notebook environments.**
+
+KernelContract inspects registered Jupyter kernelspecs, checks whether their configured executables resolve, probes Python kernel environments, and compares notebook kernel metadata with the kernels available to the current Jupyter CLI. It reports likely configuration mismatches, missing interpreters, and safe next steps without modifying the machine.
+
+> **Alpha Software — Candidate 0.1.0a3 (Latest tagged pre-release: [v0.1.0a2](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2)).** KernelContract is an early-stage diagnostic tool under active development. The latest published GitHub pre-release is `v0.1.0a2`, and the current default branch is preparing candidate `0.1.0a3` for PyPI Trusted Publishing. It has **not** yet been published to PyPI. The project name is provisional and has not been trademark- or registry-cleared.
+
+---
+
+## Quick start
+
+### Prerequisites
+
+* **Python 3.10 or newer.**
+* **Jupyter CLI on PATH:** KernelContract has zero external runtime dependencies (it uses the Python standard library only), but it requires that the `jupyter` command is available on your `PATH` (such as via `jupyter-core`) to discover registered kernels via `jupyter kernelspec list --json`.
+
+### End-user installation (pre-release)
+
+Install the tagged alpha pre-release directly from GitHub using `pip`:
+
+```bash
+python -m pip install "git+https://github.com/Ayushxsingh100/kernelcontract.git@v0.1.0a3"
+```
+
+Or install the latest development snapshot from the default `master` branch:
+
+```bash
+python -m pip install "git+https://github.com/Ayushxsingh100/kernelcontract.git"
+```
+
+> **Note on PyPI:** The command `pip install kernelcontract` is reserved for future distribution once the package is officially published to the Python Package Index.
+
+---
+
+## Core usage
+
+### 1. Diagnose registered Jupyter kernels
+
+Run the `doctor` command to inspect all discovered kernelspecs, verify their executables, and check the active Python environment:
+
+```bash
+kernelcontract doctor
+```
+
+### 2. Validate notebook kernel metadata
+
+Inspect whether a `.ipynb` file's declared kernel exists and matches currently registered kernelspecs:
+
+```bash
+kernelcontract notebook path/to/notebook.ipynb
+```
+
+If the notebook requests an unavailable kernel or if the kernel's stored display name has drifted from disk, KernelContract reports the issue with actionable next steps.
+
+### 3. Machine-readable JSON output
+
+Produce structured, versioned JSON suitable for automated tooling, pre-commit hooks, or CI pipelines:
+
+```bash
+kernelcontract doctor --json
+kernelcontract notebook path/to/notebook.ipynb --json
+```
+
+The JSON schema output includes `schema_version`, `status` (`PASS`, `WARN`, `FAIL`), check details, and specific remediation suggestions.
+
+### 4. Strict CI mode
+
+By default, `FAIL` makes the command exit with status 1, while warnings exit with status 0. To fail CI on warnings as well as failures, pass `--strict`:
+
+```bash
+kernelcontract doctor --strict
+```
+
+### 5. Probing external Python kernels (opt-in)
+
+```bash
+kernelcontract doctor --probe-python
+```
+
+* **Security Note:** By default, KernelContract only executes package inspection on the current control interpreter and kernels that resolve to the exact same executable. Interpreters outside the current environment are **not** executed unless you pass `--probe-python`. Use `--probe-python` only with kernelspecs and environments you trust.
+
+---
+
+## What it checks
+
+* **CLI Discovery:** Whether the Jupyter CLI can enumerate kernelspecs using `jupyter kernelspec list --json`.
+* **JSON Structure Safety:** Whether kernelspec outputs have valid root structures and dictionary objects.
+* **Executable Resolution:** Whether each registered kernelspec has a resolvable `argv[0]` executable (including Windows `PATHEXT` resolution for `.exe`, `.cmd`, `.bat`, quoted paths with spaces, and environment variable expansion).
+* **Environment Integrity:** Whether the control Python (and, when opted in, external Python kernels) can start and whether `ipykernel` is installed in that interpreter.
+* **Environment Drift:** Whether a probed kernel's Python prefix differs from the control interpreter.
+* **Widget Companion Check:** A narrow check for presence of `jupyterlab_widgets` when the control environment contains JupyterLab and a probed kernel contains `ipywidgets`.
+* **Notebook Metadata Check:** Whether a notebook file declares a kernel name that is currently registered and whether the recorded display name matches the kernelspec on disk.
+
+---
+
+## Server vs. kernel environments
+
+KernelContract cannot reliably infer which Python interpreter belongs to an already-running Jupyter server across diverse setups (e.g. systemd services, Docker containers, remote SSH tunnels, JupyterHub). By default, it uses the Python interpreter launching KernelContract as its **control environment**.
+
+If you know the specific Python interpreter running the Jupyter server, pass it explicitly:
+
+```bash
+kernelcontract doctor --server-python /absolute/path/to/server/python
+```
+
+---
+
+## Safety and privacy guarantees
+
+* **Strictly Read-Only:** KernelContract modifies no packages, rewrites no files, and changes no configuration.
+* **No Telemetry:** Zero analytics, telemetry, or network calls are made by KernelContract.
+* **Bounded Subprocesses:** Subprocess probes use strict execution timeouts to avoid hanging indefinitely.
+* **No Shell Execution:** Commands are executed directly with argument lists (`shell=False`).
+
+---
+
+## Development
+
+To contribute or run the test suite locally from source:
+
+```bash
+git clone https://github.com/Ayushxsingh100/kernelcontract.git
+cd kernelcontract
+python -m venv .venv
+# Activate .venv (Windows: .venv\Scripts\activate | Unix: source .venv/bin/activate)
+python -m pip install -e ".[test]"
+python -m unittest discover -s tests -v
+python -m pytest -q
+```
+
+---
+
+## Status
+
+* **Version:** `0.1.0a3` (alpha candidate; latest tagged pre-release: [`v0.1.0a2`](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2))
+* **Repository:** [https://github.com/Ayushxsingh100/kernelcontract](https://github.com/Ayushxsingh100/kernelcontract)
+* **Pre-release Notes:** [v0.1.0a2 Release](https://github.com/Ayushxsingh100/kernelcontract/releases/tag/v0.1.0a2)
+* **License:** [MIT](LICENSE)
+* **Stability:** Alpha

kernelcontract-0.1.0a3/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "kernelcontract"
+version = "0.1.0a3"
+description = "Read-only diagnostics for Jupyter kernels and Python environments"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { file = "LICENSE" }
+authors = [{ name = "KernelContract contributors" }]
+keywords = ["jupyter", "notebook", "kernel", "diagnostics", "python-environments"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+  "Topic :: Software Development :: Debuggers",
+  "Topic :: Utilities",
+]
+dependencies = []
+
+[project.optional-dependencies]
+test = ["pytest>=8.0"]
+
+[project.scripts]
+kernelcontract = "kernelcontract.cli:entrypoint"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "-q"
+testpaths = ["tests"]

kernelcontract-0.1.0a3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

kernelcontract-0.1.0a3/src/kernelcontract/__init__.py

@@ -0,0 +1,3 @@
+"""KernelContract: read-only diagnostics for Jupyter kernels and Python environments."""
+
+__version__ = "0.1.0a3"

kernelcontract-0.1.0a3/src/kernelcontract/__main__.py

@@ -0,0 +1,4 @@
+from .cli import entrypoint
+
+if __name__ == "__main__":
+    entrypoint()

kernelcontract-0.1.0a3/src/kernelcontract/cli.py

@@ -0,0 +1,87 @@
+"""Command-line interface for KernelContract."""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+from typing import Optional, Sequence
+
+from . import __version__
+from .diagnostics import run_diagnostics
+from .models import Report
+
+
+def _parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="kernelcontract",
+        description="Read-only diagnostics for Jupyter kernels and Python environments.",
+        epilog="No packages are installed, removed, or modified by this tool.",
+    )
+    parser.add_argument("--version", action="version", version="%(prog)s {}".format(__version__))
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    doctor = subparsers.add_parser("doctor", help="check registered Jupyter kernels and environment drift")
+    doctor.add_argument("--server-python", help="path to the Python interpreter used by the Jupyter server (optional)")
+    doctor.add_argument("--json", action="store_true", dest="json_output", help="print machine-readable JSON")
+    doctor.add_argument("--strict", action="store_true", help="exit non-zero for warnings as well as failures")
+    doctor.add_argument("--probe-python", action="store_true", help="execute each registered Python kernel's argv[0] for package checks; use only with trusted kernelspecs")
+
+    notebook = subparsers.add_parser("notebook", help="check a notebook's declared kernel against registered kernels")
+    notebook.add_argument("path", help="path to a .ipynb file")
+    notebook.add_argument("--server-python", help="path to the Python interpreter used by the Jupyter server (optional)")
+    notebook.add_argument("--json", action="store_true", dest="json_output", help="print machine-readable JSON")
+    notebook.add_argument("--strict", action="store_true", help="exit non-zero for warnings as well as failures")
+    notebook.add_argument("--probe-python", action="store_true", help="execute each registered Python kernel's argv[0] for package checks; use only with trusted kernelspecs")
+    return parser
+
+
+def render_text(report: Report) -> str:
+    lines = ["KernelContract {} - {}".format(__version__, report.command), "=" * 44]
+    for check in report.checks:
+        lines.append("{:<5} {}".format(check.status, check.title))
+        lines.append("      {}".format(check.message))
+        for suggestion in check.suggestions:
+            lines.append("      Next: {}".format(suggestion))
+    counts = report.counts
+    lines.extend([
+        "",
+        "Summary: {pass_count} pass, {info_count} info, {warn_count} warning(s), {fail_count} failure(s).".format(
+            pass_count=counts["pass"], info_count=counts["info"], warn_count=counts["warn"], fail_count=counts["fail"]
+        ),
+        "Overall status: {}".format(report.overall_status),
+        "KernelContract did not modify packages or environments.",
+    ])
+    return "\n".join(lines)
+
+
+def exit_code(report: Report, strict: bool = False) -> int:
+    if any(check.status == "FAIL" for check in report.checks):
+        return 1
+    if strict and any(check.status == "WARN" for check in report.checks):
+        return 1
+    return 0
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    args = _parser().parse_args(argv)
+    notebook_path = args.path if args.command == "notebook" else None
+    report = run_diagnostics(
+        command=args.command,
+        notebook_path=notebook_path,
+        server_python=args.server_python,
+        probe_python_kernels=args.probe_python,
+    )
+    if args.json_output:
+        print(json.dumps(report.to_dict(), indent=2, sort_keys=True))
+    else:
+        print(render_text(report))
+    return exit_code(report, strict=args.strict)
+
+
+def entrypoint() -> None:
+    raise SystemExit(main())
+
+
+if __name__ == "__main__":
+    entrypoint()