Merge remote-tracking branch 'upstream/main'

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.1.2 2023 Nov 27
+
+- expose command `split-cell-to-gridwidth` to convert notebooks
+
 ## 0.1.1 2023 Nov 27
 
 - initial release

README.md

@@ -24,6 +24,15 @@ there is no button (yet) in this extension to do the equivalent of the former 's
 - or command `gridwidth:toggle-1-2`
 - that you can bind to a keyboard shortcut of your choice
 
+### to convert your notebooks
+
+```bash
+split-cell-to-gridwidth notebook1 .. notebookN
+```
+
+will replace the old `cell_style: split` with the new `gridwidth-1-2` tag in all
+notebooks passed as arguments
+
 ### palette commands
 
 - `gridwidth:toggle-1-2` and so on

jupyterlab_gridwidth/splitcell_to_gridwidth.py

@@ -0,0 +1,39 @@
+"""
+a command line tool for en masse migration of notebooks
+from the former classic notebook extension 'splitcell' to
+the new JupyterLab extension 'gridwidth'
+
+limitations: this assumes jupytext
+"""
+
+from argparse import ArgumentParser
+
+import jupytext
+
+
+def migrate_notebook(notebook):
+    print(f'migrating {notebook}')
+    with open(notebook, 'r') as f:
+        incoming = jupytext.read(f)
+    for cell in incoming['cells']:
+        if cell.get('metadata', {}).get('cell_style', None) == 'split':
+            del cell['metadata']['cell_style']
+            if 'tags' not in cell['metadata']:
+                cell['metadata']['tags'] = []
+            cell['metadata']['tags'].append('gridwidth-1-2')
+    # rewrite in same location
+    jupytext.write(incoming, notebook)
+
+
+def main():
+    parser = ArgumentParser(
+        description='migrate notebooks from (classic)-splitcell to (lab)-gridwidth')
+    parser.add_argument('notebooks', nargs='+', help='notebooks to migrate')
+    args = parser.parse_args()
+    for notebook in args.notebooks:
+        migrate_notebook(notebook)
+    return 0
+
+
+if __name__ == '__main__':
+    exit(main())

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyterlab-gridwidth",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Jlab extension for showing course levels and structure",
   "keywords": [
     "jupyter",

pyproject.toml

@@ -8,24 +8,16 @@ readme = "README.md"
 license = { file = "LICENSE" }
 requires-python = ">=3.8"
 classifiers = [
-    "Framework :: Jupyter",
-    "Framework :: Jupyter :: JupyterLab",
-    "Framework :: Jupyter :: JupyterLab :: 4",
-    "Framework :: Jupyter :: JupyterLab :: Extensions",
-    "Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt",
     "License :: OSI Approved :: BSD License",
-    "Programming Language :: Python",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-]
-dependencies = [
-    'jupyterlab-celltagsclasses',
+    "Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt",
 ]
+dependencies = ['jupyterlab-celltagsclasses']
 dynamic = ["version", "description", "authors", "urls", "keywords"]
 
+[project.scripts]
+splitcell-to-gridwidth = "jupyterlab_gridwidth.splitcell_to_gridwidth:main"
+
 [tool.hatch.version]
 source = "nodejs"
 
@@ -69,7 +61,7 @@ version_cmd = "hatch version"
 before-build-npm = [
     "python -m pip install 'jupyterlab>=4.0.0,<5'",
     "jlpm",
-    "jlpm build:prod"
+    "jlpm build:prod",
 ]
 before-build-python = ["jlpm clean:all"]