Bundler extension API #1579

parente · 2016-06-30T03:23:30Z

minrk · 2016-06-30T08:01:02Z

notebook/bundlerextensions.py

@@ -0,0 +1,259 @@
+# Copyright (c) Jupyter Development Team.


It might be nice to put this file inside notebook/bundler so it's all self contained.

* Change handler for consistency with nbconvert * Change bundler function API to take ContentManager models * Change CLI to work as jupyter bundler * Change UI to fit into existing template / JS structure (c) Copyright IBM Corp. 2016

@minrk

Based on first review by @minrk * bundlerextension for consistency * Move CLI entry point into bundler package * Add bundler/__main__.py (c) Copyright IBM Corp. 2016

(c) Copyright IBM Corp. 2016

parente · 2016-07-02T19:26:15Z

@minrk Do you think this is reasonable to target for 4.3 instead of 5.0? There's only new API, no backward incompatibility. It would help us move the dashboard bundlers away from their dependency on another extension (jupyter_cms) sooner rather than later.

Cleanup more bundler vs bundlerextension refs (c) Copyright IBM Corp. 2016

(c) Copyright IBM Corp. 2016

It has no instance state. It should be a module that bundlers optionally import. (c) Copyright IBM Corp. 2016

(c) Copyright IBM Corp. 2016

minrk · 2016-07-04T10:00:28Z

It could be for 4.3, if we do that. We may be at the point of only doing bugfix backports for 4.x at this point, though.

Include label and module name (if available) to help a user remember which Python module provides which bundler(s) (c) Copyright IBM Corp. 2016

In notebook.json config (c) Copyright IBM Corp. 2016

parente · 2016-07-05T11:59:56Z

For the docs, I'm thinking of adding a new docs/source/extending/bundlerextensions.rst and expanding the content in docs/source/examples/Notebook/Distributing Jupyter Extensions as Python Packages.ipynb to also mention what needs to be done to distribute bundler extensions.

Does this sound reasonable?

/cc @willingc

minrk · 2016-07-05T12:57:43Z

Sounds good to me

* Improve some docstrings too * Fix a busted extension link along the way (c) Copyright IBM Corp. 2016

* Add tarball_bundler example inline * Add tarball_bundler example to bundler doc too * Cross-ref from distributing doc to doc about writing extensions (c) Copyright IBM Corp. 2016

parente · 2016-07-05T18:54:06Z

I've checked off everything I had planned on my list here. There's examples, tests, doc, and the implementation itself.

willingc · 2016-07-05T20:09:29Z

@parente Looks good to me. Thanks!

parente · 2016-07-07T13:25:11Z

I think this is ready for a final review / merge.

Adding @Carreau and @ellisonbg who commented on the original associated issue and cc'ed @fperez @jasongrout.

torsstei · 2016-07-27T14:31:09Z

It would be desirable to move this pull request towards merge soon. We have an exploitation of the cms (https://www.youtube.com/watch?v=xSRZgxAf9BQ) and a regular notebook core API would be what we would prefer.

gnestor · 2016-08-11T17:23:31Z

@parente I'll review this. A couple questions:

How can I get the bundlerextension command working? I pulled this PR branch and re-installed using pip install -e . --user...
Once the bundlerextension extension is working, can I test the zip bundler using jupyter bundlerextension enable --py notebook.bundler.zip_bundler --sys-prefix?
Anything else I should test?

parente · 2016-08-12T01:25:46Z

@gnestor Thanks for having a look!

How can I get the bundlerextension command working? I pulled this PR branch and re-installed using pip install -e . --user...

jupyter bundlerextension should just work. Are you saying it doesn't? I dev'ed locally by pip installing into a conda environment. Is --user breaking it?

Once the bundlerextension extension is working, can I test the zip bundler using jupyter bundlerextension enable --py notebook.bundler.zip_bundler --sys-prefix?

This is definitely a good place to start. There's a tarball bundler in there too that you can try also.

Anything else I should test?

jupyter/dashboards_bundlers#46 makes the dashboards bundlers extension compatible with this new API. If you're feeling brave, you might try testing that.It'll take a bit of doing, namely getting the dashboard extension installed, the bundler extension built with the PR installed, and the dashboard server running to see if the bundler properly packs and sends one of the example notebook-dashboards to the dashboard server properly. If that's too much overhead (and it probably is), don't sweat it. I did test it once already when creating that PR. If this merges in, I'll test it against notebook HEAD.

gnestor · 2016-08-12T22:38:44Z

jupyter bundlerextension should just work. Are you saying it doesn't? I dev'ed locally by pip installing into a conda environment. Is --user breaking it?

Yep, the --user flag was the culprit.

zip and tarball bundlers worked for me! It took about 20-30 seconds for the first zip to fulfill. Each subsequent one was instant, along with the tarball.

gnestor · 2016-08-12T22:43:15Z

@minrk How do you feel about merging this?

minrk · 2016-08-13T20:03:13Z

@gnestor 👍

parente · 2016-08-13T20:10:21Z

@minrk @gnestor Not sure why --user didn't work. I can look into that as follow-on. Thanks for testing and merging!

gnestor · 2016-08-13T20:32:02Z

@parente Ya please do because it could be my environment...

parente · 2016-08-23T02:46:37Z

@gnestor I pulled master just now and ran:

cd notebook
source activate notebook-dev
pip install -e .
jupyter bundlerextension enable --py notebook.bundler.zip_bundler --user
jupyter notebook

Then I opened a notebook and triggered the bundler menu item. No issues.

I next tried the following outside a conda env:

cd notebook
pip install -e . --user
~/.local/bin/jupyter bundlerextension enable --py notebook.bundler.zip_bundler --user
~/.local/bin/jupyter notebook

No issues again.

gnestor · 2016-08-24T16:16:00Z

@parente Ok good. Great work, this is an exciting addition! Any bundle as Gist bundlers yet? If not, that could be my first bundler contribution...

minrk added this to the 5.0 milestone Jun 30, 2016

minrk reviewed Jun 30, 2016
View reviewed changes

First pass migrating from jupyter_cms

8fb6709

* Change handler for consistency with nbconvert * Change bundler function API to take ContentManager models * Change CLI to work as jupyter bundler * Change UI to fit into existing template / JS structure (c) Copyright IBM Corp. 2016

parente force-pushed the bundler-api branch from cd0c6f5 to 8fb6709 Compare July 2, 2016 18:38

Cleanup CLI naming

de77534

Based on first review by @minrk * bundlerextension for consistency * Move CLI entry point into bundler package * Add bundler/__main__.py (c) Copyright IBM Corp. 2016

parente force-pushed the bundler-api branch from 40de765 to de77534 Compare July 2, 2016 18:57

parente added 8 commits July 2, 2016 23:15

Add jupyter bundler extension list command

3a9a0f5

Cleanup more bundler vs bundlerextension refs (c) Copyright IBM Corp. 2016

Make BundlerTools a module

4f81b71

It has no instance state. It should be a module that bundlers optionally import. (c) Copyright IBM Corp. 2016

parente added 2 commits July 4, 2016 17:34

Improve bundler list output

4412b4b

Include label and module name (if available) to help a user remember which Python module provides which bundler(s) (c) Copyright IBM Corp. 2016

Fix missed bundler -> bundlerextensions renames

c82cce0

In notebook.json config (c) Copyright IBM Corp. 2016

parente mentioned this pull request Jul 4, 2016

Make compatible with notebook bundler API jupyter/dashboards_bundlers#46

Merged

parente added 2 commits July 5, 2016 13:12

New bundler extensions developer doc

4a33866

* Improve some docstrings too * Fix a busted extension link along the way (c) Copyright IBM Corp. 2016

Update Distributing Jupyter Extensions doc

2473efc

* Add tarball_bundler example inline * Add tarball_bundler example to bundler doc too * Cross-ref from distributing doc to doc about writing extensions (c) Copyright IBM Corp. 2016

parente changed the title ~~[wip] Bundler API~~ Bundler extension API Jul 5, 2016

parente mentioned this pull request Aug 4, 2016

Could not deploy successfully with static/css/js assets along with ipynb. jupyter/dashboards_bundlers#47

Closed

minrk merged commit f396334 into jupyter:master Aug 13, 2016

takluyver mentioned this pull request Jan 31, 2017

Migrate bundler mini-API from jupyter-incubater/contentmanagement to notebook #1469

Closed

blink1073 mentioned this pull request Feb 7, 2017

Dashboarding jupyterlab/jupyterlab#1640

Closed

github-actions bot added the status:resolved-locked label Apr 12, 2021

github-actions bot locked as resolved and limited conversation to collaborators Apr 12, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bundler extension API #1579

Bundler extension API #1579

parente commented Jun 30, 2016 •

edited

Loading

minrk Jun 30, 2016

parente commented Jul 2, 2016

minrk commented Jul 4, 2016

parente commented Jul 5, 2016 •

edited

Loading

minrk commented Jul 5, 2016

parente commented Jul 5, 2016

willingc commented Jul 5, 2016

parente commented Jul 7, 2016

torsstei commented Jul 27, 2016

gnestor commented Aug 11, 2016

parente commented Aug 12, 2016

gnestor commented Aug 12, 2016

gnestor commented Aug 12, 2016

minrk commented Aug 13, 2016

parente commented Aug 13, 2016

gnestor commented Aug 13, 2016

parente commented Aug 23, 2016

gnestor commented Aug 24, 2016

Bundler extension API #1579

Bundler extension API #1579

Conversation

parente commented Jun 30, 2016 • edited Loading

minrk Jun 30, 2016

Choose a reason for hiding this comment

parente commented Jul 2, 2016

minrk commented Jul 4, 2016

parente commented Jul 5, 2016 • edited Loading

minrk commented Jul 5, 2016

parente commented Jul 5, 2016

willingc commented Jul 5, 2016

parente commented Jul 7, 2016

torsstei commented Jul 27, 2016

gnestor commented Aug 11, 2016

parente commented Aug 12, 2016

gnestor commented Aug 12, 2016

gnestor commented Aug 12, 2016

minrk commented Aug 13, 2016

parente commented Aug 13, 2016

gnestor commented Aug 13, 2016

parente commented Aug 23, 2016

gnestor commented Aug 24, 2016

parente commented Jun 30, 2016 •

edited

Loading

parente commented Jul 5, 2016 •

edited

Loading