use latest widget template + upgrade idom

Author: rmorshea

.gitignore

@@ -1,4 +1,5 @@
 *.egg-info/
+.ipynb_checkpoints/
 dist/
 build/
 *.py[cod]
@@ -11,13 +12,6 @@ idom_jupyter/labextension/
 # OS X
 .DS_Store
 
-# Py Env
+# Python
 venv
-.python-version
-
-# VSCode
-.vscode
-
-# Jupyter
-.ipynb_checkpoints/
 Untitled*.ipynb

LICENSE

@@ -9,6 +9,7 @@ include idom-client-jupyter.json
 
 include LICENSE
 include setup.py
+include setup.cfg
 include pyproject.toml
 include install.json
 

MANIFEST.in

@@ -1,106 +1,28 @@
 # idom-jupyter
 
-A client for [IDOM](https://github.com/idom-team/idom) implemented using Jupyter widgets
+A client for IDOM implemented using Jupyter widgets
 
-## Try It Now!
+## Installation
 
-Check out a live example by clicking the badge below:
+To install use pip:
 
-<a href="https://mybinder.org/v2/gh/idom-team/idom-jupyter/main?filepath=notebooks%2Fintroduction.ipynb">
-    <img alt="Binder" height="25px" src="https://mybinder.org/badge_logo.svg" />
-</a>
-
-## Getting Started
-
-To install use `pip`:
-
-```
-pip install idom_jupyter
-```
-
-Then, before anything else, do one of the following:
-
-1. At the top of your notebook run
-
-   ```python
-   import idom_jupyter
-   ```
-
-2. Register `idom_jupyter` as a permanant IPython extension in [your config file](https://ipython.readthedocs.io/en/stable/config/intro.html#introduction-to-ipython-configuration):
-
-   ```python
-   c.InteractiveShellApp.extensions = [
-       'idom_jupyter'
-   ]
-   ```
-
-## Usage
-
-Once you're done [getting started](#getting-started), you can author and display IDOM
-layouts natively in your Jupyter Notebook:
-
-```python
-import idom
-
-@idom.component
-def ClickCount():
-    count, set_count = idom.hooks.use_state(0)
-    return idom.html.button(
-        {"onClick": lambda event: set_count(count + 1)},
-        [f"Click count: {count}"],
-    )
-
-ClickCount()
-```
-
-You can also turn an `idom` element constructor into one that returns an `ipywidget` with
-the `idom_juptyer.widgetize` function. This is useful if you wish to use IDOM in combination
-with other Jupyter Widgets as in the following example:
-
-```python
-ClickCountWidget = idom_jupyter.widgetize(ClickCount)
-ipywidgets.Box(
-    [
-        ClickCountWidget(),
-        ClickCountWidget(),
-    ]
-)
-```
-
-Alternatively just wrap an `idom` element instance in an `idom_jupyter.LayoutWidget`:
-
-```python
-ipywidgets.Box(
-    [
-        idom_jupyter.LayoutWidget(ClickCount()),
-        idom_jupyter.LayoutWidget(ClickCount()),
-    ]
-)
-```
-
-# Development Installation
+    $ pip install idom_jupyter
 
 For a development installation (requires [Node.js](https://nodejs.org) and [Yarn version 1](https://classic.yarnpkg.com/)),
 
-```
-git clone https://github.com/idom-team/idom-jupyter.git
-cd idom-jupyter
-pip install -e . -r requirements.txt
-jupyter nbextension install --py --symlink --overwrite --sys-prefix idom_jupyter
-jupyter nbextension enable --py --sys-prefix idom_jupyter
-```
+    $ git clone https://github.com/idom-team/idom-jupyter.git
+    $ cd idom-jupyter
+    $ pip install -e .
+    $ jupyter nbextension install --py --symlink --overwrite --sys-prefix idom_jupyter
+    $ jupyter nbextension enable --py --sys-prefix idom_jupyter
 
 When actively developing your extension for JupyterLab, run the command:
 
-```
-jupyter labextension develop --overwrite idom_jupyter
-```
+    $ jupyter labextension develop --overwrite idom_jupyter
 
 Then you need to rebuild the JS when you make a code change:
 
-```
-cd js
-yarn run build
-```
+    $ cd js
+    $ yarn run build
 
 You then need to refresh the JupyterLab page when your javascript changes.

README.md

@@ -1,25 +1,53 @@
-To release a new version of the idom-jupyter Python library on PyPI:
-
-- Update `_version.py` (set release version, remove 'dev')
-- git add the `_version.py` file and git commit
-- ```
-  python setup.py sdist bdist_wheel
-  twine upload dist/*
-  git tag -a X.X.X -m 'comment'
-  git add and git commit
-  git push
-  git push --tags
-  ```
-
-To release a new version of idom-client-jupyter on NPM:
-
-- Update `js/package.json` with new npm package version
-- Update the following attributes on your widget implementations in the Python and Javascript packages:
-  - `_view_module_version`
-  - `_model_module_version`
-- ```
-  # clean out the `dist` and `node_modules` directories
-  git clean -fdx
-  npm install
-  npm publish
-  ```
+# Release
+
+Before doing a release, check to see if there are any outstanding changes or untracked files:
+
+```
+git status
+git clean -fdxn
+```
+
+Commit changes, and make sure that any untracked files can be deleted. Then clean the repository:
+
+```
+git clean -fdx # actually delete untracked files
+```
+
+## Javascript release
+
+To release a new version of idom-client-jupyter on NPM, first register for an NPM account [here](https://www.npmjs.com/), then log in with `yarn login`. Then:
+
+1. Update `js/package.json` with the new npm package version
+2. Build and publish the npm package inside the `js/` directory:
+
+   ```
+   cd js/
+   yarn install
+   yarn publish
+   cd ..
+   ```
+
+## Python release
+
+To release a new version of idom_jupyter on PyPI, first make sure that the `build` package is installed: `pip install build`.
+
+1. Update `idom_jupyter/_version.py`:
+   - Update `__version__`
+   - Update `NPM_PACKAGE_RANGE` if necessary
+2. Commit changes to `_version.py` and tag the release
+   ```
+   git add idom_jupyter/_version.py
+   git tag -a X.X.X -m 'comment'
+   ```
+3. Generate Python packages and upload to PyPI:
+   ```
+   python -m build
+   twine check dist/*
+   twine upload dist/*
+   ```
+4. Update `_version.py` (add 'dev' and increment minor)
+   ```
+   git commit -a -m 'Back to dev'
+   git push
+   git push --tags
+   ```

RELEASE.md

@@ -2,4 +2,4 @@
   "packageManager": "python",
   "packageName": "idom_jupyter",
   "uninstallInstructions": "Use your Python package manager (pip, conda, etc.) to uninstall the package idom_jupyter"
-}
+}

jupyter-config/nbconfig/notebook.d/idom-client-jupyter.json renamed to idom-client-jupyter.json

@@ -0,0 +1,8 @@
+// In an AMD module, we set the public path using the magic requirejs 'module' dependency
+// See https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#module
+// Since 'module' is a requirejs magic module, we must include 'module' in the webpack externals configuration.
+import * as module from 'module';
+const url = new URL(module.uri, document.location)
+// Using lastIndexOf('/')+1 gives us the empty string if there is no '/', so pathname becomes '/'
+url.pathname = url.pathname.slice(0,url.pathname.lastIndexOf('/')+1);
+__webpack_public_path__ = `${url.origin}${url.pathname}`;

install.json

@@ -1,13 +1,6 @@
 // This file contains the javascript that is run when the notebook is loaded.
 // It contains some requirejs configuration and the `load_ipython_extension`
 // which is required for any notebook extension.
-//
-// Some static assets may be required by the custom widget javascript. The base
-// url for the notebook is not known at build time and is therefore computed
-// dynamically.
-__webpack_public_path__ =
-  document.querySelector("body").getAttribute("data-base-url") +
-  "nbextensions/idom-client-jupyter";
 
 // Configure requirejs
 if (window.require) {
@@ -20,7 +13,4 @@ if (window.require) {
   });
 }
 
-// Export the required load_ipython_extension
-module.exports = {
-  load_ipython_extension: function () {},
-};
+export function load_ipython_extension() {}