Enable Binder #2198

MarcSkovMadsen · 2021-04-17T03:56:23Z

Address #1500, #1369 (comment) and #2218.

This will enable opening the Panel examples on Binder. Whether it will also be possible to add a binder link to all examples is unknown and "nice to have" for this PR.

For now you can access binder via https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=lab/tree/examples

I would like a suggestion from @philippjfr or @jbednar which link we should provide when released. I see the following options

Link to binder branch.
- Pros: We can control what is available on Binder
- Cons: We will have to remember and spend time on updating the binder branch
Link to master branch.
- Pros: Everything is always the latest
- Cons: There might be things is master that changes the behaviour of the current version of Panel released.
Link to release branch of Panel. I.e. for example the version for the Panel 0.11.3 release
- Pros: The current version of Panel is available on Binder
- Cons:
  - Will have to remember to update links across the repository.
  - Users having bookmarked the link would stay on that version of Panel on Binder

MarcSkovMadsen · 2021-04-17T14:22:14Z

Status: Things are starting to work. I'm finding bugs in the Reference Examples. I have to update the gallery notebooks in order to be able to serve them as apps. I would like to configure VS Code to enable showcasing how powerful the combination of Panel and VS Code is.... Also on Binder and in a Jupyter Hub.

panel-binder.mp4

So I would really, really like Panel to work in VS Code. But it requires fixing bokeh/jupyter_bokeh#131

MarcSkovMadsen · 2021-04-20T14:55:19Z

Hi @philippjfr

As I see it 1) Binder is working 2) It now comes with a nice setup like panel-jupyter-proxy, panel serve of all gallery examples, vs code integrated and a new, improved index page.

In principle this could be all for this PR except adding a link to binder in different places. For example the README.

BUT all the notebooks need to be walked through and prettified in order to be useable as apps. This could be a lot of work and a lot of minor changes. And to be honest. Even without binder a test and update of the notebooks could be in place (c.f. all the bugs posted, I have just scratched the surface I believe).

Here are my questions.

Do you want the gallery notebooks updated in general to be responsive and end up in a nice app template?
Do you want the reference examples updated in general to be responsive and end up in a nice app template?`
If yes to some of these questions. Do you want separate PRs for each notebook, one large Notebook PR or just this PR with everything?
Could you answer the question about which link to provide to users posted in the first post? Thanks.

philippjfr · 2021-04-20T14:58:51Z

Do you want the gallery notebooks updated in general to be responsive and end up in a nice app template?

No, some of them sure, but definitely not all. The focus should be the feature being demonstrated not making all the examples look like.

Do you want the reference examples updated in general to be responsive and end up in a nice app template?`

Definitely not, in fact I'd argue there's no reason to make these available as apps at all.

Could you answer the question about which link to provide to users posted in the first post? Thanks.

I'll make sure to configure this once you're done here. The link will go in the interactivity warning that floats on the right side.

philippjfr · 2021-04-20T14:59:21Z

If yes to some of these questions. Do you want separate PRs for each notebook, one large Notebook PR or just this PR with everything?

Just make a single PR for any coordinated changes like this.

MarcSkovMadsen · 2021-05-02T09:30:46Z

Binder is now working as I originally intended it to and more :-).

You can open jupyter lab in Binder via https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=lab/tree/examples
You can open the panel app gallery in Binder via https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=panel
- Panel has an improved index/ gallery page
- You can click the site_title in an app and navigate back to the gallery.
- Apps are "responsive"
You can open VS Code on Binder as well. https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=vscode
You can open Docs on Binder as well. https://mybinder.org/v2/gh/holoviz/panel/binder?urlpath=docs
Everything is installed and configured to work with all gallery and reference notebooks.
- Gallery and reference notebooks work.

Some things are not in scope for me

Adding links from every example at panel.holoviz.org to the notebook and app on Binder. I hope @philippjfr can/ will do this.

Some things are not working and I am not capable of getting it working

C.f. Not working in VS Code bokeh/jupyter_bokeh#131
Serving notebooks as live "docs" with static code cells and dynamic output. For example via Voila. See Enable serving notebook as interactive docs with static code cells #2241.
And lots more that I created individual bug reports for.

Working Video

binder-gallery-works.mp4

Not Working

Watch this video on Youtube https://www.youtube.com/watch?v=gI3qQRVdIIE

@philippjfr Feel free to review and start creating value from this :-) I don't plan to do more on this before getting a review and feedback.

Thanks.

jbednar

Nice! This will make things look and feel much better. Should we promote the approach from #2271 or is it better to put the template separately like it is here?

jbednar · 2021-05-02T14:09:37Z

binder/start

+Xvfb :99 -screen 0 1280x1024x24 > /dev/null 2>&1 &
+sleep 3
+jupyter trust examples/**/*.ipynb
+jupyter trust examples/**/**/*.ipynb


I'm not a bash expert, but doesn't ** indicate recursive directory searching nowadays? If so, isn't the second trust call redundant?

I thought so. But it did not work like that for me. So I added it twice. That works.

examples/gallery/apis/stocks_altair.ipynb

MarcSkovMadsen · 2021-05-03T04:33:49Z

Nice! This will make things look and feel much better. Should we promote the approach from #2271 or is it better to put the template separately like it is here?

When the new approach #2271 is ready and tested I think it would make a lot of sense to switch. That syntax is nice and shorter.

The only downside is that then not a lot of examples will show how to build apps with templates for non-notebook users. There the natural workflow might still be to explicitly declare a template ??

jbednar · 2021-05-03T13:12:16Z

Good point. We should still have a separate example of building such a template explicitly somewhere, and while it's true people may not see that example, having people use servable unnecessarily in a standalone file is not that terrible. I.e., I agree it doesn't make as much sense outside a notebook, but it's still going to be fine for many people, and so I'm ok with more advanced non-notebook users having to do a bit more work to find that there is this other way.

philippjfr · 2021-05-03T16:04:17Z

setup.py

+        'pydeck',
+        'pyecharts',
+        'idom',
+        'xlsxwriter',
+        'pyarrow',


Most of these cannot be added to setup.py since that is also the ground truth for conda installs. If I remove these here will this break the binder setup?

Yes. But we can add them to one of the files in the binder subfolder. Can you point out which should not be included?

Already removed all the ones you added. Anything that is not conda installable cannot appear here, so for now I've removed pydeck, pyecharts, idom, xlsxwriter and pyarrow. You could readd pyarrow since that is available.

setup.py

Co-authored-by: James A. Bednar <[email protected]>

codecov · 2021-05-03T16:40:12Z

Codecov Report

Merging #2198 (bed6e07) into master (9984f55) will increase coverage by 0.38%.
The diff coverage is 41.66%.

@@            Coverage Diff             @@
##           master    #2198      +/-   ##
==========================================
+ Coverage   83.64%   84.02%   +0.38%     
==========================================
  Files         183      181       -2     
  Lines       21947    21940       -7     
==========================================
+ Hits        18357    18436      +79     
+ Misses       3590     3504      -86

Impacted Files	Coverage Δ
panel/tests/pane/test_alert.py	`90.90% <0.00%> (ø)`
...nel/tests/template/fast/test_fast_grid_template.py	`95.83% <0.00%> (-2.09%)`	⬇️
...nel/tests/template/fast/test_fast_list_template.py	`87.50% <0.00%> (-6.25%)`	⬇️
panel/tests/template/test_manual.py	`61.61% <0.00%> (-1.39%)`	⬇️
panel/tests/template/test_vanilla_manual.py	`86.95% <0.00%> (-2.41%)`	⬇️
panel/tests/widgets/test_speech_to_text.py	`90.72% <0.00%> (ø)`
panel/tests/widgets/test_text_to_speech.py	`92.50% <0.00%> (ø)`
panel/tests/pane/test_markup.py	`99.33% <100.00%> (ø)`
panel/tests/widgets/test_tables.py	`99.23% <100.00%> (ø)`
panel/config.py	`51.78% <0.00%> (-0.16%)`	⬇️
... and 8 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9984f55...bed6e07. Read the comment docs.

MarcSkovMadsen · 2021-05-03T17:38:00Z

There is one fundamental thing to consider. Which branch should be promoted and shared with users? In principle any branch will be available on Binder. But it's important to agree on one that is promoted.

My recommendation would be to promote the binder branch. Then it can be updated and fixed whenever there is a new release. The master branch for example will not always be working is my experience. For example the .ts code cannot build right now I believe.

philippjfr · 2021-05-03T17:52:43Z

For example the .ts code cannot build right now I believe.

There are a few errors but they are not preventing the .ts from being built and don't cause any real issues. However I should add a CI check to ensure there are zero TS errors or warnings. Not entirely excited about a binder branch since that's an additional release step but given all the alternatives that still seems like the best approach.

MarcSkovMadsen · 2021-05-03T18:36:24Z

The alternative is just using the master branch. But then users would see functionality that is not yet released. That might be confusing. But maybe also just fine.

jbednar · 2021-05-03T18:46:58Z

Sound to me like it ought to be using a tag indicating the latest release, rather than a separate branch? Our release workflow would then need to update latest-release or released whenever we make a full (non-dev) release. Seeing changes post-release would not only be confusing, it would likely not work, if it's anything like when I try Panel outside the release process (due to the JS build/publish process involved).

panel/tests/widgets/test_tables.py

philippjfr · 2021-05-12T10:20:31Z

Thanks again for this extraordinary effort @MarcSkovMadsen. I'll be adding binder links to all pages in a separate PR.

MarcSkovMadsen added 19 commits April 16, 2021 15:08

add binder link

571ba5d

add binder requirements

bf308b9

replaced deprecated pandas.util.testing

747171e

add more example packages

5b4de05

fix deprecation warning

8916b14

fix images too small

f1abcb2

fix height issue

e32ec8c

add postBuild for VTK dependencies

a3a689e

update iris.json link

3f97435

add apt-get install for vtk

f31f88e

add bokeh data

32f49c2

remove vtk apt packages

5813978

fix autocomplete not shown

62b0a9b

fix missing pandas.testing references

e6ffe87

add panel build to make sure the dist is updated

9e0cd5a

add panel apps to server

a4db462

serve gallery examples in nice template

e850ba4

add vs code server proxy

6b5f36f

fix vs code install

bebba49

added some more usefull VS Code extensions

99a26a0

stonebig mentioned this pull request Apr 18, 2021

Release 2021-03 Follow-up winpython/winpython#953

Closed

6 tasks

update index.html template

004019f

MarcSkovMadsen mentioned this pull request Apr 19, 2021

Provide a better index template #2218

Closed

Marc Skov Madsen and others added 3 commits April 20, 2021 06:17

add query args

fc7c826

fix href

c9a8900

update altair_choropleth example

e2efac3

MarcSkovMadsen added 5 commits May 2, 2021 06:28

add description to apps

369aa43

Add description to app for Binder

fbeacb2

Fix smaller app bugs

9778751

get docs via voila working

3317e98

help pip dependency resolved.

eb433c5

MarcSkovMadsen changed the title ~~Enable Binder - WORK IN PROGRESS~~ Enable Binder May 2, 2021

MarcSkovMadsen requested a review from philippjfr May 2, 2021 09:31

MarcSkovMadsen added the ready for review label May 2, 2021

jbednar reviewed May 2, 2021

View reviewed changes

philippjfr reviewed May 3, 2021

View reviewed changes

setup.py Outdated Show resolved Hide resolved

philippjfr and others added 3 commits May 3, 2021 12:05

Apply suggestions from code review

4a77848

Co-authored-by: James A. Bednar <[email protected]>

Cleared notebook metadata

219955e

Fix flake

2b33c3e

Marc Skov Madsen and others added 2 commits May 5, 2021 19:13

Fix #2294: add requirements back. But in binder

656a461

Fix coverage

0933be8

philippjfr reviewed May 12, 2021

View reviewed changes

panel/tests/widgets/test_tables.py Outdated Show resolved Hide resolved

Apply suggestions from code review

bed6e07

philippjfr merged commit 985a180 into master May 12, 2021

philippjfr deleted the binder branch May 12, 2021 09:50

stonebig mentioned this pull request Jun 27, 2021

Release 2021-04 follow-up + post1 winpython/winpython#995

Closed

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable Binder #2198

Enable Binder #2198

MarcSkovMadsen commented Apr 17, 2021 •

edited

Loading

MarcSkovMadsen commented Apr 17, 2021

MarcSkovMadsen commented Apr 20, 2021 •

edited

Loading

philippjfr commented Apr 20, 2021

philippjfr commented Apr 20, 2021

MarcSkovMadsen commented May 2, 2021 •

edited

Loading

jbednar left a comment

jbednar May 2, 2021

MarcSkovMadsen May 3, 2021

MarcSkovMadsen commented May 3, 2021

jbednar commented May 3, 2021 •

edited

Loading

philippjfr May 3, 2021

MarcSkovMadsen May 3, 2021

philippjfr May 3, 2021

codecov bot commented May 3, 2021 •

edited

Loading

MarcSkovMadsen commented May 3, 2021 •

edited

Loading

philippjfr commented May 3, 2021

MarcSkovMadsen commented May 3, 2021

jbednar commented May 3, 2021

philippjfr commented May 12, 2021

Enable Binder #2198

Enable Binder #2198

Conversation

MarcSkovMadsen commented Apr 17, 2021 • edited Loading

MarcSkovMadsen commented Apr 17, 2021

MarcSkovMadsen commented Apr 20, 2021 • edited Loading

philippjfr commented Apr 20, 2021

philippjfr commented Apr 20, 2021

MarcSkovMadsen commented May 2, 2021 • edited Loading

Working Video

Not Working

jbednar left a comment

Choose a reason for hiding this comment

jbednar May 2, 2021

Choose a reason for hiding this comment

MarcSkovMadsen May 3, 2021

Choose a reason for hiding this comment

MarcSkovMadsen commented May 3, 2021

jbednar commented May 3, 2021 • edited Loading

philippjfr May 3, 2021

Choose a reason for hiding this comment

MarcSkovMadsen May 3, 2021

Choose a reason for hiding this comment

philippjfr May 3, 2021

Choose a reason for hiding this comment

codecov bot commented May 3, 2021 • edited Loading

Codecov Report

MarcSkovMadsen commented May 3, 2021 • edited Loading

philippjfr commented May 3, 2021

MarcSkovMadsen commented May 3, 2021

jbednar commented May 3, 2021

philippjfr commented May 12, 2021

MarcSkovMadsen commented Apr 17, 2021 •

edited

Loading

MarcSkovMadsen commented Apr 20, 2021 •

edited

Loading

MarcSkovMadsen commented May 2, 2021 •

edited

Loading

jbednar commented May 3, 2021 •

edited

Loading

codecov bot commented May 3, 2021 •

edited

Loading

MarcSkovMadsen commented May 3, 2021 •

edited

Loading