Skip to content

Commit

Permalink
add pkg to provide alternate wheels (can remove once functionality is…
Browse files Browse the repository at this point in the history
… supported).
  • Loading branch information
Alan Fleming committed Sep 18, 2024
1 parent 7af3317 commit 9b8e122
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 7 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@
### Enhancements made

- Upgraded to provide asynchronous bi-directional comms for performing operations
in the Frontend. Each operation returns a task that when complete returns the response or raise an error if unsuccessful.
- On the Python side `JupyterFrontEnd`, `CommandRegistry`, & `CommandPalette`
are all derived from `AsyncWidgetBase` and are now single instance objects.
in the Frontend. Each operation returns a task that when complete returns the
response or raise an error if unsuccessful.
- On the Python side `JupyterFrontEnd` is derived from `AsyncWidgetBase` and is now a singleton per kernel.
- On the JavaScript frontend side `JupyterFrontendModel`, `CommandRegistryModel`,
`CommandPalletModel`, extend the new `IpylabModel`.
- `Connections` provides a link from Python to an object in the Frontend.

### Added

Expand All @@ -26,7 +27,7 @@
### Removed

- Callback functionality
- Drop Python < 3.11
- Drop Python < 3.10
- Drop Jupyterlab < 4.0
- Drop IpyWidgets < 8.1.0

Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ Or with `mamba` / `conda`:
mamba install -c conda-forge ipylab
```


## Running the examples locally

To try out the examples locally, the recommended way is to create a new environment with the dependencies:
Expand All @@ -88,11 +89,16 @@ jupyter lab

```bash
# create a new conda environment
mamba create -n ipylab -c conda-forge jupyter-packaging nodejs python=3.10 -y
mamba create -n ipylab -c conda-forge nodejs python=3.10 -y

# activate the environment
conda activate ipylab

# Install a patched version of ipwidgets & jupyterlab_widgets from local wheels to provide 'per-kernel-widget-manager'.
# combines: https://github.com/jupyter-widgets/ipywidgets/pull/3922 & https://github.com/jupyter-widgets/ipywidgets/pull/3921

pip install pkg/*.whl --force-reinstall

# install the Python package
pip install -e ".[dev]"

Expand All @@ -101,7 +107,7 @@ jupyter labextension develop . --overwrite

# compile the extension
jlpm clean
jlpm && jlpm build
jlpm build

# pre-commit (optional)
pip install pre-commit
Expand Down
2 changes: 1 addition & 1 deletion docs/jupyter_lite_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"PipliteAddon": {
"piplite_urls": [
"../dist",
"https://files.pythonhosted.org/packages/py3/i/ipywidgets/ipywidgets-8.1.2-py3-none-any.whl"
"../pkg"
]
}
}
Binary file added pkg/ipywidgets-8.1.5-py3-none-any.whl
Binary file not shown.
Binary file added pkg/jupyterlab_widgets-3.0.13-py3-none-any.whl
Binary file not shown.
Binary file added pkg/widgetsnbextension-4.0.13-py3-none-any.whl
Binary file not shown.

0 comments on commit 9b8e122

Please sign in to comment.