jupyter-server-nbmodel 0.1.1a1__tar.gz

jupyter_server_nbmodel-0.1.1a1/.copier-answers.yml

@@ -0,0 +1,15 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.3.4
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: ''
+author_name: Datalayer
+has_binder: true
+has_settings: false
+kind: server
+labextension_name: jupyter-server-nbmodel
+project_short_description: A Jupyter Server extension to execute code cell from the
+    server.
+python_name: jupyter_server_nbmodel
+repository: https://github.com/datalayer/jupyter-server-nbmodel
+test: true
+

jupyter_server_nbmodel-0.1.1a1/.gitignore

@@ -0,0 +1,127 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+jupyter_server_nbmodel/labextension
+# Version file is handled by hatchling
+jupyter_server_nbmodel/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+.jupyter_ystore.db
+.vscode
+
+# Yarn cache
+.yarn/

jupyter_server_nbmodel-0.1.1a1/.pre-commit-config.yaml

@@ -0,0 +1,37 @@
+ci:
+  autoupdate_schedule: monthly
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: requirements-txt-fixer
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: debug-statements
+      - id: forbid-new-submodules
+      - id: check-builtin-literals
+      - id: trailing-whitespace
+
+  - repo: https://github.com/python-jsonschema/check-jsonschema
+    rev: 0.28.3
+    hooks:
+      - id: check-github-workflows
+
+  - repo: https://github.com/executablebooks/mdformat
+    rev: 0.7.16
+    hooks:
+      - id: mdformat
+        additional_dependencies:
+          [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
+
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: v0.4.4
+    hooks:
+      - id: ruff
+        args: ["--fix"]

jupyter_server_nbmodel-0.1.1a1/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+jupyter_server_nbmodel

jupyter_server_nbmodel-0.1.1a1/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

jupyter_server_nbmodel-0.1.1a1/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+## 0.1.1a1
+
+([Full Changelog](https://github.com/datalayer/jupyter-server-nbmodel/compare/bf5719ce10580303de08342073b66e3d579e7cdc...2facfb378e11f8f564593f4329af5c71d7fa67f2))
+
+### Enhancements made
+
+- Preparation for first release [#20](https://github.com/datalayer/jupyter-server-nbmodel/pull/20) ([@fcollonval](https://github.com/fcollonval))
+- Add jupyter_client to dep to ensure it contains the needed fix [#17](https://github.com/datalayer/jupyter-server-nbmodel/pull/17) ([@fcollonval](https://github.com/fcollonval))
+- Internalize frontend cell executor [#14](https://github.com/datalayer/jupyter-server-nbmodel/pull/14) ([@fcollonval](https://github.com/fcollonval))
+
+### Bugs fixed
+
+- Internalize frontend cell executor [#14](https://github.com/datalayer/jupyter-server-nbmodel/pull/14) ([@fcollonval](https://github.com/fcollonval))
+- Fix returning pending input for the correct request [#10](https://github.com/datalayer/jupyter-server-nbmodel/pull/10) ([@fcollonval](https://github.com/fcollonval))
+
+### Documentation improvements
+
+- Optionally depend on server ydoc and docprovider [#21](https://github.com/datalayer/jupyter-server-nbmodel/pull/21) ([@krassowski](https://github.com/krassowski))
+- Fix mermaidJS graph [#18](https://github.com/datalayer/jupyter-server-nbmodel/pull/18) ([@fcollonval](https://github.com/fcollonval))
+
+### Other merged PRs
+
+- Multiple enhancements [#9](https://github.com/datalayer/jupyter-server-nbmodel/pull/9) ([@fcollonval](https://github.com/fcollonval))
+- Bump actions/github-script from 3 to 7 [#4](https://github.com/datalayer/jupyter-server-nbmodel/pull/4) ([@dependabot](https://github.com/dependabot))
+- Update pytest requirement from ~=7.0 to ~=8.2 [#1](https://github.com/datalayer/jupyter-server-nbmodel/pull/1) ([@dependabot](https://github.com/dependabot))
+
+### Contributors to this release
+
+([GitHub contributors page for this release](https://github.com/datalayer/jupyter-server-nbmodel/graphs/contributors?from=2024-05-06&to=2024-07-29&type=c))
+
+[@dependabot](https://github.com/search?q=repo%3Adatalayer%2Fjupyter-server-nbmodel+involves%3Adependabot+updated%3A2024-05-06..2024-07-29&type=Issues) | [@fcollonval](https://github.com/search?q=repo%3Adatalayer%2Fjupyter-server-nbmodel+involves%3Afcollonval+updated%3A2024-05-06..2024-07-29&type=Issues) | [@github-actions](https://github.com/search?q=repo%3Adatalayer%2Fjupyter-server-nbmodel+involves%3Agithub-actions+updated%3A2024-05-06..2024-07-29&type=Issues) | [@krassowski](https://github.com/search?q=repo%3Adatalayer%2Fjupyter-server-nbmodel+involves%3Akrassowski+updated%3A2024-05-06..2024-07-29&type=Issues) | [@Wh1isper](https://github.com/search?q=repo%3Adatalayer%2Fjupyter-server-nbmodel+involves%3AWh1isper+updated%3A2024-05-06..2024-07-29&type=Issues)
+
+<!-- <END NEW CHANGELOG ENTRY> -->

jupyter_server_nbmodel-0.1.1a1/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Datalayer
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

jupyter_server_nbmodel-0.1.1a1/PKG-INFO

@@ -0,0 +1,355 @@
+Metadata-Version: 2.3
+Name: jupyter_server_nbmodel
+Version: 0.1.1a1
+Dynamic: Keywords
+Summary: A Jupyter Server extension to execute code cell from the server.
+Project-URL: Homepage, https://github.com/datalayer/jupyter-server-nbmodel
+Project-URL: Bug Tracker, https://github.com/datalayer/jupyter-server-nbmodel/issues
+Project-URL: Repository, https://github.com/datalayer/jupyter-server-nbmodel.git
+Author: Datalayer
+License: BSD 3-Clause License
+        
+        Copyright (c) 2024, Datalayer
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Requires-Dist: jupyter-client>=8.6.2
+Requires-Dist: jupyter-server<3,>=2.0.1
+Provides-Extra: lab
+Requires-Dist: jupyter-docprovider>=1.0.0b1; extra == 'lab'
+Requires-Dist: jupyter-server-ydoc>=1.0.0b1; extra == 'lab'
+Requires-Dist: jupyterlab>=4.2.0; extra == 'lab'
+Provides-Extra: lint
+Requires-Dist: mdformat-gfm>=0.3.5; extra == 'lint'
+Requires-Dist: mdformat>0.7; extra == 'lint'
+Requires-Dist: ruff>=0.4.0; extra == 'lint'
+Provides-Extra: test
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-jupyter[server]>=0.6; extra == 'test'
+Requires-Dist: pytest-timeout; extra == 'test'
+Requires-Dist: pytest~=8.2; extra == 'test'
+Provides-Extra: typing
+Requires-Dist: mypy>=0.990; extra == 'typing'
+Description-Content-Type: text/markdown
+
+# jupyter_server_nbmodel
+
+[![Github Actions Status](https://github.com/datalayer/jupyter-server-nbmodel/workflows/Build/badge.svg)](https://github.com/datalayer/jupyter-server-nbmodel/actions/workflows/build.yml)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/datalayer/jupyter-server-nbmodel/main?urlpath=lab)
+
+A Jupyter Server extension to execute code cell from the server.
+
+This extension is composed of a Python package named `jupyter_server_nbmodel`
+for the server extension and a NPM package named `jupyter-server-nbmodel`
+for the frontend extension.
+
+## Requirements
+
+- Jupyter Server
+- \[recommended\] Real-time collaboration for JupyterLab/Notebook:
+  This will push the kernels results in the notebook from the server.
+
+## Install
+
+To install the extension for use in JupyterLab or Notebook 7, execute:
+
+```bash
+pip install jupyter_server_nbmodel[lab]
+```
+
+For API-only use:
+
+```bash
+pip install jupyter_server_nbmodel
+```
+
+Or with recommendations:
+
+```bash
+pip install jupyter_server_nbmodel[rtc]
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall jupyter_server_nbmodel
+```
+
+## Troubleshoot
+
+If you are seeing the frontend extension, but it is not working, check
+that the server extension is enabled:
+
+```bash
+jupyter server extension list
+```
+
+If the server extension is installed and enabled, but you are not seeing
+the frontend extension, check the frontend extension is installed:
+
+```bash
+jupyter labextension list
+```
+
+## How does it works
+
+### Generic case
+
+Execution of a Python code snippet: `print("hello")`
+
+```mermaid
+sequenceDiagram
+    Frontend->>+Server: POST /api/kernels/<id>/execute
+    Server->>+ExecutionStack: Queue request
+    ExecutionStack->>Kernel: Execute request msg
+    activate Kernel
+    ExecutionStack-->>Server: Task uid
+    Server-->>-Frontend: Returns task uid
+    loop Running
+        Kernel->>Shared Document: Add output
+        Shared Document->>Frontend: Document update
+    end
+    loop While status is 202
+        Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+        Server->>ExecutionStack: Get task result
+        ExecutionStack-->>Server: null
+        Server-->>-Frontend: Request status 202
+    end
+    Kernel-->>ExecutionStack: Execution reply
+    deactivate Kernel
+    Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+    Server->>ExecutionStack: Get task result
+    ExecutionStack-->>Server: Result
+    Server-->>-Frontend: Status 200 & result
+```
+
+### With input case
+
+Execution of a Python code snippet: `input("Age:")`
+
+```mermaid
+sequenceDiagram
+    Frontend->>+Server: POST /api/kernels/<id>/execute
+    Server->>+ExecutionStack: Queue request
+    ExecutionStack->>Kernel: Execute request msg
+    activate Kernel
+    ExecutionStack-->>Server: Task uid
+    Server-->>-Frontend: Returns task uid
+    loop Running
+        Kernel->>Shared Document: Add output
+        Shared Document->>Frontend: Document update
+    end
+    loop While status is 202
+        Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+        Server->>ExecutionStack: Get task result
+        ExecutionStack-->>Server: null
+        Server-->>-Frontend: Request status 202
+    end
+    Kernel->>ExecutionStack: Set pending input
+    Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+    Server->>ExecutionStack: Get task result
+    ExecutionStack-->>Server: Pending input
+    Server-->>-Frontend: Status 300 & Pending input
+    Frontend->>+Server: POST /api/kernels/<id>/input
+    Server->>Kernel: Send input msg
+    Server-->>-Frontend: Returns
+    loop While status is 202
+        Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+        Server->>ExecutionStack: Get task result
+        ExecutionStack-->>Server: null
+        Server-->>-Frontend: Request status 202
+    end
+    Kernel-->>ExecutionStack: Execution reply
+    deactivate Kernel
+    Frontend->>+Server: GET /api/kernels/<id>/requests/<uid>
+    Server->>ExecutionStack: Get task result
+    ExecutionStack-->>Server: Result
+    Server-->>-Frontend: Status 200 & result
+```
+
+> \[!NOTE\]
+> The code snippet is always send in the body of the POST `/api/kernels/<id>/execute`
+> request to avoid document model discrepancy; the document on the backend is only
+> eventually identical with the frontends (document updates are not instantaneous).
+>
+> The `ExecutionStack` maintains an execution queue per kernels to ensure execution
+> order.
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the jupyter_server_nbmodel directory
+# Install package in development mode
+pip install -e ".[test]"
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Server extension must be manually installed in develop mode
+jupyter server extension enable jupyter_server_nbmodel
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab --autoreload
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+# Server extension must be manually disabled in develop mode
+jupyter server extension disable jupyter_server_nbmodel
+pip uninstall jupyter_server_nbmodel
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `jupyter-server-nbmodel` within that folder.
+
+### Testing the extension
+
+#### Server tests
+
+This extension is using [Pytest](https://docs.pytest.org/) for Python code testing.
+
+Install test dependencies (needed only once):
+
+```sh
+pip install -e ".[test]"
+# Each time you install the Python package, you need to restore the front-end extension link
+jupyter labextension develop . --overwrite
+```
+
+To execute them, run:
+
+```sh
+pytest -vv -r ap --cov jupyter_server_nbmodel
+```
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Manual testing
+
+```bash
+# Terminal 1.
+jupyter server --port 8888 --autoreload --ServerApp.disable_check_xsrf=True --IdentityProvider.token= --ServerApp.port_retries=0
+
+# Terminal 2.
+KERNEL=$(curl -X POST http://localhost:8888/api/kernels)
+echo $KERNEL
+KERNEL_ID=$(echo $KERNEL | jq --raw-output '.id')
+echo $KERNEL_ID
+REQUEST=$(curl --include http://localhost:8888/api/kernels/$KERNEL_ID/execute -d "{ \"code\": \"print('1+1')\" }")
+RESULT=$(echo $REQUEST | grep -i ^Location: | cut -d' ' -f2 | tr -d '\r')
+echo $RESULT
+
+curl http://localhost:8888$RESULT
+{"status": "ok", "execution_count": 1, "outputs": "[{\"output_type\": \"stream\", \"name\": \"stdout\", \"text\": \"1+1\\n\"}]"}
+```
+
+### Running Tests
+
+Install dependencies:
+
+```bash
+pip install -e ".[test]"
+```
+
+To run the python tests, use:
+
+```bash
+pytest
+
+# To test a specific file
+pytest jupyter_server_nbmodel/tests/test_handlers.py
+
+# To run a specific test
+pytest jupyter_server_nbmodel/tests/test_handlers.py -k "test_post_execute"
+```
+
+### Development uninstall
+
+```bash
+pip uninstall jupyter_server_nbmodel
+```
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)