;;; GNU Guix --- Functional package management for GNU ;;; Copyright © 2019, 2022 Ludovic Courtès ;;; Copyright © 2021-2024 Ricardo Wurmus ;;; Copyright © 2021 Hugo Lecomte ;;; Copyright © 2022 Marius Bakke ;;; Copyright © 2022 Maxim Cournoyer ;;; ;;; This file is part of GNU Guix. ;;; ;;; GNU Guix is free software; you can redistribute it and/or modify it ;;; under the terms of the GNU General Public License as published by ;;; the Free Software Foundation; either version 3 of the License, or (at ;;; your option) any later version. ;;; ;;; GNU Guix is distributed in the hope that it will be useful, but ;;; WITHOUT ANY WARRANTY; without even the implied warranty of ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ;;; GNU General Public License for more details. ;;; ;;; You should have received a copy of the GNU General Public License ;;; along with GNU Guix. If not, see . (define-module (gnu packages jupyter) #:use-module ((guix licenses) #:prefix license:) #:use-module (guix gexp) #:use-module (guix packages) #:use-module (guix download) #:use-module (guix git-download) #:use-module (guix build-system cmake) #:use-module (guix build-system pyproject) #:use-module (guix build-system python) #:use-module (gnu packages bash) #:use-module (gnu packages check) #:use-module (gnu packages cpp) #:use-module (gnu packages docker) #:use-module (gnu packages linux) #:use-module (gnu packages monitoring) #:use-module (gnu packages networking) #:use-module (gnu packages pkg-config) #:use-module (gnu packages python) #:use-module (gnu packages python-build) #:use-module (gnu packages python-check) #:use-module (gnu packages python-crypto) #:use-module (gnu packages python-science) #:use-module (gnu packages python-xyz) #:use-module (gnu packages python-web) #:use-module (gnu packages rdf) #:use-module (gnu packages time) #:use-module (gnu packages xml) #:use-module (gnu packages tls) #:use-module (gnu packages sphinx) #:use-module (gnu packages serialization) #:use-module (gnu packages version-control)) (define-public python-nbclassic (package (name "python-nbclassic") (version "1.0.0") (source (origin (method url-fetch) (uri (pypi-uri "nbclassic" version)) (sha256 (base32 "1qrhzazq10dz64y9mawr3ns595fsdhrj1wvbb42xhmcl66r1xq8a")))) (build-system pyproject-build-system) (propagated-inputs (list python-argon2-cffi python-ipykernel python-ipython-genutils python-jinja2 python-jupyter-client python-jupyter-core python-jupyter-server python-nbconvert python-nbformat python-nest-asyncio python-notebook-shim python-prometheus-client python-pyzmq python-send2trash python-terminado python-tornado-6 python-traitlets)) (native-inputs (list python-coverage python-nbval python-jupyter-packaging python-pytest python-pytest-cov python-pytest-jupyter python-pytest-tornasync python-requests python-requests-unixsocket python-testpath)) (home-page "https://github.com/jupyter/nbclassic") (synopsis "Jupyter Notebook as a Jupyter Server extension") (description "NbClassic provides a backwards compatible Jupyter Notebook interface that you can install side-by-side with the latest versions: That way, you can fearlessly upgrade without worrying about your classic extensions and customizations breaking. Because NbClassic provides the classic interface on top of the new Jupyter Server backend, it can coexist with other frontends like JupyterLab and Notebook 7 in the same installation. NbClassic preserves the custom classic notebook experience under a new set of URL endpoints, under the namespace @code{/nbclassic/}.") (license license:bsd-3))) (define-public python-notebook-shim (package (name "python-notebook-shim") (version "0.2.4") (source (origin (method url-fetch) (uri (pypi-uri "notebook_shim" version)) (sha256 (base32 "1jrqqrm5xjwsx13plyyh7wybb1g71yrzaqa3l9y3162xnshwzcml")))) (build-system pyproject-build-system) (propagated-inputs (list python-jupyter-server)) (native-inputs (list python-hatchling python-pytest python-pytest-console-scripts python-pytest-jupyter python-pytest-tornasync)) (home-page "https://pypi.org/project/notebook-shim/") (synopsis "Shim layer for notebook traits and config") (description "This project provides a way for JupyterLab and other frontends to switch to Jupyter Server for their Python Web application backend.") (license license:bsd-3))) (define-public python-jupyter-protocol (package (name "python-jupyter-protocol") (version "0.2.0") (source (origin (method url-fetch) (uri (pypi-uri "jupyter_protocol" version)) (sha256 (base32 "075vbaak6hlk9606lw61ldv72p6694k938jd1kvkm6spd0pczpmn")))) (build-system python-build-system) (propagated-inputs (list python-dateutil python-ipython-genutils python-jupyter-core python-pyzmq python-traitlets)) (native-inputs (list python-ipykernel python-ipython python-mock python-pytest)) (home-page "https://jupyter.org") (synopsis "Jupyter protocol implementation") (description "This Python library is an experimental implementation of the @uref{https://jupyter-client.readthedocs.io/en/latest/messaging.html, Jupyter protocol} to be used by both clients and kernels.") (license license:bsd-3) (properties '((upstream-name . "jupyter_protocol"))))) (define-public python-jupyter-kernel-mgmt (package (name "python-jupyter-kernel-mgmt") (version "0.5.1") (source (origin (method url-fetch) (uri (pypi-uri "jupyter_kernel_mgmt" version)) (sha256 (base32 "0977ixfi1pzjgy84hl0zycg4wpllmid98fhzcpy0lxd322w4sl7x")))) (build-system python-build-system) (arguments (list ;; There are 8 test failures, most of them in 'test_client_loop.py' ;; (see: https://github.com/takluyver/jupyter_kernel_mgmt/issues/48). #:tests? #f #:phases #~(modify-phases %standard-phases (replace 'check (lambda* (#:key tests? #:allow-other-keys) (when tests? (setenv "HOME" "/tmp") (invoke "pytest" "-vv" "jupyter_kernel_mgmt"))))))) (propagated-inputs (list python-dateutil python-entrypoints python-jupyter-core python-jupyter-protocol python-pyzmq python-tornado-6 python-traitlets)) (native-inputs (list python-async-generator python-ipykernel python-ipython python-pytest python-pytest-asyncio)) (home-page "https://jupyter.org") (synopsis "Discover, launch, and communicate with Jupyter kernels") (description "This package is an experimental refactoring of the machinery for launching and using Jupyter kernels.") (license license:bsd-3) (properties '((upstream-name . "jupyter_kernel_mgmt"))))) (define-public python-jupyter-kernel-test (package (name "python-jupyter-kernel-test") (version "0.3") (home-page "https://github.com/jupyter/jupyter_kernel_test") (source (origin ;; PyPI has a ".whl" file but not a proper source release. ;; Thus, fetch code from Git. (method git-fetch) (uri (git-reference (url home-page) (commit version))) (file-name (git-file-name name version)) (sha256 (base32 "00iy74i4i8is6axb9vlsm0b9wxkvyyxnbl8r0i4gaj3xd788jm83")))) (build-system python-build-system) (arguments ;; The repo doesn't contain a "setup.py" file so install files manually. '(#:phases (modify-phases %standard-phases (delete 'build) (delete 'check) (replace 'install (lambda* (#:key inputs outputs #:allow-other-keys) (let* ((out (assoc-ref outputs "out")) (version (python-version (assoc-ref inputs "python"))) (pydir (string-append out "/lib/python" version "/site-packages/" "jupyter_kernel_test"))) (for-each (lambda (file) (install-file file pydir)) (find-files "jupyter_kernel_test" "\\.py$")) #t)))))) (propagated-inputs (list python-jupyter-kernel-mgmt python-jupyter-protocol python-jsonschema)) (synopsis "Test Jupyter kernels") (description "@code{jupyter_kernel_test} is a tool for testing Jupyter kernels. It tests kernels for successful code execution and conformance with the @uref{https://jupyter-client.readthedocs.io/en/latest/messaging.html, Jupyter Messaging Protocol}.") (license license:bsd-3))) (define-public python-pytest-jupyter (package (name "python-pytest-jupyter") (version "0.10.1") (source (origin (method url-fetch) (uri (pypi-uri "pytest_jupyter" version)) (sha256 (base32 "114y9py29j6p2iymhc3vj55x65gg1ncbhwal5mads0g2z7p59pq0")))) (build-system pyproject-build-system) (arguments (list #:test-flags ;; This requires python-jupyter-server, which itself requires this ;; package. '(list "--ignore=tests/test_jupyter_server.py") #:phases '(modify-phases %standard-phases ;; The jupyter_server tests requires python-jupyter-server, which ;; itself requires this package. (add-after 'unpack 'disable-tests (lambda _ (substitute* "tests/conftest.py" (("\"pytest_jupyter.jupyter_server\",") "")))) ;; Some tests require a writable HOME (add-before 'check 'set-HOME (lambda _ (setenv "HOME" "/tmp"))) (add-after 'unpack 'ignore-deprecation-warnings (lambda _ (substitute* "pyproject.toml" ((" \"module:datetime.*" m) (string-append m "\n\"ignore:zmq.eventloop.ioloop is deprecated:DeprecationWarning\",")))))))) (propagated-inputs (list python-jupyter-core python-nbformat)) (native-inputs (list python-hatchling python-ipykernel python-pytest python-pytest-timeout python-tornado-6)) (home-page "https://jupyter.org") (synopsis "Pytest plugin for testing Jupyter libraries and extensions.") (description "This package provides a pytest plugin for testing Jupyter libraries and extensions.") (license license:bsd-4))) (define-public xeus (package (name "xeus") (version "2.4.1") (source (origin (method git-fetch) (uri (git-reference (url "https://github.com/jupyter-xeus/xeus") (commit version))) (sha256 (base32 "1k1h416qkw3yra6ayfa61nv0v4ify2wvp5x27slgbcw6c88w7fb1")) (file-name (git-file-name name version)))) (build-system cmake-build-system) (arguments '(#:configure-flags '("-DBUILD_STATIC_LIBS=OFF" "-DDISABLE_ARCH_NATIVE=ON" ;no '-march=native' "-DBUILD_TESTING=ON"))) (native-inputs (list pkg-config ;; The following inputs are used by the test suite. googletest python-pytest python-wrapper python-jupyter-kernel-test python-jupyter-client)) (inputs (list xtl nlohmann-json cppzmq zeromq openssl `(,util-linux "lib"))) ;libuuid (home-page "https://quantstack.net/xeus") (synopsis "C++ implementation of the Jupyter Kernel protocol") (description "@code{xeus} is a library meant to facilitate the implementation of kernels for Jupyter. It takes the burden of implementing the Jupyter Kernel protocol so developers can focus on implementing the interpreter part of the kernel. Several Jupyter kernels are built upon @code{xeus}, such as @code{xeus-cling}, a kernel for the C++ programming language, and @code{xeus-python}, an alternative Python kernel for Jupyter.") (license license:bsd-3))) (define-public python-jupyterlab-pygments (package (name "python-jupyterlab-pygments") (version "0.1.2") (source (origin (method url-fetch) (uri (pypi-uri "jupyterlab_pygments" version)) (sha256 (base32 "0ij14mmnc39nmf84i0av6j9glazjic7wzv1qyhr0j5966s3s1kfg")))) (build-system python-build-system) (arguments '(#:tests? #false)) ; there are no tests (propagated-inputs (list python-pygments)) (home-page "https://jupyter.org") (synopsis "Pygments theme using JupyterLab CSS variables") (description "This package contains a syntax coloring theme for pygments making use of the JupyterLab CSS variables.") (license license:bsd-3))) (define-public python-jupyterlab-server (package (name "python-jupyterlab-server") (version "2.27.1") (source (origin (method url-fetch) (uri (pypi-uri "jupyterlab_server" version)) (sha256 (base32 "07b3m34akrf79xpaim9cymhsac0ry5ry7if998lcfxmn173mlyq9")))) (build-system pyproject-build-system) (arguments (list #:test-flags ;; XXX: These tests appear to fail due to the lack of ;; locales. '(list "-k" "not locale and not language") #:phases '(modify-phases %standard-phases (add-after 'unpack 'ignore-deprecation-warnings (lambda _ (substitute* "pyproject.toml" ((" \"module:datetime.*" m) (string-append m "\n\"ignore:zmq.eventloop.ioloop is deprecated:DeprecationWarning\"," "\n\"ignore:There is no current event loop:DeprecationWarning\"," "\n\"ignore:Spec is deprecated. Use SchemaPath from jsonschema-path package.:DeprecationWarning\"," ))))) (add-before 'check 'set-HOME (lambda _ (setenv "HOME" "/tmp")))))) (propagated-inputs (list python-babel python-importlib-metadata ;TODO: remove after Python >= 3.10 python-jinja2 python-json5 python-jsonschema python-jupyter-server python-packaging python-requests)) (native-inputs (list python-hatchling python-ipykernel python-openapi-core python-openapi-spec-validator python-pytest python-pytest-console-scripts python-pytest-cov python-pytest-jupyter python-pytest-timeout python-requests-mock python-ruamel.yaml python-strict-rfc3339 python-werkzeug)) (home-page "https://jupyter.org") (synopsis "Server components for JupyterLab applications") (description "JupyterLab Server sits between JupyterLab and Jupyter Server, and provides a set of REST API handlers and utilities that are used by JupyterLab. It is a separate project in order to accommodate creating JupyterLab-like applications from a more limited scope.") (license license:bsd-3))) (define-public python-jupyter-events (package (name "python-jupyter-events") (version "0.10.0") (source (origin (method url-fetch) (uri (pypi-uri "jupyter_events" version)) (sha256 (base32 "08jyhj16drl3hg594gr677bc5q991lpd4khlhb3jx26csclq42v7")))) (build-system pyproject-build-system) (arguments ;; This passes the whole command line to shutil.which, instead of just ;; the executable. (list #:test-flags '(list "--ignore=tests/test_cli.py"))) (propagated-inputs (list python-jsonschema python-json-logger python-pyyaml python-referencing python-rich python-rfc3339-validator python-rfc3986-validator python-traitlets)) (native-inputs (list python-click python-hatchling python-pytest python-pytest-asyncio python-pytest-console-scripts)) (home-page "https://pypi.org/project/jupyter-events/") (synopsis "Jupyter Event System library") (description "Jupyter Events enables Jupyter Python Applications (e.g. Jupyter Server, JupyterLab Server, JupyterHub, etc.) to emit events—structured data describing things happening inside the application. Other software (e.g. client applications like JupyterLab) can listen and respond to these events.") (license license:bsd-3))) (define-public python-jupyter-packaging (package (name "python-jupyter-packaging") (version "0.12.0") (source (origin (method url-fetch) (uri (pypi-uri "jupyter_packaging" version)) (sha256 (base32 "1b7ssc627vgrdl21c09w9sxk5fc1ps3g7f70laxag4yw1bb5ax5j")))) (build-system python-build-system) (arguments (list #:phases #~(modify-phases %standard-phases (replace 'check (lambda* (#:key tests? #:allow-other-keys) (when tests? ;; Disable isolation so that the package environment can be ;; setup without connectivity. (setenv "SOURCE_DATE_EPOCH" "315532800") (substitute* "tests/test_build_api.py" (("\"-m\", \"build\"" all) (string-append all ", \"--no-isolation\""))) (invoke "python" "-m" "pytest" "-vv"))))))) (propagated-inputs (list python-deprecation python-packaging python-setuptools python-tomlkit python-wheel)) (native-inputs (list python-pypa-build python-coverage python-pytest python-pytest-cov python-pytest-mock)) (home-page "https://jupyter.org") (synopsis "Jupyter packaging utilities") (description "This package provides tools to help build and install Jupyter Python packages that require a pre-build step that may include JavaScript build steps.") (license license:bsd-3))) (define-public python-hatch-jupyter-builder (package (name "python-hatch-jupyter-builder") (version "0.9.1") (source (origin (method url-fetch) (uri (pypi-uri "hatch_jupyter_builder" version)) (sha256 (base32 "1baqk80c5ddhksh73l48mb59vvaaa2ldrs65k6vldii4s6c829vr")))) (build-system pyproject-build-system) (arguments ;; Don't attempt to build anything, because we don't have network access ;; anyway. (list #:test-flags '(list "-k" "not test_hatch_build"))) (propagated-inputs (list python-hatchling)) (native-inputs (list python-pytest python-pytest-cov python-pytest-mock python-tomli python-twine)) (home-page "https://github.com/jupyterlab/hatch-jupyter-builder") (synopsis "Hatch plugin to help build Jupyter packages") (description "This package provides a hatch plugin to help build Jupyter packages.") (license license:bsd-3))) (define-public python-jupyter-server (package (name "python-jupyter-server") (version "2.14.0") (source (origin (method url-fetch) (uri (pypi-uri "jupyter_server" version)) (sha256 (base32 "0xz69anflhib514lgpdrs0ppmbwp13zbg4vwzls3820jlp7594b5")))) (build-system pyproject-build-system) (arguments (list #:test-flags ;; Integration tests require a server. '(list "-m" "not integration_test" ;; This test fails just like the shutil test in ;; python-jupyter-events fails. Odd, that. "-k" "not test_server_extension_list") #:phases #~(modify-phases %standard-phases (add-after 'unpack 'ignore-deprecation-warnings (lambda _ (substitute* "pyproject.toml" ((" \"ignore:datetime.*" m) (string-append m "\n\"ignore:zmq.eventloop.ioloop is deprecated:DeprecationWarning\"," "\n\"ignore:There is no current event loop:DeprecationWarning\"," "\n\"ignore:unclosed event loop:ResourceWarning\"," ;; From tornado "\n\"ignore:unclosed =0.4.0,<0.6") "nbclient")))) (replace 'check (lambda* (#:key tests? #:allow-other-keys) (when tests? (setenv "HOME" "/tmp") (invoke "pytest" "-vv" ;; Many tests depend on Node JavaScript dependencies ;; and a running HTTP server; ignore them. "--ignore" "tests/app" "--ignore" "tests/server"))))))) (propagated-inputs (list python-jupyter-client python-jupyter-server python-jupyterlab-server python-nbclient python-nbconvert python-traitlets python-websockets)) (native-inputs (list python-ipywidgets python-matplotlib python-mock python-numpy python-pandas python-pytest python-pytest-tornasync python-tornado-6)) (home-page "https://github.com/voila-dashboards/voila") (synopsis "Render live Jupyter notebooks with interactive widgets") (description "Voilà turns Jupyter notebooks into standalone web applications. Unlike the usual HTML-converted notebooks, each user connecting to the Voilà tornado application gets a dedicated Jupyter kernel which can execute the callbacks to changes in Jupyter interactive widgets.") (license license:bsd-3)))