nodpy 0.1.3__tar.gz

nodpy-0.1.3/.copier-answers.yml

@@ -0,0 +1,15 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.5.2
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: erawn65@gmail.com
+author_name: Eric Rawn
+has_ai_rules: false
+has_binder: true
+has_settings: true
+kind: frontend-and-server
+labextension_name: nodjs
+project_short_description: A JupyterLab extension.
+python_name: nodpy
+repository: ''
+test: true
+

nodpy-0.1.3/.gitignore

@@ -0,0 +1,140 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+nodpy/labextension
+# Version file is handled by hatchling
+nodpy/_version.py
+**/*.ipynb
+# 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 ###
+# Virtual environments
+.venv
+
+# 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
+
+# Yarn cache
+.yarn/
+
+test*.py
+nod/_version.py
+tsconfig.tsbuildinfo
+comp.txt
+.fileid.db
+nod/_version.py
+tsconfig.tsbuildinfo
+.nod/**
+.nod
+tsconfig.tsbuildinfo
+yarn.lock

nodpy-0.1.3/.prettierignore

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

nodpy-0.1.3/.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "python.analysis.typeCheckingMode": "standard",
+  "python.analysis.autoImportCompletions": false
+}

nodpy-0.1.3/.yarnrc.yml

@@ -0,0 +1,2 @@
+nodeLinker: node-modules
+enableScripts: false

nodpy-0.1.3/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->

nodpy-0.1.3/CONTRIBUTING.md

@@ -0,0 +1,96 @@
+## 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 nodpy directory
+
+# Set up a virtual environment and install package in development mode
+python -m venv .venv
+source .venv/bin/activate
+pip install --editable ".[dev,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 nodpy
+
+# Rebuild extension Typescript source after making changes
+# IMPORTANT: Unlike the steps above which are performed only once, do this step
+# every time you make a change.
+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
+```
+
+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 nodpy
+pip uninstall nodpy
+```
+
+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 `nodjs` 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 nodpy
+```
+
+#### 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.

nodpy-0.1.3/DEVELOPMENT.md

@@ -0,0 +1,116 @@
+# nod
+
+<!-- https://stackoverflow.com/questions/31382405/ipython-notebook-how-to-connect-to-existing-kernel?rq=3 -->
+
+404 GET /api/kernels/e9d194aa-bfbc-495d-8295-593039ab17e8/channels?session_id=6740bec7-2acd-4d6f-a6e2-33973306dfa4 (127.0.0.1): Kernel does not exist: e9d194aa-bfbc-495d-8295-593039ab17e8
+
+Session not found: session_id='2e3651ad-e58a-41ec-8b90-ce370cf3d153'
+
+NOTES:
+
+- old kernel 404's --- WORKSPACE FILE. HOW to fix?
+- just use Nod log to deep copy things, have no args capture all, args capture variables, and have a not=[] field to capture all but some. Restart shouldn't do anything different because it can't reset the whole stackframe, but you can just click back into a specific frame to reset the state. - this also gets you out of having to do the full-adult mode, because users can just nodlog the things they want to checkpoint and leave out a huge dataset which can't be copied but can be modified.
+  -how to do linked execution? when you select one nod.log, maybe the rest of the same nodlogs also light up with a button to do linked execution
+- how to mark globals? Can we do this somehow with just the structure of the program?
+- --existing flag and left hand pane to specify CWD VS specifying command directly from the panel?
+  - 1. is potentially less work but more clunky, also might be difficult to find the right path, and you get no feedback if it doesn't work. Maybe the --existing spits out a path string to paste into the frontend
+  - 2. might not be that hard to do if we can just specify the kernelspec command when we execute and that will work as expected. But I'm not thrilled about the idea of writing a terminal command in a plaintext window.
+
+NODCONFIG
+
+- add restart time to nodConfig
+- Add to NodConfig how the program should be restarted — (i.e. allowed to finish or interrupted, and if interrupted, with what signal). Obv smart defaults are our friend here.
+- format for notebook converstion with jupytext (light, percent, etc)
+- allow optional bypassing of readonly after edits?
+- if you want to test your program output after quit, you just gotta use the command line version
+
+TODO
+
+<!-- - make other frames read only after edit -->
+<!-- - add banner at the top on read only NBs  -->
+
+- test unlock
+- nod on exception https://ipython.readthedocs.io/en/stable/interactive/magics.html#magic-pdb
+- rename nb files to function--class
+- throw warning if spec not installed
+- Maybe have the current NOD Instance notebook be undeleteable and a different color?
+
+- JupyterHub Integration?
+  - paste CWD of JupyterLab for --existing?
+  - how to get CWD string to subprocess? Pass as env variable? yes this should work
+  - can we add as a CMD from the front end?
+  - or an --existing flag to the nod call, then we add the command to the connection file
+  - left hand pane that users can add CWD (or just specify the command to run directly from the pane?)
+  - how to get info from pane to kernel provisioner?
+  - if the python program is being run as a subprocess, we can set an enviornment variable for the connection directory
+  - print CWD on bottom pane to paste into existing arg
+    - problem with this is that we can't use existing provisioner architecture, bc the kernel doesn't own the subprocess
+    - but we probably want stdout in some way
+    - we can pipe the subprocess to the terminal? Can Jupyterhub people access the console?
+    - no they can't, but maybe stdout doesn't matter? people can debug their programs to hit the notebook call ahead of time? If theres a bug before notebook we're gonna have a problem anyways
+    - on the other hand, being able to continue with a program and see the output is cool
+- add exit without saving to menu
+- "continue" option now that the provisioner is handling the subprocess?
+- rename setting to "how_exit"?
+  - maybe we don't need this -- people can just send a "quit" manually if they want to continue the program
+
+Nice to have
+
+- persist lock through reload?
+- - clear old kernels from jupyter (get shutdown registering properly??)
+    - layoutrestorer, restorablepool
+- test timeouts to optimize (and on networked connections?)
+- play with opacity on the surrounding code?
+- mode to create function at call site?
+- mark cells above nod() call as run?
+- Change tracker --- which cells are unedited
+- Add check interface where it shows side by side
+  - final preview of exported code?
+- debug nod with nod!!
+  - need to specify the connection file directly in the cmd line args
+  - or just change the cwd in the outer command? aka nod cd folder && nod python -m module
+
+NOD Log Todo
+nod.log(x)
+
+- Nod log right sidebar
+- just deep copy it and put it in a dict
+- clicking on the side panel puts it in state
+- have a 'unique' boolean in nod.log() that doesn't save if it compares equal to another obj in the list
+
+Nod Save Args
+nod.save_args(f, [x,y,z])
+
+- Linked editing on all saved args
+- refuse to run if any free vars
+- can call from anywhere in the program
+- args must be deep copyable
+- group saved args by whether f is identical
+- user can just rewrite the function to have an inner pure func to call save_args on.
+- allow_globals flag?
+
+Nod log
+
+- Look for cycles in taint analysis
+- Fallback — compare outputs of each log session, if on forward eval they change, raise a big warning
+- Argument isn’t that we’re inventing map, or array programming, but that once we focus on how notebooks let us reify dynamic parts of our program, we can let you do things for free that would normally require totally rewriting your program (aka applying a statement on one variable to an array of values)
+  https://pyre-check.org/docs/pysa-basics/
+- maybe we just need forward eval, and log is nod.log(savevariables)
+  - problem with this is that we want the stack frame at the _beginning_ of the run, not the end.
+  - maybe its just the user's problem if they don't include something that matters in the function call?
+
+Stretch
+
+- Display variables for each call stack in green/red depending on whether they’re problematic, display warnings
+
+Decorator vs imbedded — decorator gives clear points for taint analysis, doesn’t let us leverage the user logic though.
+
+Inter-function, the sources and sinks are anything referenced in the body, and the sinks
+
+Will the taint analysis catch things like for loops tho? If not, this would be an argument to use a decorator instead
+
+<!-- - mode order -- 1. just do forward eval, 2. deep-copy for expensive programs, 3. adult-mode.
+    - how to switch modes? notebook() args?  -->
+<!-- - figure out why jupytext isn't respecting the kernelinfo metadata, so that we can restart the notebook without switching to normal python kernel
+    - alternatively, figure out how to switch the kernel always to python
+    - ok maybe its actually switching properly but restart has wiped the state  -->

nodpy-0.1.3/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Eric Rawn
+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.

nodpy-0.1.3/PKG-INFO

@@ -0,0 +1,98 @@
+Metadata-Version: 2.4
+Name: nodpy
+Version: 0.1.3
+Summary: A JupyterLab extension.
+Project-URL: Homepage, https://github.com/erawn/nod
+Project-URL: Bug Tracker, https://github.com/erawn/nod/issues
+Project-URL: Repository, https://github.com/erawn/nod
+Author-email: Eric Rawn <erawn65@gmail.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2026, Eric Rawn
+        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
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: ipykernel>=7.2.0
+Requires-Dist: jupyter-client>=8.8.0
+Requires-Dist: jupyter-server>=2.4.0
+Requires-Dist: jupyterlab>=4.5.6
+Requires-Dist: jupytext>=1.19.1
+Requires-Dist: libcst>=1.8.6
+Requires-Dist: nbformat>=5.10.4
+Requires-Dist: orjson>=3.11.7
+Requires-Dist: typer>=0.25.1
+Provides-Extra: dev
+Requires-Dist: jupyterlab>=4; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: pytest-jupyter[server]>=0.6.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# NOD: Notebook-On-Demand
+
+## Install
+
+```bash
+pip install nodpy
+```
+
+## Usage
+
+In a Python file call `notebook()` anywhere:
+
+```python
+#myfile.py
+from nodpy import notebook
+
+notebook()
+```
+
+then run the python program with nod <command>
+
+```bash
+nod python -m myfile
+```
+
+### NodConfig

nodpy-0.1.3/README.md

@@ -0,0 +1,26 @@
+# NOD: Notebook-On-Demand
+
+## Install
+
+```bash
+pip install nodpy
+```
+
+## Usage
+
+In a Python file call `notebook()` anywhere:
+
+```python
+#myfile.py
+from nodpy import notebook
+
+notebook()
+```
+
+then run the python program with nod <command>
+
+```bash
+nod python -m myfile
+```
+
+### NodConfig

nodpy-0.1.3/RELEASE.md

@@ -0,0 +1,80 @@
+# Making a new release of nodpy
+
+The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
+
+## Manual release
+
+### Python package
+
+This extension can be distributed as Python packages. All of the Python
+packaging instructions are in the `pyproject.toml` file to wrap your extension in a
+Python package. Before generating a package, you first need to install some tools:
+
+```bash
+pip install build twine hatch
+```
+
+Bump the version using `hatch`. By default this will create a tag.
+See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
+
+```bash
+hatch version <new-version>
+```
+
+Make sure to clean up all the development files before building the package:
+
+```bash
+jlpm clean:all
+```
+
+You could also clean up the local git repository:
+
+```bash
+git clean -dfX
+```
+
+To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
+
+```bash
+python -m build
+```
+
+> `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
+
+Then to upload the package to PyPI, do:
+
+```bash
+twine upload dist/*
+```
+
+### NPM package
+
+To publish the frontend part of the extension as a NPM package, do:
+
+```bash
+npm login
+npm publish --access public
+```
+
+## Automated releases with the Jupyter Releaser
+
+The extension repository should already be compatible with the Jupyter Releaser. But
+the GitHub repository and the package managers need to be properly set up. Please
+follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
+
+Here is a summary of the steps to cut a new release:
+
+- Go to the Actions panel
+- Run the "Step 1: Prep Release" workflow
+- Check the draft changelog
+- Run the "Step 2: Publish Release" workflow
+
+> [!NOTE]
+> Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
+> for more information.
+
+## Publishing to `conda-forge`
+
+If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html
+
+Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.

nodpy-0.1.3/babel.config.js

@@ -0,0 +1 @@
+module.exports = require('@jupyterlab/testutils/lib/babel.config');

nodpy-0.1.3/conftest.py

@@ -0,0 +1,8 @@
+import pytest
+
+pytest_plugins = ("pytest_jupyter.jupyter_server", )
+
+
+@pytest.fixture
+def jp_server_config(jp_server_config):
+    return {"ServerApp": {"jpserver_extensions": {"nodpy": True}}}

nodpy-0.1.3/install.json

@@ -0,0 +1,5 @@
+{
+  "packageManager": "python",
+  "packageName": "nodpy",
+  "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package nodpy"
+}

nodpy-0.1.3/jest.config.js

@@ -0,0 +1,28 @@
+const jestJupyterLab = require('@jupyterlab/testutils/lib/jest-config');
+
+const esModules = [
+  '@codemirror',
+  '@jupyter/ydoc',
+  '@jupyterlab/',
+  'lib0',
+  'nanoid',
+  'vscode-ws-jsonrpc',
+  'y-protocols',
+  'y-websocket',
+  'yjs'
+].join('|');
+
+const baseConfig = jestJupyterLab(__dirname);
+
+module.exports = {
+  ...baseConfig,
+  automock: false,
+  collectCoverageFrom: [
+    'src/**/*.{ts,tsx}',
+    '!src/**/*.d.ts',
+    '!src/**/.ipynb_checkpoints/*'
+  ],
+  coverageReporters: ['lcov', 'text'],
+  testRegex: 'src/.*/.*.spec.ts[x]?$',
+  transformIgnorePatterns: [`/node_modules/(?!${esModules}).+`]
+};

nodpy-0.1.3/jupyter-config/server-config/nodpy.json

@@ -0,0 +1,7 @@
+{
+  "ServerApp": {
+    "jpserver_extensions": {
+      "nodpy": true
+    }
+  }
+}