gennaker-tools 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. gennaker_tools-0.1.3/.copier-answers.yml +14 -0
  2. gennaker_tools-0.1.3/.gitignore +121 -0
  3. gennaker_tools-0.1.3/.prettierignore +6 -0
  4. gennaker_tools-0.1.3/.yarnrc.yml +1 -0
  5. gennaker_tools-0.1.3/CHANGELOG.md +67 -0
  6. gennaker_tools-0.1.3/LICENSE +29 -0
  7. gennaker_tools-0.1.3/PKG-INFO +178 -0
  8. gennaker_tools-0.1.3/README.md +119 -0
  9. gennaker_tools-0.1.3/RELEASE.md +80 -0
  10. gennaker_tools-0.1.3/flake.lock +61 -0
  11. gennaker_tools-0.1.3/flake.nix +76 -0
  12. gennaker_tools-0.1.3/gennaker_tools/__init__.py +26 -0
  13. gennaker_tools-0.1.3/gennaker_tools/_version.py +4 -0
  14. gennaker_tools-0.1.3/gennaker_tools/labextension/package.json +198 -0
  15. gennaker_tools-0.1.3/gennaker_tools/labextension/schemas/gennaker-tools/package.json.orig +193 -0
  16. gennaker_tools-0.1.3/gennaker_tools/labextension/schemas/gennaker-tools/stateless-run.json +17 -0
  17. gennaker_tools-0.1.3/gennaker_tools/labextension/static/509.289abdc89cdc2da51b88.js +1 -0
  18. gennaker_tools-0.1.3/gennaker_tools/labextension/static/728.c3ac4b62173ea8b3c44b.js +1 -0
  19. gennaker_tools-0.1.3/gennaker_tools/labextension/static/747.28975bdde163d0eaf6e0.js +1 -0
  20. gennaker_tools-0.1.3/gennaker_tools/labextension/static/remoteEntry.3e78bb25784889ba8b31.js +1 -0
  21. gennaker_tools-0.1.3/gennaker_tools/labextension/static/style.js +4 -0
  22. gennaker_tools-0.1.3/gennaker_tools/labextension/static/third-party-licenses.json +22 -0
  23. gennaker_tools-0.1.3/gennaker_tools/settings_sync_extension.py +132 -0
  24. gennaker_tools-0.1.3/install.json +5 -0
  25. gennaker_tools-0.1.3/jupyter-config/jupyter_server_config.d/gennaker_tools.json +7 -0
  26. gennaker_tools-0.1.3/package.json +193 -0
  27. gennaker_tools-0.1.3/pyproject.toml +85 -0
  28. gennaker_tools-0.1.3/renovate.json5 +57 -0
  29. gennaker_tools-0.1.3/schema/stateless-run.json +17 -0
  30. gennaker_tools-0.1.3/setup.py +1 -0
  31. gennaker_tools-0.1.3/src/index.ts +199 -0
  32. gennaker_tools-0.1.3/style/base.css +5 -0
  33. gennaker_tools-0.1.3/style/index.css +1 -0
  34. gennaker_tools-0.1.3/style/index.js +1 -0
  35. gennaker_tools-0.1.3/tsconfig.json +26 -0
  36. gennaker_tools-0.1.3/yarn.lock +6457 -0
@@ -0,0 +1,14 @@
1
+ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
2
+ _commit: v4.4.0
3
+ _src_path: https://github.com/jupyterlab/extension-template
4
+ author_email: angus@oieltd.com
5
+ author_name: Angus
6
+ has_binder: false
7
+ has_settings: false
8
+ kind: frontend
9
+ labextension_name: myextension
10
+ project_short_description: A JupyterLab extension.
11
+ python_name: myextension
12
+ repository: ''
13
+ test: false
14
+
@@ -0,0 +1,121 @@
1
+ *.bundle.*
2
+ lib/
3
+ node_modules/
4
+ *.log
5
+ .eslintcache
6
+ .stylelintcache
7
+ *.egg-info/
8
+ .ipynb_checkpoints
9
+ *.tsbuildinfo
10
+ gennaker_tools/labextension
11
+ # Version file is handled by hatchling
12
+ gennaker_tools/_version.py
13
+
14
+ # Created by https://www.gitignore.io/api/python
15
+ # Edit at https://www.gitignore.io/?templates=python
16
+
17
+ ### Python ###
18
+ # Byte-compiled / optimized / DLL files
19
+ __pycache__/
20
+ *.py[cod]
21
+ *$py.class
22
+
23
+ # C extensions
24
+ *.so
25
+
26
+ # Distribution / packaging
27
+ .Python
28
+ build/
29
+ develop-eggs/
30
+ dist/
31
+ downloads/
32
+ eggs/
33
+ .eggs/
34
+ lib/
35
+ lib64/
36
+ parts/
37
+ sdist/
38
+ var/
39
+ wheels/
40
+ pip-wheel-metadata/
41
+ share/python-wheels/
42
+ .installed.cfg
43
+ *.egg
44
+ MANIFEST
45
+
46
+ # PyInstaller
47
+ # Usually these files are written by a python script from a template
48
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
49
+ *.manifest
50
+ *.spec
51
+
52
+ # Installer logs
53
+ pip-log.txt
54
+ pip-delete-this-directory.txt
55
+
56
+ # Unit test / coverage reports
57
+ htmlcov/
58
+ .tox/
59
+ .nox/
60
+ .coverage
61
+ .coverage.*
62
+ .cache
63
+ nosetests.xml
64
+ coverage/
65
+ coverage.xml
66
+ *.cover
67
+ .hypothesis/
68
+ .pytest_cache/
69
+
70
+ # Translations
71
+ *.mo
72
+ *.pot
73
+
74
+ # Scrapy stuff:
75
+ .scrapy
76
+
77
+ # Sphinx documentation
78
+ docs/_build/
79
+
80
+ # PyBuilder
81
+ target/
82
+
83
+ # pyenv
84
+ .python-version
85
+
86
+ # celery beat schedule file
87
+ celerybeat-schedule
88
+
89
+ # SageMath parsed files
90
+ *.sage.py
91
+
92
+ # Spyder project settings
93
+ .spyderproject
94
+ .spyproject
95
+
96
+ # Rope project settings
97
+ .ropeproject
98
+
99
+ # Mr Developer
100
+ .mr.developer.cfg
101
+ .project
102
+ .pydevproject
103
+
104
+ # mkdocs documentation
105
+ /site
106
+
107
+ # mypy
108
+ .mypy_cache/
109
+ .dmypy.json
110
+ dmypy.json
111
+
112
+ # Pyre type checker
113
+ .pyre/
114
+
115
+ # End of https://www.gitignore.io/api/python
116
+
117
+ # OSX files
118
+ .DS_Store
119
+
120
+ # Yarn cache
121
+ .yarn/
@@ -0,0 +1,6 @@
1
+ node_modules
2
+ **/node_modules
3
+ **/lib
4
+ **/package.json
5
+ !/package.json
6
+ myextension
@@ -0,0 +1 @@
1
+ nodeLinker: node-modules
@@ -0,0 +1,67 @@
1
+ # Changelog
2
+
3
+ <!-- <START NEW CHANGELOG ENTRY> -->
4
+
5
+ ## 0.1.3
6
+
7
+ ([Full Changelog](https://github.com/agoose77/gennaker-tools/compare/c2dd80b54b1294fd7c581c9f1ca9241b02338093...3c9e5e267bd3b2d002290e79e9949a370bdeac79))
8
+
9
+ ### Maintenance and upkeep improvements
10
+
11
+ - deps: Update gha to v6 (major) [#12](https://github.com/agoose77/gennaker-tools/pull/12) ([@renovate](https://github.com/renovate))
12
+ - deps: Update dependency python to v3.14.1 [#11](https://github.com/agoose77/gennaker-tools/pull/11) ([@renovate](https://github.com/renovate))
13
+ - deps: Update gha (major) [#6](https://github.com/agoose77/gennaker-tools/pull/6) ([@renovate](https://github.com/renovate))
14
+ - deps: Update dependency python to v3.14.0 [#5](https://github.com/agoose77/gennaker-tools/pull/5) ([@renovate](https://github.com/renovate))
15
+
16
+ ### Other merged PRs
17
+
18
+ - Fix: more release fixes [#14](https://github.com/agoose77/gennaker-tools/pull/14) ([@agoose77](https://github.com/agoose77))
19
+ - fix: release workflow [#13](https://github.com/agoose77/gennaker-tools/pull/13) ([@agoose77](https://github.com/agoose77))
20
+ - Fix: cleanup exit logic, and guard reconciliation loop [#10](https://github.com/agoose77/gennaker-tools/pull/10) ([@agoose77](https://github.com/agoose77))
21
+ - Feat: add support for CodeMirror snippets [#9](https://github.com/agoose77/gennaker-tools/pull/9) ([@agoose77](https://github.com/agoose77))
22
+ - Feat: add TOML settings synchronisation. [#8](https://github.com/agoose77/gennaker-tools/pull/8) ([@agoose77](https://github.com/agoose77))
23
+
24
+ ### Contributors to this release
25
+
26
+ ([GitHub contributors page for this release](https://github.com/agoose77/gennaker-tools/graphs/contributors?from=2025-07-24&to=2025-12-23&type=c))
27
+
28
+ [@agoose77](https://github.com/search?q=repo%3Aagoose77%2Fgennaker-tools+involves%3Aagoose77+updated%3A2025-07-24..2025-12-23&type=Issues) | [@renovate](https://github.com/search?q=repo%3Aagoose77%2Fgennaker-tools+involves%3Arenovate+updated%3A2025-07-24..2025-12-23&type=Issues)
29
+
30
+ <!-- <END NEW CHANGELOG ENTRY> -->
31
+
32
+ ## 0.1.2
33
+
34
+ ([Full Changelog](https://github.com/agoose77/gennaker-tools/compare/v0.1.1...b7c19f098d01aced82088abd2524a0f3b1377b04))
35
+
36
+ ### Merged PRs
37
+
38
+ - fix: release workflow [#13](https://github.com/agoose77/gennaker-tools/pull/13) ([@agoose77](https://github.com/agoose77))
39
+
40
+ ### Contributors to this release
41
+
42
+ ([GitHub contributors page for this release](https://github.com/agoose77/gennaker-tools/graphs/contributors?from=2025-12-23&to=2025-12-23&type=c))
43
+
44
+ [@agoose77](https://github.com/search?q=repo%3Aagoose77%2Fgennaker-tools+involves%3Aagoose77+updated%3A2025-12-23..2025-12-23&type=Issues)
45
+
46
+ ## 0.1.1
47
+
48
+ ([Full Changelog](https://github.com/agoose77/gennaker-tools/compare/c2dd80b54b1294fd7c581c9f1ca9241b02338093...9ac2a1e40a03fbd9745d36bdac84bbd72bfedcc4))
49
+
50
+ ### Maintenance and upkeep improvements
51
+
52
+ - deps: Update gha to v6 (major) [#12](https://github.com/agoose77/gennaker-tools/pull/12) ([@renovate](https://github.com/renovate))
53
+ - deps: Update dependency python to v3.14.1 [#11](https://github.com/agoose77/gennaker-tools/pull/11) ([@renovate](https://github.com/renovate))
54
+ - deps: Update gha (major) [#6](https://github.com/agoose77/gennaker-tools/pull/6) ([@renovate](https://github.com/renovate))
55
+ - deps: Update dependency python to v3.14.0 [#5](https://github.com/agoose77/gennaker-tools/pull/5) ([@renovate](https://github.com/renovate))
56
+
57
+ ### Other merged PRs
58
+
59
+ - Fix: cleanup exit logic, and guard reconciliation loop [#10](https://github.com/agoose77/gennaker-tools/pull/10) ([@agoose77](https://github.com/agoose77))
60
+ - Feat: add support for CodeMirror snippets [#9](https://github.com/agoose77/gennaker-tools/pull/9) ([@agoose77](https://github.com/agoose77))
61
+ - Feat: add TOML settings synchronisation. [#8](https://github.com/agoose77/gennaker-tools/pull/8) ([@agoose77](https://github.com/agoose77))
62
+
63
+ ### Contributors to this release
64
+
65
+ ([GitHub contributors page for this release](https://github.com/agoose77/gennaker-tools/graphs/contributors?from=2025-07-24&to=2025-12-23&type=c))
66
+
67
+ [@agoose77](https://github.com/search?q=repo%3Aagoose77%2Fgennaker-tools+involves%3Aagoose77+updated%3A2025-07-24..2025-12-23&type=Issues) | [@renovate](https://github.com/search?q=repo%3Aagoose77%2Fgennaker-tools+involves%3Arenovate+updated%3A2025-07-24..2025-12-23&type=Issues)
@@ -0,0 +1,29 @@
1
+ BSD 3-Clause License
2
+
3
+ Copyright (c) 2025, Angus
4
+ All rights reserved.
5
+
6
+ Redistribution and use in source and binary forms, with or without
7
+ modification, are permitted provided that the following conditions are met:
8
+
9
+ 1. Redistributions of source code must retain the above copyright notice, this
10
+ list of conditions and the following disclaimer.
11
+
12
+ 2. Redistributions in binary form must reproduce the above copyright notice,
13
+ this list of conditions and the following disclaimer in the documentation
14
+ and/or other materials provided with the distribution.
15
+
16
+ 3. Neither the name of the copyright holder nor the names of its
17
+ contributors may be used to endorse or promote products derived from
18
+ this software without specific prior written permission.
19
+
20
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,178 @@
1
+ Metadata-Version: 2.4
2
+ Name: gennaker-tools
3
+ Version: 0.1.3
4
+ Summary: A JupyterLab extension to provide a restart-and-run-to-selected command variant that clears non-executed cell outputs.
5
+ Project-URL: Homepage, https://github.com/agoose77/gennaker-tools
6
+ Project-URL: Bug Tracker, https://github.com/agoose77/gennaker-tools/issues
7
+ Project-URL: Repository, https://github.com/agoose77/gennaker-tools.git
8
+ Author-email: Angus <angus@oieltd.com>
9
+ License: BSD 3-Clause License
10
+
11
+ Copyright (c) 2025, Angus
12
+ All rights reserved.
13
+
14
+ Redistribution and use in source and binary forms, with or without
15
+ modification, are permitted provided that the following conditions are met:
16
+
17
+ 1. Redistributions of source code must retain the above copyright notice, this
18
+ list of conditions and the following disclaimer.
19
+
20
+ 2. Redistributions in binary form must reproduce the above copyright notice,
21
+ this list of conditions and the following disclaimer in the documentation
22
+ and/or other materials provided with the distribution.
23
+
24
+ 3. Neither the name of the copyright holder nor the names of its
25
+ contributors may be used to endorse or promote products derived from
26
+ this software without specific prior written permission.
27
+
28
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29
+ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
32
+ FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33
+ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34
+ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35
+ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36
+ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37
+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
+ License-File: LICENSE
39
+ Keywords: jupyter,jupyterlab,jupyterlab-extension
40
+ Classifier: Framework :: Jupyter
41
+ Classifier: Framework :: Jupyter :: JupyterLab
42
+ Classifier: Framework :: Jupyter :: JupyterLab :: 4
43
+ Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
44
+ Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
45
+ Classifier: License :: OSI Approved :: BSD License
46
+ Classifier: Programming Language :: Python
47
+ Classifier: Programming Language :: Python :: 3
48
+ Classifier: Programming Language :: Python :: 3.9
49
+ Classifier: Programming Language :: Python :: 3.10
50
+ Classifier: Programming Language :: Python :: 3.11
51
+ Classifier: Programming Language :: Python :: 3.12
52
+ Classifier: Programming Language :: Python :: 3.13
53
+ Requires-Python: >=3.9
54
+ Requires-Dist: aiofiles
55
+ Requires-Dist: tomli
56
+ Requires-Dist: tomli-w
57
+ Requires-Dist: watchfiles
58
+ Description-Content-Type: text/markdown
59
+
60
+ # gennaker-tools
61
+
62
+ [![Github Actions Status](https://github.com/agoose77/gennaker-tools/workflows/Build/badge.svg)](https://github.com/agoose77/gennaker-tools/actions/workflows/build.yml)
63
+
64
+ A series of JupyterLab and Jupyter Server extensions to power the gennaker project.
65
+
66
+ ## Features
67
+
68
+ ### TOML ←→ JSON Settings Sync
69
+
70
+ <img width="1130" height="900" alt="image" src="https://github.com/user-attachments/assets/c9babdd6-d247-45a1-a590-f17165f5b7fb" />
71
+
72
+ _Synchronise between JSON and TOML representations of settings under the JupyterLab settings path._
73
+
74
+ ## Code Snippets
75
+
76
+ <img width="1350" height="870" alt="image" src="https://github.com/user-attachments/assets/4e2673a9-3e27-4535-a3b0-b86e27f12f49" />
77
+
78
+ _Use CodeMirror snippets to autocomplete text and modular units of content._ See https://codemirror.net/docs/ref/#autocomplete.autocompletion for more information.
79
+
80
+ ## Reset Command
81
+
82
+ ```
83
+ gennaker-tools:reset-jupyterlab
84
+ ```
85
+
86
+ <img width="887" height="423" alt="image" src="https://github.com/user-attachments/assets/2ef028a5-0eca-45ab-81e1-f22627c427c1" />
87
+
88
+ _Reset the current session by reloading the page_.
89
+
90
+ ## Stateless Execution Command
91
+
92
+ ```
93
+ gennaker-tools:restart-run-stateless
94
+ ```
95
+
96
+ <img width="627" height="318" alt="image" src="https://github.com/user-attachments/assets/079684f8-e7bc-484f-b466-533f2dc1665e" />
97
+
98
+ _Perform some compute_
99
+
100
+ <img width="618" height="140" alt="image" src="https://github.com/user-attachments/assets/0029730a-e9ea-4791-8f61-a4ed0da783f8" />
101
+
102
+ _Modify the earlier state_
103
+
104
+ <img width="626" height="362" alt="image" src="https://github.com/user-attachments/assets/18ad2055-105e-461e-af36-5be4b4c7c51e" />
105
+
106
+ _Re-run up to a particular cell, and clear outputs_
107
+
108
+ ## Requirements
109
+
110
+ - JupyterLab >= 4.0.0
111
+
112
+ ## Install
113
+
114
+ To install the extension, execute:
115
+
116
+ ```bash
117
+ pip install gennaker-tools
118
+ ```
119
+
120
+ ## Uninstall
121
+
122
+ To remove the extension, execute:
123
+
124
+ ```bash
125
+ pip uninstall gennaker-tools
126
+ ```
127
+
128
+ ## Contributing
129
+
130
+ ### Development install
131
+
132
+ Note: You will need NodeJS to build the extension package.
133
+
134
+ The `jlpm` command is JupyterLab's pinned version of
135
+ [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
136
+ `yarn` or `npm` in lieu of `jlpm` below.
137
+
138
+ ```bash
139
+ # Clone the repo to your local environment
140
+ # Change directory to the gennaker_tools directory
141
+ # Install package in development mode
142
+ pip install -e "."
143
+ # Link your development version of the extension with JupyterLab
144
+ jupyter labextension develop . --overwrite
145
+ # Rebuild extension Typescript source after making changes
146
+ jlpm build
147
+ ```
148
+
149
+ 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.
150
+
151
+ ```bash
152
+ # Watch the source directory in one terminal, automatically rebuilding when needed
153
+ jlpm watch
154
+ # Run JupyterLab in another terminal
155
+ jupyter lab
156
+ ```
157
+
158
+ 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).
159
+
160
+ 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:
161
+
162
+ ```bash
163
+ jupyter lab build --minimize=False
164
+ ```
165
+
166
+ ### Development uninstall
167
+
168
+ ```bash
169
+ pip uninstall gennaker-tools
170
+ ```
171
+
172
+ In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
173
+ command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
174
+ folder is located. Then you can remove the symlink named `gennaker-tools` within that folder.
175
+
176
+ ### Packaging the extension
177
+
178
+ See [RELEASE](RELEASE.md)
@@ -0,0 +1,119 @@
1
+ # gennaker-tools
2
+
3
+ [![Github Actions Status](https://github.com/agoose77/gennaker-tools/workflows/Build/badge.svg)](https://github.com/agoose77/gennaker-tools/actions/workflows/build.yml)
4
+
5
+ A series of JupyterLab and Jupyter Server extensions to power the gennaker project.
6
+
7
+ ## Features
8
+
9
+ ### TOML ←→ JSON Settings Sync
10
+
11
+ <img width="1130" height="900" alt="image" src="https://github.com/user-attachments/assets/c9babdd6-d247-45a1-a590-f17165f5b7fb" />
12
+
13
+ _Synchronise between JSON and TOML representations of settings under the JupyterLab settings path._
14
+
15
+ ## Code Snippets
16
+
17
+ <img width="1350" height="870" alt="image" src="https://github.com/user-attachments/assets/4e2673a9-3e27-4535-a3b0-b86e27f12f49" />
18
+
19
+ _Use CodeMirror snippets to autocomplete text and modular units of content._ See https://codemirror.net/docs/ref/#autocomplete.autocompletion for more information.
20
+
21
+ ## Reset Command
22
+
23
+ ```
24
+ gennaker-tools:reset-jupyterlab
25
+ ```
26
+
27
+ <img width="887" height="423" alt="image" src="https://github.com/user-attachments/assets/2ef028a5-0eca-45ab-81e1-f22627c427c1" />
28
+
29
+ _Reset the current session by reloading the page_.
30
+
31
+ ## Stateless Execution Command
32
+
33
+ ```
34
+ gennaker-tools:restart-run-stateless
35
+ ```
36
+
37
+ <img width="627" height="318" alt="image" src="https://github.com/user-attachments/assets/079684f8-e7bc-484f-b466-533f2dc1665e" />
38
+
39
+ _Perform some compute_
40
+
41
+ <img width="618" height="140" alt="image" src="https://github.com/user-attachments/assets/0029730a-e9ea-4791-8f61-a4ed0da783f8" />
42
+
43
+ _Modify the earlier state_
44
+
45
+ <img width="626" height="362" alt="image" src="https://github.com/user-attachments/assets/18ad2055-105e-461e-af36-5be4b4c7c51e" />
46
+
47
+ _Re-run up to a particular cell, and clear outputs_
48
+
49
+ ## Requirements
50
+
51
+ - JupyterLab >= 4.0.0
52
+
53
+ ## Install
54
+
55
+ To install the extension, execute:
56
+
57
+ ```bash
58
+ pip install gennaker-tools
59
+ ```
60
+
61
+ ## Uninstall
62
+
63
+ To remove the extension, execute:
64
+
65
+ ```bash
66
+ pip uninstall gennaker-tools
67
+ ```
68
+
69
+ ## Contributing
70
+
71
+ ### Development install
72
+
73
+ Note: You will need NodeJS to build the extension package.
74
+
75
+ The `jlpm` command is JupyterLab's pinned version of
76
+ [yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
77
+ `yarn` or `npm` in lieu of `jlpm` below.
78
+
79
+ ```bash
80
+ # Clone the repo to your local environment
81
+ # Change directory to the gennaker_tools directory
82
+ # Install package in development mode
83
+ pip install -e "."
84
+ # Link your development version of the extension with JupyterLab
85
+ jupyter labextension develop . --overwrite
86
+ # Rebuild extension Typescript source after making changes
87
+ jlpm build
88
+ ```
89
+
90
+ 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.
91
+
92
+ ```bash
93
+ # Watch the source directory in one terminal, automatically rebuilding when needed
94
+ jlpm watch
95
+ # Run JupyterLab in another terminal
96
+ jupyter lab
97
+ ```
98
+
99
+ 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).
100
+
101
+ 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:
102
+
103
+ ```bash
104
+ jupyter lab build --minimize=False
105
+ ```
106
+
107
+ ### Development uninstall
108
+
109
+ ```bash
110
+ pip uninstall gennaker-tools
111
+ ```
112
+
113
+ In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
114
+ command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
115
+ folder is located. Then you can remove the symlink named `gennaker-tools` within that folder.
116
+
117
+ ### Packaging the extension
118
+
119
+ See [RELEASE](RELEASE.md)
@@ -0,0 +1,80 @@
1
+ # Making a new release of gennaker-tools
2
+
3
+ The extension can be published to `PyPI` and `npm` manually or using the [Jupyter Releaser](https://github.com/jupyter-server/jupyter_releaser).
4
+
5
+ ## Manual release
6
+
7
+ ### Python package
8
+
9
+ This extension can be distributed as Python packages. All of the Python
10
+ packaging instructions are in the `pyproject.toml` file to wrap your extension in a
11
+ Python package. Before generating a package, you first need to install some tools:
12
+
13
+ ```bash
14
+ pip install build twine hatch
15
+ ```
16
+
17
+ Bump the version using `hatch`. By default this will create a tag.
18
+ See the docs on [hatch-nodejs-version](https://github.com/agoose77/hatch-nodejs-version#semver) for details.
19
+
20
+ ```bash
21
+ hatch version <new-version>
22
+ ```
23
+
24
+ Make sure to clean up all the development files before building the package:
25
+
26
+ ```bash
27
+ jlpm clean:all
28
+ ```
29
+
30
+ You could also clean up the local git repository:
31
+
32
+ ```bash
33
+ git clean -dfX
34
+ ```
35
+
36
+ To create a Python source package (`.tar.gz`) and the binary package (`.whl`) in the `dist/` directory, do:
37
+
38
+ ```bash
39
+ python -m build
40
+ ```
41
+
42
+ > `python setup.py sdist bdist_wheel` is deprecated and will not work for this package.
43
+
44
+ Then to upload the package to PyPI, do:
45
+
46
+ ```bash
47
+ twine upload dist/*
48
+ ```
49
+
50
+ ### NPM package
51
+
52
+ To publish the frontend part of the extension as a NPM package, do:
53
+
54
+ ```bash
55
+ npm login
56
+ npm publish --access public
57
+ ```
58
+
59
+ ## Automated releases with the Jupyter Releaser
60
+
61
+ The extension repository should already be compatible with the Jupyter Releaser. But
62
+ the GitHub repository and the package managers need to be properly set up. Please
63
+ follow the instructions of the Jupyter Releaser [checklist](https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html).
64
+
65
+ Here is a summary of the steps to cut a new release:
66
+
67
+ - Go to the Actions panel
68
+ - Run the "Step 1: Prep Release" workflow
69
+ - Check the draft changelog
70
+ - Run the "Step 2: Publish Release" workflow
71
+
72
+ > [!NOTE]
73
+ > Check out the [workflow documentation](https://jupyter-releaser.readthedocs.io/en/latest/get_started/making_release_from_repo.html)
74
+ > for more information.
75
+
76
+ ## Publishing to `conda-forge`
77
+
78
+ 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
79
+
80
+ Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.
@@ -0,0 +1,61 @@
1
+ {
2
+ "nodes": {
3
+ "flake-utils": {
4
+ "inputs": {
5
+ "systems": "systems"
6
+ },
7
+ "locked": {
8
+ "lastModified": 1731533236,
9
+ "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
10
+ "owner": "numtide",
11
+ "repo": "flake-utils",
12
+ "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
13
+ "type": "github"
14
+ },
15
+ "original": {
16
+ "owner": "numtide",
17
+ "repo": "flake-utils",
18
+ "type": "github"
19
+ }
20
+ },
21
+ "nixpkgs": {
22
+ "locked": {
23
+ "lastModified": 1763421233,
24
+ "narHash": "sha256-Stk9ZYRkGrnnpyJ4eqt9eQtdFWRRIvMxpNRf4sIegnw=",
25
+ "owner": "NixOS",
26
+ "repo": "nixpkgs",
27
+ "rev": "89c2b2330e733d6cdb5eae7b899326930c2c0648",
28
+ "type": "github"
29
+ },
30
+ "original": {
31
+ "owner": "NixOS",
32
+ "ref": "nixos-unstable",
33
+ "repo": "nixpkgs",
34
+ "type": "github"
35
+ }
36
+ },
37
+ "root": {
38
+ "inputs": {
39
+ "flake-utils": "flake-utils",
40
+ "nixpkgs": "nixpkgs"
41
+ }
42
+ },
43
+ "systems": {
44
+ "locked": {
45
+ "lastModified": 1681028828,
46
+ "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
47
+ "owner": "nix-systems",
48
+ "repo": "default",
49
+ "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
50
+ "type": "github"
51
+ },
52
+ "original": {
53
+ "owner": "nix-systems",
54
+ "repo": "default",
55
+ "type": "github"
56
+ }
57
+ }
58
+ },
59
+ "root": "root",
60
+ "version": 7
61
+ }