Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Jupyterlab GridStack #69

Merged
merged 173 commits into from
Dec 24, 2020
Merged

Conversation

jtpio
Copy link
Member

@jtpio jtpio commented Dec 15, 2020

Add the jupyterlab-gridstack extension from https://github.com/hbcarlos/voila-editor

TODO

  • Bring the original commits
  • Change outputDir to voila-gridstack/labextension
  • Check setup.py is still correct after the switch to jupyter-packaging
  • Add tests on CI to check both the classic and lab extensions are correctly installed
  • Keep the symlink of template data files?
  • Rename lab extension to @voila-dashboards/jupyterlab-gridstack
  • Update to the latest jupyter_server.pytest_plugin -> tracked in Update the tests to work with the latest jupyter server #70

hbcarlos and others added 30 commits September 1, 2020 11:04
Upgrade to the Lab 3 extension system
Temp pin jupyterlab_server in setup.py
Remove jupyter lab build step from binder
@jtpio
Copy link
Member Author

jtpio commented Dec 15, 2020

How about naming the JupyterLab Extension @voila-dashboards/jupyterlab-gridstack?

We know have the voila-dashboards organization on npm:

image

Similarly, we could rename @jupyter-voila/jupyterlab-preview to @voila-dashboards/jupyterlab-preview to stay consistent, and also so it matches the name of the org on GitHub.

@jtpio jtpio force-pushed the jupyterlab-gridstack branch from 43f86b5 to fd719a4 Compare December 15, 2020 16:08
@jtpio jtpio force-pushed the jupyterlab-gridstack branch from acb9f77 to 89a316f Compare December 15, 2020 17:00
'ipykernel',
'jupyter_server~=1.0.1',
Copy link
Member Author

@jtpio jtpio Dec 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sticking to this for now since a recent version of jupyter_server changed the names of some pytest fixtures.

@jtpio jtpio force-pushed the jupyterlab-gridstack branch from 2d77aa3 to 6e07595 Compare December 15, 2020 19:41
@jtpio jtpio force-pushed the jupyterlab-gridstack branch from 6e07595 to e675923 Compare December 15, 2020 19:48
@jtpio
Copy link
Member Author

jtpio commented Dec 16, 2020

After a fresh install in a new environment:

$ jupyter labextension list
JupyterLab v3.0.0rc13
/home/jtp/miniforge3/envs/test/share/jupyter/labextensions
        @jupyter-widgets/jupyterlab-manager v3.0.0-alpha.2 enabled OK
        @voila-dashboards/jupyterlab-gridstack v0.1.0 enabled OK (python, voila-gridstack)

@voila-dashboards/jupyterlab-gridstack v0.1.0 enabled OK (python, voila-gridstack)

This comes from the install.json file that tells the user the @voila-dashboards/jupyterlab-gridstack extension was installed via the voila-gridstack python package.

base_develop_cmd = cmdclass['develop']


class DevelopCmd(base_develop_cmd):
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There might be a better way to handle this, so the symlinks to the template files are correctly created in development mode.

@jtpio
Copy link
Member Author

jtpio commented Dec 16, 2020

cc @hbcarlos @SylvainCorlay if you want to check it out.

This should be ready to go. jupyterlab_widgets is still in the list of install_requires (but not jupyterlab), so support for widgets in the editor works out of the box. This should also prevent the issue of a missing sharedPackages dependency if jupyterlab_widgets is not installed, but specified here:

"sharedPackages": {
"@jupyter-widgets/base": {
"bundled": false,
"singleton": true
},
"@jupyter-widgets/jupyterlab-manager": {
"bundled": false,
"singleton": true
}
}

Just opened #70 to track the remaining item:

Update to the latest jupyter_server.pytest_plugin

@jtpio jtpio marked this pull request as ready for review December 16, 2020 20:15
@hbcarlos
Copy link
Member

Just tried and works perfectly. Thanks Jeremy!

@jtpio
Copy link
Member Author

jtpio commented Dec 24, 2020

The last commit updates to the latest JupyterLab 3.0 final packages.

We should be able to merge this PR, and proceed with a release soon.

@jtpio jtpio merged commit 18ddf6f into voila-dashboards:master Dec 24, 2020
@jtpio jtpio deleted the jupyterlab-gridstack branch December 24, 2020 14:45
@jtpio
Copy link
Member Author

jtpio commented Dec 24, 2020

We should be able to merge this PR, and proceed with a release soon.

Opened #72 to track this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants