Update for jupyterlab3 - switch to pip install (federated) #19

ianhi · 2020-12-11T03:53:20Z

Updates for jlab3. I took the opportunity to switch this over to the new style "federated" extensions that eliminate the need for a build step. A consequence of this is that a pypi package will need to be released and that the method for loading the vim keymap switched from importing it to calling the ensureVimKeymap function (more details in commit message).

I also applied the recommended tsconfig, eslint, and prettier settings from the upgrade script and then linted in a separate commit.

Closes: #14

Installing now
If anyone is realllllllly wanting this extension for jlab3 prior this being merged then you're in luck @axelfahy has uploaded this PR to pypi and you can install like so

pip install jupyterlab-vim

Add a line to History.md briefly documenting the change.

If this is a release, additionally do the following:

Update the dependencies in package.json
Run jlpm install to update yarn.lock

ianhi · 2020-12-11T03:53:56Z

README.md


-* JupyterLab 2.0
+```bash
+pip install ????????????


I don't know what name this will end up with on pypi so ??? for now.

I think either jupyterlab_vim or jupyterlab-vim. - seems to be more used than _ for package names. But I don't think it is a good idea to have the npm package with a _ and the pypi package with a -. Either we keep the underscore or we change for - everywhere? What do you think?

I like consistency everywhere. Also if you name the python package with an _ than you still pip install using -, I guess pip just substitutes them.

I didn't know about the substitution, then it might be easier to go with jupyterlab_vim.

ianhi · 2020-12-11T03:59:37Z

CI fails but I can confirm that the extension works.

axelfahy

Thank you very much for the update to jupyterlab3! Once we decide on the package name, I will publish this to pypi. But I think we should wait until the release of the final jupyterlab3 version to merge in order to keep compatibility with jupyterlab2 until the stable release of jupyterlab3.

axelfahy · 2020-12-11T09:45:32Z

package.json

+    "clean:lib": "rimraf lib tsconfig.tsbuildinfo",
+    "clean:labextension": "rimraf jupyterlab_vim/labextension",
+    "clean:all": "jlpm run clean:lib && jlpm run clean:labextension",
+    "eslint": "eslint . --ext .ts,.tsx --fix",


I think the build is failing in the pull request because it does not find lint. We need to change lint to eslint in .github/workflows/pull-request.yml.

👍

also we need to ensure that jupyterlab 3 is being installed that's what is causing the build to fail

ianhi · 2020-12-12T03:41:46Z

But I think we should wait until the release of the final jupyterlab3 version to merge in order to keep compatibility with jupyterlab2 until the stable release of jupyterlab3.

Totally agree, but I knew how to do this and to avoid the gotcha of not knowing about ensureVimKeymap so I just wanted to make this public sooner rather than later.

Once we decide on the package name, I will publish this to pypi.

Two things here if it ends up with a name like jupyterlab-vim:

@jwkvam should have an input (or ability to say "please don't")
Given that this is a pretty general name would you be open to giving a few other people write access/pypi access so the project is robust against any one person no longer being involved. (i.e. safegaurd against the jlab2 switch nightmare)?
- Though if jlab-vim makes it's way into core in 3.1 this would be less of an issue.

axelfahy · 2020-12-14T07:59:04Z

2\. Given that this is a pretty general name would you be open to giving a few other people write access/pypi access so the project is robust against any one person no longer being involved. (i.e. safegaurd against the jlab2 switch nightmare)?

Sure, I can set multiple maintainers for the pip repository.

* Though if jlab-vim makes it's way into core in 3.1 this would be less of an issue.

That would be the best solution IMHO, I hope it will be in core in the 3.1 version.

Two things here if it ends up with a name like jupyterlab-vim:
1. @jwkvam should have an input (or ability to say "please don't")

So let's stick with jupyterlab_vim?

following https://jupyterlab.readthedocs.io/en/latest/developer/extension_migration_2_3.html By making the extension pip installable (federated) the way to access codemirror is a bit different as the extension is no longer included in the jupyterlab build step. So we use the `ensureVimKeymap` function on the ICodeMirror interface. This ensures that the codemirror used by jupyterlab has loaded it's vim bindings. We then access that codemirror via the ICodeMirror interface.

Set eslint and prettier to the defaults in the extension cookiecutter during the upgrade, this applies them to index.ts.

ianhi · 2020-12-14T17:53:01Z

I wonder what was so bad about nodejs 13? weird.

ianhi · 2020-12-14T17:55:12Z

Looking at this more carefully: the build.yml workflow actually does everything that the pull-request action does already so maybe just delete the old pull-request script and rename the build one?

ianhi · 2020-12-14T17:56:23Z

Also, we can set up automated releases to pypi - though the version I know how to use requires you to bump the version manually then you create a release using the github interface. Thoughts on disabling the automated version bumper and switching to script that publishes to both pypi and npm?

axelfahy · 2020-12-14T18:02:58Z

Also, we can set up automated releases to pypi - though the version I know how to use requires you to bump the version manually then you create a release using the github interface. Thoughts on disabling the automated version bumper and switching to script that publishes to both pypi and npm?

For Python, I know versioneer, that uses the tag of the commit. But we can bump it manually, there will probably not be many versions.

ianhi · 2020-12-14T18:07:28Z

Actually it seems that the single source of truth for versioning is contained in the package.json. _version.py just reads that file to get the version. So The automated version bump should still work, though it will need to be modified to also push to pypi

axelfahy · 2020-12-15T08:33:02Z

though it will need to be modified to also push to pypi

Yes, definitely. In the meantime, I pushed the package from this branch to pypi (https://pypi.org/project/jupyterlab-vim/). An hyphen was set instead of the underscore on the Pypi page, probably because the main folder has one, even if the package name has undescore (jupyterlab_vim-0.13.0-py3-none-any.whl). I sent you an invite for the pypi project, so you can push new versions as well.

ianhi · 2020-12-15T16:51:46Z

Yes, definitely. In the meantime, I pushed the package from this branch to pypi (https://pypi.org/project/jupyterlab-vim/)

Nice! I'll edit my first post to reflect this.

I sent you an invite for the pypi project, so you can push new versions as well.

Awesome thanks. Though hopefully I'll never have to make use of that ability.

ianhi · 2020-12-15T16:54:47Z

.github/workflows/pypipublish.yml

+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel
+      - name: Build package
+        run: |
+        python setup.py sdist bdist_wheel


I think this will break right now as I'm pretty sure that the build step will still require using nodejs.

The jupyterlab-git version is probably good to base this off of https://github.com/jupyterlab/jupyterlab-git/blob/master/.github/workflows/publish.yml

ianhi · 2020-12-30T04:18:38Z

Hey @axelfahy heads up that jlab3 has been released now. Is there anything more we need to do here?

axelfahy · 2021-01-04T10:31:12Z

Hey @axelfahy heads up that jlab3 has been released now. Is there anything more we need to do here?

I don't think so, I will merge. Thank you!

ianhi commented Dec 11, 2020

View reviewed changes

ianhi mentioned this pull request Dec 11, 2020

Jupyterlab 3 #14

Closed

axelfahy reviewed Dec 11, 2020

View reviewed changes

ianhi added 3 commits December 14, 2020 12:00

appease eslint and prettier

910be90

Set eslint and prettier to the defaults in the extension cookiecutter during the upgrade, this applies them to index.ts.

Update History.md

4d63bc9

ianhi force-pushed the jlab3 branch from 7a14cb6 to 4d63bc9 Compare December 14, 2020 17:01

axelfahy and others added 2 commits December 14, 2020 18:26

Update node version in build.yml

718a2ed

Fix linter script for PR action

2798c8e

Add action to publish package to PyPi

6c52d30

ianhi commented Dec 15, 2020

View reviewed changes

ianhi mentioned this pull request Dec 30, 2020

Update plugin to work with JupyterLab 3.0 #22

Closed

axelfahy added 6 commits January 4, 2021 10:43

Update pypipublish.yml

e0f0a3f

Update build.yml

4bc5aa1

Update pyproject.toml

c670a61

Update setup.py

38373d7

Update pull-request.yml

78ab853

Update pull-request.yml

34e502f

axelfahy merged commit 344809c into jupyterlab-contrib:master Jan 4, 2021

ianhi deleted the jlab3 branch January 4, 2021 15:07

krassowski mentioned this pull request Oct 8, 2023

Correct license classifier in pyproject.toml #122

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update for jupyterlab3 - switch to pip install (federated) #19

Update for jupyterlab3 - switch to pip install (federated) #19

ianhi commented Dec 11, 2020 •

edited

ianhi Dec 11, 2020

axelfahy Dec 11, 2020 •

edited

ianhi Dec 12, 2020

axelfahy Dec 14, 2020

ianhi Dec 14, 2020

ianhi commented Dec 11, 2020

axelfahy left a comment

axelfahy Dec 11, 2020

ianhi Dec 12, 2020

ianhi commented Dec 12, 2020 •

edited

axelfahy commented Dec 14, 2020

ianhi commented Dec 14, 2020

ianhi commented Dec 14, 2020

ianhi commented Dec 14, 2020

axelfahy commented Dec 14, 2020

ianhi commented Dec 14, 2020

axelfahy commented Dec 15, 2020 •

edited

ianhi commented Dec 15, 2020

ianhi Dec 15, 2020

ianhi commented Dec 30, 2020

axelfahy commented Jan 4, 2021

Update for jupyterlab3 - switch to pip install (federated) #19

Update for jupyterlab3 - switch to pip install (federated) #19

Conversation

ianhi commented Dec 11, 2020 • edited

ianhi Dec 11, 2020

Choose a reason for hiding this comment

axelfahy Dec 11, 2020 • edited

Choose a reason for hiding this comment

ianhi Dec 12, 2020

Choose a reason for hiding this comment

axelfahy Dec 14, 2020

Choose a reason for hiding this comment

ianhi Dec 14, 2020

Choose a reason for hiding this comment

ianhi commented Dec 11, 2020

axelfahy left a comment

Choose a reason for hiding this comment

axelfahy Dec 11, 2020

Choose a reason for hiding this comment

ianhi Dec 12, 2020

Choose a reason for hiding this comment

ianhi commented Dec 12, 2020 • edited

axelfahy commented Dec 14, 2020

ianhi commented Dec 14, 2020

ianhi commented Dec 14, 2020

ianhi commented Dec 14, 2020

axelfahy commented Dec 14, 2020

ianhi commented Dec 14, 2020

axelfahy commented Dec 15, 2020 • edited

ianhi commented Dec 15, 2020

ianhi Dec 15, 2020

Choose a reason for hiding this comment

ianhi commented Dec 30, 2020

axelfahy commented Jan 4, 2021

ianhi commented Dec 11, 2020 •

edited

axelfahy Dec 11, 2020 •

edited

ianhi commented Dec 12, 2020 •

edited

axelfahy commented Dec 15, 2020 •

edited