Spit the package into voici-core and voici

voila-dashboards / voici

Voici turns any Jupyter Notebook into a static web application

https://voici.readthedocs.io/

Other

143 stars 8 forks source link

Spit the package into voici-core and voici #106

Closed martinRenou closed 5 months ago

martinRenou commented 5 months ago

This PR splits the repo into two packages:

voici-core: provides the CLI and the jupyterlite addon
voici: a meta-package that ships both voici-core and jupyterlite-xeus-python (will switch to using jupyterlite-xeus in a separate PR)

github-actions[bot] commented 5 months ago

:point_left: Try it on ReadTheDocs

martinRenou commented 5 months ago

check-release is driving me nuts, using some system yarn for some reason

jtpio commented 5 months ago

check-release is driving me nuts, using some system yarn for some reason

Were you able to find the reason a system-wide yarn would be picked up?

trungleduc commented 5 months ago

check-release is driving me nuts, using some system yarn for some reason

Were you able to find the reason a system-wide yarn would be picked up?

Because jupyterlab/maintainer-tools/.github/actions/base-setup@v1 installs yarn 1 by default.

jtpio commented 5 months ago

Also it may be useful to provide a migration guide, so folks who are already currently using the voici package in their deployments with a different kernel (for example jupyterlite-pyodide-kernel) know why they would start pulling jupyterlite-xeus-python when they update to a newer version.

martinRenou commented 5 months ago

Thank you for the review!

I'd like to work on improving the documentation when the move to jupyterlite-xeus is done. Let's do that in a separate PR. Does it sound good @jtpio ?

trungleduc commented 5 months ago

the package/voici package should live outside of python/voici-core?

martinRenou commented 5 months ago

the package/voici package should live outside of python/voici-core?

Should it? It seems to me this package only builds an index.js that is shipped by voici-core.

Otherwise we'd need two package.json in the repo, one for packages/voici and one for voici-core which depends on the first. I'm not sure I see the benefit of this?

trungleduc commented 5 months ago

the package/voici package should live outside of python/voici-core?

Should it? It seems to me this package only builds an index.js that is shipped by voici-core.

Otherwise we'd need two package.json in the repo, one for packages/voici and one for voici-core which depends on the first. I'm not sure I see the benefit of this?

maybe not. It's just the general layout of a mono-python/js repo

jtpio commented 5 months ago

I'd like to work on improving the documentation when the move to jupyterlite-xeus is done. Let's do that in a separate PR. Does it sound good @jtpio ?

Sure. Maybe this would also require addressing https://github.com/jupyterlite/xeus/issues/17 first.

Just trying to think of ways for making this internal change as smooth as possible for existing Voici users.

trungleduc commented 5 months ago

Just trying to think of ways for making this internal change as smooth as possible for existing Voici users.

We can release this change in a major version? Maybe starting 0.6.0 alphas with this PR

martinRenou commented 5 months ago

So do you guys think there are blockers for this PR? What do you think about merging and we iterate upon it?

trungleduc commented 5 months ago

I think it's good to go

trungleduc commented 5 months ago

Thanks @martinRenou !