|
93 | 93 | "github_project_name []: ipyemail\n",
|
94 | 94 | "github_organization_name []: \n",
|
95 | 95 | "python_package_name [ipyemail]:\n",
|
96 |
| - "npm_package_name [ipyemail]:\n", |
| 96 | + "npm_package_name [ipyemail]: jupyter-email\n", |
97 | 97 | "npm_package_version [0.1.0]:\n",
|
98 | 98 | "project_short_description [A Custom Jupyter Widget Library]: An Custom Email Widget\n",
|
99 | 99 | "```\n",
|
|
124 | 124 | "\n",
|
125 | 125 | "You also need to enable the widget frontend extension.\n",
|
126 | 126 | "\n",
|
127 |
| - "If you are using JupyterLab:\n", |
| 127 | + "If you are using JupyterLab 2.x:\n", |
128 | 128 | "\n",
|
129 | 129 | "```bash\n",
|
130 | 130 | "# install the widget manager to display the widgets in JupyterLab\n",
|
|
134 | 134 | "jupyter labextension install .\n",
|
135 | 135 | "```\n",
|
136 | 136 | "\n",
|
137 |
| - "If you are using the classic notebook:\n", |
| 137 | + "If you are using the Classic Notebook:\n", |
138 | 138 | "\n",
|
139 | 139 | "```bash\n",
|
140 | 140 | "jupyter nbextension install --sys-prefix --symlink --overwrite --py ipyemail\n",
|
|
467 | 467 | }
|
468 | 468 | },
|
469 | 469 | "source": [
|
470 |
| - "## Test" |
| 470 | + "## Test\n", |
| 471 | + "\n", |
| 472 | + "First, run the following command to recreate the frontend bundle:\n", |
| 473 | + "\n", |
| 474 | + "```bash\n", |
| 475 | + "npm run build\n", |
| 476 | + "```\n", |
| 477 | + "\n", |
| 478 | + "If you use JupyterLab, you might want to use `jlpm` as the npm client. `jlpm` uses `yarn` under the hood as the package manager. The main difference compared to `npm` is that `jlpm` will generate a `yarn.lock` file for the dependencies, instead of `package-lock.json`. With `jlpm` the command is:\n", |
| 479 | + "\n", |
| 480 | + "\n", |
| 481 | + "```bash\n", |
| 482 | + "jlpm run build\n", |
| 483 | + "```" |
471 | 484 | ]
|
472 | 485 | },
|
473 | 486 | {
|
474 | 487 | "cell_type": "markdown",
|
475 | 488 | "metadata": {},
|
476 | 489 | "source": [
|
477 |
| - "You should be able to display your widget just like any other widget now:\n", |
| 490 | + "After reloading the page, you should be able to display your widget just like any other widget now:\n", |
478 | 491 | "\n",
|
479 | 492 | "```python\n",
|
480 | 493 | "from ipyemail import Email\n",
|
|
706 | 719 | "```"
|
707 | 720 | ]
|
708 | 721 | },
|
| 722 | + { |
| 723 | + "cell_type": "markdown", |
| 724 | + "metadata": {}, |
| 725 | + "source": [ |
| 726 | + "The end result should look like the following:\n", |
| 727 | + " \n", |
| 728 | + "" |
| 729 | + ] |
| 730 | + }, |
709 | 731 | {
|
710 | 732 | "cell_type": "markdown",
|
711 | 733 | "metadata": {},
|
|
0 commit comments