Enable Python API in the JupyterLite deployment by davidbrochart · Pull Request #412 · geojupyter/jupytergis

davidbrochart · 2025-01-30T11:24:07Z

Description

Checklist

PR has a descriptive title and content.
PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
PR has one of the labels: documentation, bug, enhancement, feature, maintenance
Checks are passing.
Failing lint checks can be resolved with:
- pre-commit run --all-files
- jlpm run lint

📚 Documentation preview: https://jupytergis--412.org.readthedocs.build/en/412/
💡 JupyterLite preview: https://jupytergis--412.org.readthedocs.build/en/412/lite

github-actions · 2025-01-30T11:24:18Z

👈 Launch a Binder on branch davidbrochart/jupytergis/emscripten

github-actions · 2025-01-30T11:33:37Z

Integration tests report: appsharing.space

mfisher87 · 2025-01-31T17:22:54Z

Is this change enabled by an enhancement to JupyterLite? Could you please add some context links? 🙇

martinRenou · 2025-01-31T17:29:52Z

David is looking into making the Python API work in JupyterLite 🚀

Making good progress this week! You can give it a try here https://davidbrochart.github.io/jupytergis-demo (note not everything is working yet)

It is built from https://github.com/davidbrochart/jupytergis-demo

Once we have something stable, we should update our JupyterLite deployment with what David has there. Probably as part of this PR here?

davidbrochart · 2025-02-01T15:35:41Z

Yes, there are other changes that will make jupytergis_lab work in JupyterLite, currently in my branch.
The piece that allows a Python kernel to access a shared document, and the corresponding file, is my-jupyter-shared-drive: a collaborative drive that is actually not shared with anybody (it just allows to go through the underlying CRDTs to access data).

martinRenou

Thanks!! I have some suggestions

docs/conf.py

docs/environment.yml

docs/jupyter-lite.json

davidbrochart · 2025-02-05T08:24:05Z

Thanks @martinRenou.
The Read the Docs build fails but I don't know why: https://readthedocs.org/api/v2/build/27080482.txt.

davidbrochart · 2025-02-05T08:24:39Z

Oh I see:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
sphinx-togglebutton 0.3.2 requires setuptools, which is not installed.
sphinx-togglebutton 0.3.2 requires wheel, which is not installed.
sphinx-autodoc-typehints 3.0.1 requires sphinx>=8.1.3, but you have sphinx 7.4.7 which is incompatible.
sphinx-tabs 3.4.1 requires docutils~=0.18.0, but you have docutils 0.21.2 which is incompatible.

docs/environment-docs.yml

davidbrochart · 2025-02-05T08:44:05Z

Now the error is:

ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
sphinx-autodoc-typehints 3.0.1 requires sphinx>=8.1.3, but you have sphinx 7.4.7 which is incompatible.
sphinx-tabs 3.4.1 requires docutils~=0.18.0, but you have docutils 0.21.2 which is incompatible.

.readthedocs.yaml

docs/environment.yml

davidbrochart · 2025-02-05T15:19:50Z

The JupyterLite deployment here seems to have the collaborative drive, but I suspect running the Notebook.ipynb doesn't work because of #425?

davidbrochart · 2025-02-05T15:27:54Z

The JupyterLite deployment here seems to have the collaborative drive, but I suspect running the Notebook.ipynb doesn't work because of #425?

Yes, it works with 7dc7400.
So we should think about kernel vs Jupyter paths now.

martinRenou · 2025-02-06T13:25:23Z

Rebased from the UI

martinRenou · 2025-02-06T17:34:36Z

I just pushed two new commits (+ the linter one)

Show an error dialog in the front-end if no collaborative drive is there 946e34d this comes as a replacement for the old import error we were showing in Python
Handle file operations from the front-end instead of in Python 8181441

This works only with QuantStack/yjs-widgets#22

Case 1: Open an existing file (path is relative to the current context aka Notebook)

Uploading Screencast From 2025-02-06 18-25-05.mp4…

Upload doesn't work, but hey it's working

Case 2: Open a non-existing file, we create it (path is relative to the current context aka Notebook)

Screencast.From.2025-02-06.18-21-38.mp4

Case 3: Open without passing a file path, we don't create anything

Screencast.From.2025-02-06.18-24-32.mp4

martinRenou

Looks like we're hitting flaky visual regression test, let's go ahead with this!!

Thanks David

brichet · 2025-02-07T10:05:33Z

python/jupytergis_lab/src/notebookrenderer.ts

  IJupyterYWidget,
  IJupyterYWidgetManager,
+  JupyterYDoc,
+  // JupyterYDoc,


Suggested change

// JupyterYDoc,

matthewfeickert · 2025-02-07T10:13:48Z

Awesome to see! Thanks for this great work.

Unclear why removed in geojupyter#412

* Error on doc build warnings * Add missing maxdepth parameter value * Restore docs build steps which installed jupytergis wheels Unclear why removed in #412 * Remove pip install from build_packages.py Setting up the environment should probably be decoupled from the build helper script. * Try build _then_ build:packages This actually worked locally 🙏 * Fix type annotation errors * Fix docutils warning ``` /home/docs/micromamba/envs/jupytergis-docs/lib/python3.12/site-packages/jupytergis_lab/notebook/gis_document.py:docstring of jupytergis_lab.notebook.gis_document.GISDocument:5: WARNING: Field list ends without a blank line; unexpected unindent. [docutils] ``` * Remove undefined `_type_` type * Fix some broken type documentation * Bugfix: Remove mutable default arguments

* Don't change paths to absolute backend paths * Enable jupytergis_lab in WASM platform * Make the model collaborative in JupyterLite * Deploy JupyterLite with collaborative drive * Review * Pin python=3.12 Co-authored-by: martinRenou <martin.renou@gmail.com> * Pin micromamba v2.0.5 * Install myst-parser from conda * Fix typo * Fix paths * Show error message in the front-end when there is no collaborative drive * Linter * Handle file operations in the front-end * Up * Update yjs widgets * Remove unwanted test * Cleanup * Remove Github pages build * Show console as early as possible * More docs building removal * Unpin my-jupyter-shared-drive --------- Co-authored-by: martinRenou <martin.renou@gmail.com>

* Error on doc build warnings * Add missing maxdepth parameter value * Restore docs build steps which installed jupytergis wheels Unclear why removed in geojupyter#412 * Remove pip install from build_packages.py Setting up the environment should probably be decoupled from the build helper script. * Try build _then_ build:packages This actually worked locally 🙏 * Fix type annotation errors * Fix docutils warning ``` /home/docs/micromamba/envs/jupytergis-docs/lib/python3.12/site-packages/jupytergis_lab/notebook/gis_document.py:docstring of jupytergis_lab.notebook.gis_document.GISDocument:5: WARNING: Field list ends without a blank line; unexpected unindent. [docutils] ``` * Remove undefined `_type_` type * Fix some broken type documentation * Bugfix: Remove mutable default arguments

davidbrochart added the maintenance Fixing lint errors, changing project metadata, changing tooling, changing dependencies, etc. label Jan 30, 2025

davidbrochart force-pushed the emscripten branch from 742b70e to b303f02 Compare February 3, 2025 13:44

davidbrochart marked this pull request as draft February 3, 2025 13:46

davidbrochart force-pushed the emscripten branch 7 times, most recently from 747616f to 34006b2 Compare February 4, 2025 21:52

martinRenou requested changes Feb 5, 2025

View reviewed changes

docs/conf.py Outdated Show resolved Hide resolved

docs/environment.yml Outdated Show resolved Hide resolved

docs/environment.yml Outdated Show resolved Hide resolved

docs/jupyter-lite.json Outdated Show resolved Hide resolved

martinRenou reviewed Feb 5, 2025

View reviewed changes

docs/environment-docs.yml Outdated Show resolved Hide resolved

martinRenou reviewed Feb 5, 2025

View reviewed changes

.readthedocs.yaml Show resolved Hide resolved

docs/environment.yml Outdated Show resolved Hide resolved

martinRenou force-pushed the emscripten branch from 7dc7400 to 16614e5 Compare February 6, 2025 13:25

This was referenced Feb 6, 2025

Don't change paths to absolute backend paths #425

Closed

Fix empty file creation #426

Closed

martinRenou force-pushed the emscripten branch from 16614e5 to 8181441 Compare February 6, 2025 17:27

martinRenou added the Needs Port To JupyterCAD label Feb 6, 2025

davidbrochart and others added 4 commits February 6, 2025 18:45

Fix paths

4c00edc

Show error message in the front-end when there is no collaborative drive

27456b9

Linter

0a37f8c

Handle file operations in the front-end

7dd2bf9

martinRenou force-pushed the emscripten branch from 8181441 to 7dd2bf9 Compare February 6, 2025 17:45

Up

a63bb36

martinRenou self-assigned this Feb 7, 2025

martinRenou added 6 commits February 7, 2025 09:39

Update yjs widgets

3818b3d

Remove unwanted test

28daa39

Cleanup

e9f218f

Remove Github pages build

0e2a371

Show console as early as possible

d392fd2

More docs building removal

4a56544

martinRenou marked this pull request as ready for review February 7, 2025 09:48

Unpin my-jupyter-shared-drive

98c6783

martinRenou changed the title ~~Enable jupytergis_lab in WASM platform~~ Enable Python API in the JupyterLite deployment Feb 7, 2025

martinRenou added enhancement New feature or request and removed maintenance Fixing lint errors, changing project metadata, changing tooling, changing dependencies, etc. labels Feb 7, 2025

martinRenou approved these changes Feb 7, 2025

View reviewed changes

martinRenou merged commit 89e4de9 into geojupyter:main Feb 7, 2025
14 of 15 checks passed

brichet reviewed Feb 7, 2025

View reviewed changes

davidbrochart deleted the emscripten branch February 7, 2025 10:16

arjxn-py mentioned this pull request Feb 11, 2025

Enable Python API in the JupyterLite deployment jupytercad/JupyterCAD#680

Merged

martinRenou removed the Needs Port To JupyterCAD label Feb 13, 2025

mfisher87 added a commit to mfisher87/jupytergis that referenced this pull request Mar 20, 2025

Restore docs build steps which installed jupytergis wheels

37c83dd

Unclear why removed in geojupyter#412

mfisher87 mentioned this pull request Mar 20, 2025

Fix API doc build #556

Merged

4 tasks

Conversation

davidbrochart commented Jan 30, 2025 • edited by martinRenou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

github-actions bot commented Jan 30, 2025

Uh oh!

github-actions bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mfisher87 commented Jan 31, 2025

Uh oh!

martinRenou commented Jan 31, 2025

Uh oh!

davidbrochart commented Feb 1, 2025

Uh oh!

martinRenou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

davidbrochart commented Feb 5, 2025

Uh oh!

davidbrochart commented Feb 5, 2025

Uh oh!

Uh oh!

davidbrochart commented Feb 5, 2025

Uh oh!

Uh oh!

Uh oh!

davidbrochart commented Feb 5, 2025

Uh oh!

davidbrochart commented Feb 5, 2025

Uh oh!

martinRenou commented Feb 6, 2025

Uh oh!

martinRenou commented Feb 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Case 1: Open an existing file (path is relative to the current context aka Notebook)

Case 2: Open a non-existing file, we create it (path is relative to the current context aka Notebook)

Case 3: Open without passing a file path, we don't create anything

Uh oh!

martinRenou left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

brichet Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

matthewfeickert commented Feb 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

davidbrochart commented Jan 30, 2025 •

edited by martinRenou

Loading

github-actions bot commented Jan 30, 2025 •

edited

Loading

martinRenou commented Feb 6, 2025 •

edited

Loading