+ - 0:00:00
Notes for current slide
Notes for next slide

Publishing Workflows
for Jupyter

Andrew Odewahn | @odewahn

Kyle Kelley | @rgbkrk

Rune Madsen | @runemadsen

http://odewahn.github.io/publishing-workflows-for-jupyter

1 / 13

Goal

Demonstrate an authoring and publishing process for long-form content (books, courses, tutorials, etc) that can include the IPython Notebook computing environment, but are authored outside of the IPython authoring environment. (And, hopefully, Jupyter very soon!)
2 / 13

Write in Markdown, AsciiDoc, or HTML

  • Easily diff-able formats (vs. JSON, which is not)
  • Collaboration / GitHub friendly
  • Specify executable code cells using a simple, declarative format. For example:
<pre data-executable="ipython" data-code-language="python">
%pylab inline
x = np.linspace(0, 10)
plt.plot(x, np.sin(x), x, np.cos(x))
</pre>
3 / 13

Generate a static site with embeddable code widget

  • Write in tools like Jekyll, Pelican, or Atlas
  • Code cells run in a widget, everything else is HTML, CSS, and JavaScript

4 / 13

Kernels run in Docker containers

  • Each user gets his or her own kernel
  • Kernels run in Docker container
  • Based on the original singlecell server by Min RK
    • Need a singlecell for IPython 2 and 3, not just 1
5 / 13

Scaling strategy

  • Short-term, tmpnb can spin up new, transitory kernels
  • Long-term, we need a new system with an API that can handle scaling and security

6 / 13

Reference implementation in O'Reilly Atlas

  • Write in Atlas using HTML, Markdown, or Asciidoc
  • Mark up code examples as follows:
<pre data-executable="ipython" data-code-language="python">
... your code here ...
</pre>
  • Specify the oreillymedia/jupyter_theme theme
  • Install the Atlas CLI utility for building and publishing (Mac OSX only for now)
  • Clone your project to your local machine
  • Run the following commands within your cloned directory :
$ atlas build --html
$ atlas publish --public
7 / 13

Edit using Visual Editor (HTML), Markdown, or AsciiDoc

8 / 13

Specify a Jupyter-enabled theme

9 / 13

Build and publish a static site

  • atlas-cli provides a simple, command-line interface for building and publishing
10 / 13

Run code via the widget

  • Sample is available on sites.oreilly.com
  • Data is persistent from widget to widget, just like the Notebook
11 / 13

Advantages / Disadvantages

  • Advantages
    • More design possibilities
    • Ability to embed widget on blogs, nbviewer, etc.
    • Static assets served by CDN
    • Simple writing and publishing process
    • Support for publishing-specific features like cross references, sidebars, index terms, etc
  • Disadvantages
    • No easy way in tmpnb to specify a different container (i.e., one with your own dependencies)
    • No authentication framework
12 / 13

Future Directions to explore

To generalize and expand the concept, we could:

  • Create singlecell servers for IPython 2 and Jupyter (i.e., update the singlecell example for those versions)
  • Develop a remote service that you call and it returns a kernel for a specific language
  • Front end javascript that can work with the above remote API
  • Write a minimized set of IPython/Jupyter javascript that can handle the outputs without being the notebook
13 / 13

Goal

Demonstrate an authoring and publishing process for long-form content (books, courses, tutorials, etc) that can include the IPython Notebook computing environment, but are authored outside of the IPython authoring environment. (And, hopefully, Jupyter very soon!)
2 / 13
Paused

Help

Keyboard shortcuts

↑, ←, Pg Up, k Go to previous slide
↓, →, Pg Dn, Space, j Go to next slide
Home Go to first slide
End Go to last slide
Number + Return Go to specific slide
b / m / f Toggle blackout / mirrored / fullscreen mode
c Clone slideshow
p Toggle presenter mode
t Restart the presentation timer
?, h Toggle this help
Esc Back to slideshow