Explore ipython/jupyter notebooks for our API documentation

[danbri]

• see https://github.com/blog/1995-github-jupyter-notebooks-3
• Some existing docs in wiki: https://github.com/schemaorg/schemaorg/wiki/AppEngine

Work in progress: https://github.com/schemaorg/schemaorg/blob/sdo-callisto/scripts/dashboard.ipynb

[mfhepp]

+1 for IPython

---

martin hepp
www: http://www.heppnetz.de/
email: mhepp@computer.org

Am 14.11.2015 um 12:57 schrieb Dan Brickley notifications@github.com:

see https://github.com/blog/1995-github-jupyter-notebooks-3
Some existing docs in wiki: https://github.com/schemaorg/schemaorg/wiki/AppEngine
—
Reply to this email directly or view it on GitHub.

[RichardWallis]

moved to all python/site tool issues #3

[danbri]

Reopening as I worked on this :)

At this stage only a proof of concept with a mountain of boilerplate, but I think this should replace the idea of using appengine's local console, which we had explored (except in case of very appengine-centric investigations which are hopefully not going to be a frequent concern).

[danbri]

See https://github.com/schemaorg/schemaorg/blob/sdo-callisto/scripts/dashboard.ipynb

... this shows that the .ipynb format also stores detail from a test run of the program, and that Github will render both in the style of a live Jupyter/iPython notebook.

[mfhepp]

Just to keep everything in one place:
We should include nbviewer links or links to the rendered version of the resulting iPython notebooks.

• http://blog.jupyter.org/2015/05/07/rendering-notebooks-on-github/
• https://nbviewer.jupyter.org/

[mfhepp]

BTW: I think the NBviewer rendering is a bit nicer than then rendering that comes directly from GitHub (because it does not show the notebooks inside the frame but full-screen):

https://nbviewer.jupyter.org/github/schemaorg/schemaorg/blob/sdo-callisto/scripts/dashboard.ipynb

[danbri]

Agreed. Have you managed to run it locally? @RichardWallis had issues with it (the kernel?) hanging...

[mfhepp]

Did not try yet, sorry.

[mfhepp]

Pulling the notebook itself works - I can render it in e.g. Anaconda.
Running a cell does not work due to the missing imports, naturally.

[danbri]

the core should be bundled, i guess pandas, matplotlib at least are external. what was missing for you?

[mfhepp]

I think the GAE libraries, but this might be a local issue here due to different Python enviroments for Anaconda and normal development.
Sorry, have no time to check this now in detail.

On 07 Sep 2016, at 19:30, Dan Brickley notifications@github.com wrote:

the core should be bundled, i guess pandas, matplotlib at least are external. what was missing for you?

—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub, or mute the thread.

[danbri]

There was some packaging done for Travis-CI that might help here. Could also look at Google Golab for an approach to shared environment.

[github-actions]

This issue is being tagged as Stale due to inactivity.