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 files for JupyterLite #45

Merged
merged 41 commits into from
Dec 6, 2022
Merged

Add files for JupyterLite #45

merged 41 commits into from
Dec 6, 2022

Conversation

jtpio
Copy link
Member

@jtpio jtpio commented Aug 5, 2022

Fixes #16

Start setting up ReadTheDocs so it can be used to easily demo the JupyterLab Plugin Playground with JupyterLite.

@jtpio jtpio closed this Aug 5, 2022
@jtpio jtpio reopened this Aug 5, 2022
@jtpio jtpio added the documentation Improvements or additions to documentation label Aug 5, 2022
@jtpio
Copy link
Member Author

jtpio commented Aug 10, 2022

Current state: the extension fails to load with the following error:

Error: Shared module @jupyterlab/debugger doesn't exist in shared scope default

image

This is likely because the extension expects @jupyterlab/debugger to be in the shared packages, but JupyterLite does not provide it (at least not yet for now).

@krassowski
Copy link
Member

I think that switching to lazy imports (await import wrapped in try expect) for built-in module loading could help here. Note to self: probably we should also ensure that the correct version of the package gets loaded by modifying the webpack config.

@krassowski
Copy link
Member

krassowski commented Nov 16, 2022

Of note, JupyterLab 3.6 4.0 will also break with the current version because:

Error: Shared module @jupyterlab/shared-models doesn't exist in shared scope default

@bollwyvl
Copy link

🔥
Screenshot from 2022-11-17 12-41-54

@bollwyvl
Copy link

I do note there is a delay in the launcher card appearing (especially noticeable on RTD): perhaps the command/shell-level stuff can be out in the plugin, with a _ready = new PromiseDelegate<void>() that blocks any use until ready.

@jtpio
Copy link
Member Author

jtpio commented Nov 17, 2022

I do note there is a delay in the launcher card appearing (especially noticeable on RTD)

Also noticed this on Binder while checking #47

@jtpio
Copy link
Member Author

jtpio commented Nov 17, 2022

Now looking good on RTD:

jupyterlite-playground.mp4

@jtpio jtpio marked this pull request as ready for review November 17, 2022 20:11
@jtpio
Copy link
Member Author

jtpio commented Nov 18, 2022

Should be good to go for a first version.

Planning to make a new release of jupyterlab-plugin-playground afterwards with #47 so it can be used in other JupyterLite deployments.

@jtpio jtpio requested review from krassowski and bollwyvl November 18, 2022 13:46
docs/index.md Outdated Show resolved Hide resolved
@@ -14,4 +14,4 @@ build_cmd = "build:prod"
npm = ["jlpm"]

[tool.check-manifest]
ignore = ["jupyterlab_plugin_playground/labextension/**", "yarn.lock", ".*", "package-lock.json", "scripts/**"]
ignore = ["docs/**", "jupyterlab_plugin_playground/labextension/**", "yarn.lock", ".*", "package-lock.json", "scripts/**"]

Choose a reason for hiding this comment

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

maybe break up into lines and sort

Choose a reason for hiding this comment

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

also add link to docs in the setup.py

Copy link
Member Author

Choose a reason for hiding this comment

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

Hoping to do more cleanups in #51

docs/conf.py Show resolved Hide resolved
docs/jupyter-lite.json Outdated Show resolved Hide resolved
@jtpio
Copy link
Member Author

jtpio commented Nov 23, 2022

cc @krassowski @bollwyvl if you want to have another look since most of the points raised above have been addressed.

Planning to do more follow-up cleanups in #51

docs/index.md Outdated
@@ -0,0 +1,8 @@
Try `jupyterlab-plugin-playground` in your browser right now [![try-badge]][try]

Choose a reason for hiding this comment

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

hm... not clickable in rtd... also maybe throw a {hint} around it...

Copy link
Member Author

Choose a reason for hiding this comment

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

good catch 👍

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried a couple of things to get the link to work, not sure whether it's because the file is generated.

@bollwyvl
Copy link

bollwyvl commented Nov 24, 2022 via email

@jtpio
Copy link
Member Author

jtpio commented Dec 6, 2022

check-links is failing because of the new badge added in ea6f13f.

Planning to get this one so it can be used in JupyterLite already by clicking on the badge in the README, and we can address the link issue mentioned above separately.

@jtpio jtpio merged commit 482c9eb into jupyterlab:main Dec 6, 2022
@jtpio jtpio deleted the jupyterlite branch December 6, 2022 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use with JupyterLite
3 participants