# publicipython/ipython

### Subversion checkout URL

You can clone with HTTPS or Subversion.

# allow customized template and static file paths for the notebook web app#1135

Closed
wants to merge 3 commits into from
 +13 4

### 4 participants

Hello,

I'd like to distribute a few notebooks with my library that form kind of an interactive tutorial. I want to use images and styles from my website and do a few other small things. Thus it's very helpful to be able to specify overrides to the paths the notebook web app uses. Since it's buried in the NotebookApp, I thought using a global overrides dictionary might be a more elegant solution than to add parameters everywhere.

Please let me know what you think.

Owner

This should be handled instead by tying into IPython configuration system. But a question: are you copying over the contents of IPython's template and static dirs to your own?

i was going to do it like this:

1. put all my changed files into a "overlay" folder distributed with my library
2. upon launching the tutorial web app, copy all those overlay files to a new temporary folder
3. symlink all of ipythons own files from static/ and templates/ over to the temporary folder
4. launch the ipython notebook app

if there's a simpler way (for instance, a handler for static file serving that's aware of such overlay folder semantics and something similar for the template loader), I'd of course use that instead.

i haven't looked at the configuration system yet. If you want me to re-write the functionality with it, can you give me a pointer where to look first?

Owner

Two options:

1. static_path and template_path should be Unicode traits of the NotebookApp, with config=True, a la:

static_path = Unicode(os.path.join(os.path.dirname(__file__), "static"), config=True,
help="""The path to static files for the notebook. Should contain all the javascript/css for notebook pages"""
)


Then NotebookApp should pass self.static_path and self.template_path to the NotebookWebApplication constructor.

2. add settings=Dict(config=True,help=...) trait, which is empty by default, but can contain any overrides for the tornado settings. Then the NotebookWebApplication would initialize its default settings, and update with the settings of its parent, so that they might override.

I might prefer 2., because it allows further customization that IPython doesn't have to be aware of - the user can talk directly to tornado.

added some commits December 10, 2011
 timo use IPythons config subsystem to allow overrides to the tornado web app. d2858bc timo this is how the configuration system is supposed to be used. d5cc276

The code now works, with ipython notebook --NotebookApp.webapp_settings="{'static_path':'...'}" custom css files and other static things can be supplied.

I've written a bit of code that merges two folders (a base and an overlay) with as few symlinks as possible into a third, new folder. Should this functionality become part of the notebook app or should I keep it to myself?

Owner

Thanks, looks good. Thoughts, @ellisonbg?

You might post the extra code to the Cookbook.

Owner

Pinging @juliantaylor, as this might help him with packaging that doesn't like static files served from source trees.

Collaborator

I really like this change.
I even like it to go a little bit further by allowing to set the mathjax path.
this patch could be extended for that:
https://gist.github.com/1456031

these changes are essentially untested, but I think they look okay. I'll be unavailable for a couple of hours now.

Owner

Now we have a bit of a problem.

Handling mathjax separately means that currently setting the static path and putting mathjax in there will not result in local mathjax being found without separately specifying that mathjax is in there as well.

If you simply replace the hardcoded check in _mathjax_url_default for the old static path with a check for the user-set value (this should be done anyway), the need for the extra MathJax-related handling goes away. I'm not convinced (yet) that we need to handle our static files being spread across the filesystem, when a user-set static-dir covers that case.

 timo look for mathjax in the custom static path if it's supplied. ed1ef07

the commits that were available before are now available in my branch "custom_mathjax_path":

https://github.com/timo/ipython/tree/custom_mathjax_path

Owner

Great, looks good to me, now.

this last change just adds blocks for the titles to layout.html and notebook.html, so that branding would be easier without overriding the whole layout and notebook templates.

Owner

Just a note to keep track - the most recent change conflicts with #1125, which replaces the header text with an image, so whichever one of these we merge first will force the other to rebase.

Owner

Please submit the changes to the header in a separate pull request. It will require further discussion that is unrelated to this one.

i've reverted the commit. it wasn't so important anyway, can be done later without trouble

closed this pull request from a commit December 12, 2011
 minrk Merge PR 1135 settings for tornado web application can now be specified via the NotebookApp.webapp_settings configurable. This principally allows users/admins to serve custom templates, css, and javascript, without having to modify IPython's shipped sources. closes #1135 f1fd9c8
closed this in f1fd9c8 December 12, 2011
referenced this pull request from a commit January 10, 2012
 Commit has since been removed from the repository and is no longer available.

Showing 3 unique commits by 1 author.

Dec 10, 2011
use IPythons config subsystem to allow overrides to the tornado web app. d2858bc
this is how the configuration system is supposed to be used. d5cc276
look for mathjax in the custom static path if it's supplied. ed1ef07
 @@ -89,7 +89,7 @@ 89 89   90 90  class NotebookWebApplication(web.Application): 91 91   92 - def __init__(self, ipython_app, kernel_manager, notebook_manager, log): 92 + def __init__(self, ipython_app, kernel_manager, notebook_manager, log, settings_overrides): 93 93  handlers = [ 94 94  (r"/", ProjectDashboardHandler), 95 95  (r"/login", LoginHandler), @@ -111,7 +111,11 @@ def __init__(self, ipython_app, kernel_manager, notebook_manager, log): 111 111  cookie_secret=os.urandom(1024), 112 112  login_url="/login", 113 113  ) 114 - web.Application.__init__(self, handlers, **settings) 114 + 115 + # allow custom overrides for the tornado web app. 116 + settings.update(settings_overrides) 117 + 118 + super(NotebookWebApplication, self).__init__(handlers, **settings) 115 119   116 120  self.kernel_manager = kernel_manager 117 121  self.log = log @@ -243,6 +247,10 @@ def _ip_changed(self, name, old, new): 243 247  help="Whether to prevent editing/execution of notebooks." 244 248  ) 245 249   250 + webapp_settings = Dict(config=True, 251 + help="Supply overrides for the tornado.web.Application that the " 252 + "IPython notebook uses.") 253 +  246 254  enable_mathjax = Bool(True, config=True, 247 255  help="""Whether to enable MathJax for typesetting math/TeX 248 256   @@ -264,7 +272,7 @@ def _enable_mathjax_changed(self, name, old, new): 264 272  def _mathjax_url_default(self): 265 273  if not self.enable_mathjax: 266 274  return u'' 267 - static_path = os.path.join(os.path.dirname(__file__), "static") 275 + static_path = self.webapp_settings.get("static_path", os.path.join(os.path.dirname(__file__), "static")) 268 276  if os.path.exists(os.path.join(static_path, 'mathjax', "MathJax.js")): 269 277  self.log.info("Using local MathJax") 270 278  return u"static/mathjax/MathJax.js" @@ -315,7 +323,8 @@ def initialize(self, argv=None): 315 323  super(NotebookApp, self).initialize(argv) 316 324  self.init_configurables() 317 325  self.web_app = NotebookWebApplication( 318 - self, self.kernel_manager, self.notebook_manager, self.log 326 + self, self.kernel_manager, self.notebook_manager, self.log, 327 + self.webapp_settings 319 328  ) 320 329  if self.certfile: 321 330  ssl_options = dict(certfile=self.certfile)