{ "info": { "author": "Ole Schuett", "author_email": "ole.schuett@cp2k.org", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5" ], "description": "# Appmode\n\n**A Jupyter extensions that turns notebooks into web applications.**\n\n\n\n## Try it live\n\n[](https://mybinder.org/v2/gh/oschuett/appmode/master?urlpath=%2Fapps%2Fexample_app.ipynb)\n\nClick the binder badge to try it live without installing anything. This will take you directly to the \"app\" version of the notebook.\n\n\n## Installation\n\nIf you use `conda`, you can install it as:\n```\nconda install --channel conda-forge appmode\n```\n\nIf you use ``pip``, you can install it as:\n```\npip install appmode\njupyter nbextension enable --py --sys-prefix appmode\njupyter serverextension enable --py --sys-prefix appmode\n```\n\nIf you want to use [mybinder](https://mybinder.org) add the following `environment.yml` file to your repository:\n```\nchannels:\n - conda-forge\ndependencies:\n - appmode\n```\n\n## Description\n\nAppmode consist of a server-side and a notebook extension for Jupyter. Together these two extensions provide the following features:\n\n- One can view any notebook in appmode by clicking on the *Appmode* button in the toolbar. Alternatively one can change the url from ``baseurl/notebooks/foo.ipynb`` to ``baseurl/apps/foo.ipynb``. This also allows for direct links into appmode.\n\n- When a notebook is opened in appmode, all code cells are automatically executed. In order to present a clean UI, all code cells are hidden and the markdown cells are read-only.\n\n- A notebook can be opened multiple times in appmode without interference. This is achieved by creating temporary copies of the notebook for each active appmode view. Each appmode view has its dedicated ipython kernel. When an appmode page is closed the kernel is shutdown and the temporary copy gets removed.\n\n- To allow for passing information between notebooks via url parameters, the current url is injected into the variable ``jupyter_notebook_url``.\n\n## Server Side Configuration\n\nAppmode adds the following [configuration options](https://jupyter-notebook.readthedocs.io/en/stable/config.html):\n- `Appmode.trusted_path` Run only notebooks below this path in Appmode. Default: No restrictions.\n- `Appmode.show_edit_button` Show _Edit App_ button during Appmode. Default: True.\n- `Appmode.show_other_buttons` Show other buttons, e.g. Logout, during Appmode. Default: True.\n\n## Client Side Customization\n\nThe UI elements of Appmode can be customized via the [custom.js](http://jupyter-notebook.readthedocs.io/en/stable/examples/Notebook/JavaScript%20Notebook%20Extensions.html#custom.js) file. Some examples are:\n```\n$('#appmode-leave').hide(); // Hides the edit app button.\n$('#appmode-busy').hide(); // Hides the kernel busy indicator.\n$('#appmode-loader').append('