Upgrade topbar extensions to JupyterLab 4 #92

mahendrapaipuri · 2023-06-23T12:46:03Z

This PR primarily works towards upgrading the topbar extensions to JupyterLab 4 using the default topbar extension provided by JupyterLab.
Relevant topbar extensions, jupyterlab-topbar-text, jupyterlab-logout, jupyterlab-theme-toggler, jupyterlab-system-monitor are moved into a monorepo to ease the maintenance burden
Repo organisation has been inspired from jupyter-renderers
GitHub workflows have been modernised to use jupyterlab-maintainer-tools actions.

Closes #81

jtpio · 2023-06-24T09:02:12Z

Nice thanks @mahendrapaipuri for working on this!

jtpio · 2023-06-24T09:02:38Z

.stylelintcache

Looks like this file can be added to the .gitignore

Yeah, totally. Cheers for pointing it out!!

jtpio · 2023-06-24T09:04:02Z

README.md

- [jupyterlab-logout](https://github.com/jupyterlab-contrib/jupyterlab-logout): add a "Log Out" button
- [jupyterlab-theme-toggle](https://github.com/jtpio/jupyterlab-theme-toggle): switch between the Light and Dark themes
+- [jupyterlab-topbar-text](./packages/topbar-text-extension): add and edit custom text
+- [jupyterlab-system-monitor](./packages/system-monitor-extension): show system metrics (memory usage)


For jupyterlab-system-monitor either we include it here, or maybe directly in jupyter-resource-usage? jupyter-server/jupyter-resource-usage#191

I agree that it makes more sense to move it over to jupyter-resource-usage as users can install everything at once. I will work on that!!

that would be great, thanks!

For reference there is a PR to update jupyter-resource-usage to JupyterLab 4: jupyter-server/jupyter-resource-usage#195, that could be finished before jupyter-server/jupyter-resource-usage#191.

Or update to JupyterLab 4 directly as part of jupyter-server/jupyter-resource-usage#191.

@jtpio How do we organise the jupyter-resource-usage? Should I wait for you to finish your PR and then add the lab extension package?

I'll have very low bandwidth over the next 2 weeks so if you want to take over and finish the lab 4 PR that would be greatly appreciated. Thanks!

Sure, I can do that. Are you going to add me as a collaborator or should I start a new PR with your branch as base?

jtpio · 2023-06-27T06:13:57Z

packages/theme-toggler-extension/jupyterlab-theme-toggler/_version.py

+# This file is auto-generated by Hatchling. As such, do not:
+#   - modify
+#   - track in version control e.g. be sure to add to .gitignore
+__version__ = VERSION = '1.0.0'


+1 for going with 1.0.0 for all these extensions 👍

And _version.py must be ignored as well. Will fix these soon.

Will add this extension to the jupyter-resource-usage repo. See #195, #191 in jupyter-resource-usage

Remove _version.py files from VCS. Hatchling will handle them directly.

jtpio · 2023-07-17T06:56:12Z

Thanks again @mahendrapaipuri for working on this.

I updated the repo settings so the CI should run when new changes are pushed, to reduce friction.

Mistakenly we were using coreutils 4.0.0 which made topbar-text extension outdated

mahendrapaipuri · 2023-07-18T10:27:00Z

@jtpio Fixed issues with CI. This PR is good to go for the review.

I dont have an awful lot of experience with GitHub workflows. I tried to modernise the actual CI workflows without changing the way the packages are being tested. If you think, we can improve/optimize the existing workflows, please let me know.

jtpio · 2023-07-18T14:12:22Z

packages/logout-extension/src/index.ts

+    // Get app commands
+    const { commands } = app;
+
+    const namespace = 'topbarcmds';


For consistency with other third-party extensions, should we rename the namespace to jupyterlab-logout?

Suggested change

const namespace = 'topbarcmds';

const namespace = 'jupyterlab-logout';

What do you think about jupyterlab-topbar as namespace? It will still be project specific namespace and we will be able to use same namespace for any future buttons we will add to topbar.

That could indeed work, unless we consider all these extensions as independent and the first part of the command (namespace) to correspond to the name of the extension.

jtpio · 2023-07-18T14:13:08Z

packages/logout-extension/src/index.ts

+
+import '../style/index.css';
+
+const logoutPluginId = '@jupyterlab/logout-extension:plugin';


Since this is not an official extension, maybe the following name would be more appropriate?

Suggested change

const logoutPluginId = '@jupyterlab/logout-extension:plugin';

const logoutPluginId = 'jupyterlab-logout-extension:plugin';

For consistency we could then do the same with the other extensions in this repo / diff.

Fair enough. I thought this convention was put in-place when extensions were distributed as npm packages to put all official extensions under one umbrella namespace. As this is not the case anymore, I thought we could use this convention so that all extensions will be installed at same location for the end users.

Anyways, I will change the names for all extensions.

Remove badges from README of packages Remove references to jupyterlab-resource-monitor in README. Add a note that the package can be installed from jupyter-resource-usage Add postBuild file for binder

Change extension names from @jupyterlab-* to jupyterlab-* to avoid clashing with official extensions Use jupyterlab-topbar as command namespace for logout extension

jtpio · 2023-07-19T16:21:33Z

packages/logout-extension/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "jupyterlab-logout-extension",


Should the npm name keep the -extension suffix? Or just be jupyterlab-logout like the current name on npm? https://www.npmjs.com/package/jupyterlab-logout

Just so that when we make a release later with this change we still publish to the same package on npm.

jtpio · 2023-07-19T16:23:35Z

packages/theme-toggler-extension/package.json

@@ -0,0 +1,87 @@
+{
+  "name": "jupyterlab-theme-toggler-extension",


Similar comment as above, maybe we should stick to jupyterlab-theme-toggle for now?

https://www.npmjs.com/package/jupyterlab-theme-toggle

jtpio · 2023-07-19T16:27:33Z

Thanks @mahendrapaipuri for your work on this 👍

I left a few more comments about how to name the npm packages. Looks like the PR should be good to go. We could also merge and iterate in follow-up PRs.

One thing to check in a separate PR would be to add support for the Jupyter Releaser so we can automate the publishing of all the Python packages (and npm) in the monorepo.

mahendrapaipuri · 2023-07-20T08:00:53Z

Happy to contribute and thanks to you too @jtpio for helping me out.

Addressed all your PR comments. Yes, I think we can add support for releaser in a separate PR.

I see that you merged #195 that adds JLab 4 support for jupyter-resource-usage. I will put up a PR with jupyterlab-resource-usage extension added to that project.

jtpio

Thanks!

This looks good to go. As mentioned in the comments we'll have to check how to setup the versioning of the extensions so releases can be made with the Jupyter Releaser.

jtpio · 2023-07-24T07:43:41Z

I see that you merged #195 that adds JLab 4 support for jupyter-resource-usage. I will put up a PR with jupyterlab-resource-usage extension added to that project.

Yes that would be great, thanks!

mahendrapaipuri added 16 commits June 23, 2023 11:56

Add logout extension package

a530d6a

Add theme toggler extension package

a4cb0c2

Ignore and remove labextension files

00e2e01

Add system monitor package

55631b0

Add topbar text package

ff187f6

Remove obselete files

3f0aec9

Add linters configs

16778ba

Update package.json and yarn.lock

345552f

Update gitignore files

7b7098a

Attempt to modernise github workflows

1eb8ce1

Update README

fa967b6

Add rootdir for eslint config

d5a7b54

Add .yarnrc.yml file for each package

5d7b830

Update gitignore for all packages

40d79e7

Fix errors in workflow files

cf9e3da

Lint source code

5ed5a8e

jtpio added the enhancement New feature or request label Jun 24, 2023

jtpio reviewed Jun 24, 2023

View reviewed changes

mahendrapaipuri marked this pull request as draft June 25, 2023 09:00

jtpio reviewed Jun 27, 2023

View reviewed changes

jtpio mentioned this pull request Jun 27, 2023

Archive the repository jtpio/jupyterlab-theme-toggle#23

Closed

mahendrapaipuri added 3 commits June 27, 2023 13:54

Remove system-monitor extension

c3a772e

Will add this extension to the jupyter-resource-usage repo. See #195, #191 in jupyter-resource-usage

Update gitignore files

bb6f02f

Remove _version.py files from VCS. Hatchling will handle them directly.

Attempt to fix errors in CI

66e0f7a

mahendrapaipuri marked this pull request as ready for review June 27, 2023 15:37

Setup matrix vars in CI to give extension name

2cd9251

Bump coreutils to 6.0.0

9054780

Mistakenly we were using coreutils 4.0.0 which made topbar-text extension outdated

Attempt to fix packaging workflow

46c7cdb

jtpio reviewed Jul 18, 2023

View reviewed changes

mahendrapaipuri added 3 commits July 19, 2023 10:06

Move CI and binder badges to README in root

9833272

Remove badges from README of packages Remove references to jupyterlab-resource-monitor in README. Add a note that the package can be installed from jupyter-resource-usage Add postBuild file for binder

Make linter happy

fe2bda2

Address PR comments

7e41578

Change extension names from @jupyterlab-* to jupyterlab-* to avoid clashing with official extensions Use jupyterlab-topbar as command namespace for logout extension

mahendrapaipuri mentioned this pull request Jul 19, 2023

Extension Compatibility with JupyterLab 4.0 jupyterlab/jupyterlab#14590

Open

jtpio reviewed Jul 19, 2023

View reviewed changes

Remove extension suffix from package names

06e51fa

Remove extension suffix from names in CI tests

78085e5

jtpio approved these changes Jul 24, 2023

View reviewed changes

jtpio merged commit 33be88b into jupyterlab-contrib:main Jul 24, 2023
12 checks passed

jtpio mentioned this pull request Jul 25, 2023

Option to remove separator lines #68

Closed

mahendrapaipuri deleted the upgrade_to_jl4 branch September 26, 2023 07:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Upgrade topbar extensions to JupyterLab 4 #92

Upgrade topbar extensions to JupyterLab 4 #92

mahendrapaipuri commented Jun 23, 2023

jtpio commented Jun 24, 2023

jtpio Jun 24, 2023

mahendrapaipuri Jun 25, 2023

jtpio Jun 24, 2023

mahendrapaipuri Jun 25, 2023

jtpio Jun 26, 2023

jtpio Jun 27, 2023

mahendrapaipuri Jun 28, 2023

jtpio Jun 28, 2023

mahendrapaipuri Jun 29, 2023

jtpio Jun 27, 2023

mahendrapaipuri Jun 27, 2023

jtpio commented Jul 17, 2023

mahendrapaipuri commented Jul 18, 2023

jtpio Jul 18, 2023

mahendrapaipuri Jul 19, 2023

jtpio Jul 19, 2023

jtpio Jul 18, 2023

jtpio Jul 18, 2023

mahendrapaipuri Jul 18, 2023

jtpio Jul 19, 2023

jtpio Jul 19, 2023

jtpio Jul 19, 2023

jtpio commented Jul 19, 2023

mahendrapaipuri commented Jul 20, 2023

jtpio left a comment

jtpio commented Jul 24, 2023

	const namespace = 'topbarcmds';
	const namespace = 'jupyterlab-logout';


		import '../style/index.css';

		const logoutPluginId = '@jupyterlab/logout-extension:plugin';

	const logoutPluginId = '@jupyterlab/logout-extension:plugin';
	const logoutPluginId = 'jupyterlab-logout-extension:plugin';

		@@ -0,0 +1,87 @@
		{
		"name": "jupyterlab-theme-toggler-extension",

Upgrade topbar extensions to JupyterLab 4 #92

Upgrade topbar extensions to JupyterLab 4 #92

Conversation

mahendrapaipuri commented Jun 23, 2023

jtpio commented Jun 24, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtpio commented Jul 17, 2023

mahendrapaipuri commented Jul 18, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jtpio commented Jul 19, 2023

mahendrapaipuri commented Jul 20, 2023

jtpio left a comment

Choose a reason for hiding this comment

jtpio commented Jul 24, 2023