working version in lab4

Author: darpan097

binder/environment.yml

@@ -1,4 +1,4 @@
-# a mybinder.org-ready environment for demoing jupyterlab_snippets
+# a mybinder.org-ready environment for demoing jupyterlab-snippets
 # this environment may also be used locally on Linux/MacOS/Windows, e.g.
 #
 #   conda env update --file binder/environment.yml
@@ -18,4 +18,4 @@ dependencies:
   - pip
   - wheel
   # additional packages for demos
-  # - ipywidgets
+  # - ipywidgets

binder/postBuild

@@ -1,5 +1,5 @@
 #!/usr/bin/env python3
-""" perform a development install of jupyterlab_snippets
+""" perform a development install of jupyterlab-snippets
 
     On Binder, this will run _after_ the environment has been fully created from
     the environment.yml in this directory.
@@ -52,5 +52,5 @@ _("jupyter", "server", "extension", "list")
 _("jupyter", "labextension", "list")
 
 
-print("JupyterLab with jupyterlab_snippets is ready to run with:\n")
+print("JupyterLab with jupyterlab-snippets is ready to run with:\n")
 print("\tjupyter lab\n")

jupyterlab_snippets/__init__.py

@@ -1,19 +1,21 @@
-import json
-from pathlib import Path
-
-from ._version import __version__
+try:
+    from ._version import __version__
+except ImportError:
+    # Fallback when using the package in dev mode without installing
+    # in editable mode with pip. It is highly recommended to install
+    # the package from a stable release or in editable mode: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
+    import warnings
+    warnings.warn("Importing 'jupyterlab_snippets' outside a proper installation.")
+    __version__ = "dev"
 from .handlers import setup_handlers
 from .loader import SnippetsLoader
 
-HERE = Path(__file__).parent.resolve()
-
-with (HERE / "labextension" / "package.json").open() as fid:
-    data = json.load(fid)
-
 
 def _jupyter_labextension_paths():
-    return [{"src": "labextension", "dest": data["name"]}]
-
+    return [{
+        "src": "labextension",
+        "dest": "jupyterlab_snippets"
+    }]
 
 def _jupyter_server_extension_points():
     return [{"module": "jupyterlab_snippets"}]

jupyterlab_snippets/_version.py

@@ -212,4 +212,4 @@
       "value-no-vendor-prefix": null
     }
   }
-}
+}

package.json

@@ -2,6 +2,8 @@ import { URLExt } from '@jupyterlab/coreutils';
 
 import { ServerConnection } from '@jupyterlab/services';
 
+// Ref: https://github.com/jupyterlab/extension-examples/blob/main/server-extension/src/handler.ts
+
 /**
  * Call the API extension
  *
@@ -15,11 +17,7 @@ export async function requestAPI<T>(
 ): Promise<T> {
   // Make request to Jupyter API
   const settings = ServerConnection.makeSettings();
-  const requestUrl = URLExt.join(
-    settings.baseUrl,
-    'jupyterlab-snippets', // API Namespace
-    endPoint
-  );
+  const requestUrl = URLExt.join(settings.baseUrl, 'snippets', endPoint);
 
   let response: Response;
   try {

src/handler.ts

@@ -34,7 +34,7 @@ namespace CommandIDs {
 type Tree = Map<string, Tree>;
 
 /**
- * Convert the list of snippets a tree.
+ * Convert the list of snippets to a tree.
  * @param snippets The list of snippets.
  */
 function toTree(snippets: Snippet[]) {
@@ -45,7 +45,7 @@ function toTree(snippets: Snippet[]) {
       if (!node.has(part)) {
         node.set(part, new Map<string, Tree>());
       }
-      node = node.get(part);
+      node = node.get(part)!;
     });
   });
   return tree;
@@ -92,6 +92,8 @@ const extension: JupyterFrontEndPlugin<void> = {
     menu: IMainMenu | null,
     notebookTracker: INotebookTracker | null
   ) => {
+    console.log('JupyterLab extension jupyterlab-snippets is activated!');
+
     const { commands } = app;
 
     const isEnabled = () => {
@@ -122,11 +124,11 @@ const extension: JupyterFrontEndPlugin<void> = {
           return;
         }
 
-        const current = notebookTracker.currentWidget;
-        const notebook = current.content;
+        const current = notebookTracker!.currentWidget;
+        const notebook = current!.content;
         NotebookActions.insertBelow(notebook);
         const activeCell = notebook.activeCell;
-        activeCell.model.value.text = content;
+        activeCell!.model.sharedModel.setSource(content);
       },
       isEnabled
     });

src/index.ts

@@ -1,6 +1,4 @@
-import { URLExt } from '@jupyterlab/coreutils';
-
-import { ServerConnection } from '@jupyterlab/services';
+import { requestAPI } from './handler';
 
 /**
  * The type for a Snippet.
@@ -32,33 +30,3 @@ export async function fetchSnippet(snippet: Snippet): Promise<ISnippetContent> {
   };
   return requestAPI<ISnippetContent>('get', request);
 }
-
-/**
- * Call the API extension
- *
- * @param endPoint API REST end point for the extension
- * @param init Initial values for the request
- * @returns The response body interpreted as JSON
- */
-async function requestAPI<T>(
-  endPoint = '',
-  init: RequestInit = {}
-): Promise<T> {
-  const settings = ServerConnection.makeSettings();
-  const requestUrl = URLExt.join(settings.baseUrl, 'snippets', endPoint);
-
-  let response: Response;
-  try {
-    response = await ServerConnection.makeRequest(requestUrl, init, settings);
-  } catch (error) {
-    throw new ServerConnection.NetworkError(error);
-  }
-
-  const data = await response.json();
-
-  if (!response.ok) {
-    throw new ServerConnection.ResponseError(response, data.message);
-  }
-
-  return data;
-}

src/snippets.ts

@@ -0,0 +1,5 @@
+/*
+    See the JupyterLab Developer Guide for useful CSS Patterns:
+
+    https://jupyterlab.readthedocs.io/en/stable/developer/css.html
+*/