RISE allows you to instantly turn your Jupyter Notebooks into a slideshow

Related tags

Miscellaneous RISE
Overview

RISE

RISE allows you to instantly turn your Jupyter Notebooks into a slideshow. No out-of-band conversion is needed, switch from jupyter notebook to a live reveal.js-based slideshow in a single keystroke, and back.

Basic usage

Resources

RISE stands for Reveal.js - Jupyter/IPython Slideshow Extension:

Installation

You essentially have 2 options:

Option 1 - Using conda:

conda install -c conda-forge rise

Option 2 - Using pip:

pip install RISE

Development

To install RISE in development mode, see the Developer section of the RISE documentation.

Feedback

If you have any feedback, or find any bugs, please let us know just opening an issue.

Support us

Please visit this page for more information: https://rise.readthedocs.io/en/stable/support.html

Comments
  • New approach for JupyterLab 3

    New approach for JupyterLab 3

    This is a reboot of #381 - in order to move forward on https://github.com/jupyter/notebook/issues/6220

    The approach taken differs from #381 as it creates a stand-alone app (similarly to retrolab - JLab remix) in order to:

    • Deal with the DOM manipulation induced by RevealJS that don't play nicely in webapp such JupyterLab
    • Add the opportunity to spin a notebook focusing on slideshow experience

    What it does:

    • Add button in JupyterLab notebook toolbar to open the RISE view of the current notebook
    • Support federated extension in RISE mode (in particular ipywidgets are working)
    • Restructure completely the package to be a single python package with multiple npm packages to ship a single package for the classical notebook and JupyterLab
    • Support ipywidget
    • Run on Binder for the classical notebook and JupyterLab ~~(but failed to open the standalone app from JupyterLab)~~

    What it partly do:

    • Create a ugly slideshow with no configuration

    What needs to be done:

    • [ ] Improve styling
    • [x] properly handle all kinds of cells (subslide, fragment, ...)
    • [x] Render slideshow in side-by-side panel within JupyterLab
    • [x] ~~Create custom notebook factory to remove the toolbar~~ Explicitly dispose the toolbar (avoid dealing with specific factory)
    • [x] ~~Turn off virtual rendering~~ Wait for fully rendering before converting to slideshow (placeholder cannot be removed due to DOM hierarchy change for Reveal)
    • [ ] Turn off heading collapse feat.
    • [x] Check Jupyter Widget interact
    • Implement as much features as possible from classical:
      • [x] Support RevealJS theming
      • [x] Support shortcuts
      • [x] Support Jupytext (not tested may already work)
        PR opened: https://github.com/mwouts/jupytext/pull/877
      • [x] Dynamically load custom CSS
      • Deal with configuration:
        • [x] at JupyterLab level
        • [x] at notebook level
    • x [out of scope] Allow to edit style info from cell toolbar (updating extension??)
    • x [out of scope] [optional] Bring something like split-cell classic extension
    • [ ] Smart execution
    • [ ] Documentation
    • [ ] CI job to at least test it installs

    Help will be really appreciate to cover the above points - don't hesitate to open PRs against this PR branch.

    rise_demo_20211120

    opened by fcollonval 68
  • Print to PDF

    Print to PDF

    Reveal.js supports the following option :

    Open your presentation with print-pdf included anywhere in the query string. This triggers the default index HTML to load the PDF print stylesheet (css/print/pdf.css). You can test this with lab.hakim.se/reveal-js?print-pdf.

    ref: https://github.com/hakimel/reveal.js/

    I tried adding ?print-pdf to my ipnb url but it does not work.

    I was wondering if it was possible to enable it with RISE. This way I can make handouts for students.

    bug docs High Priority 
    opened by luctrudeau 55
  • We need to support a multiplatform installation

    We need to support a multiplatform installation

    Some things to discuss/implement:

    • [x] remove dual installation... just let the python setup.py
    • [X] also support win
    • [x] support pip install
    • [x] conda package
    • [x] local and system wide installation
    • ~~how to deal with require in custom.js (I like the current solution although is hacky)~~

    Other ideas welcome...

    enhancement High Priority 
    opened by damianavila 46
  • documentation on customization

    documentation on customization

    IIMHO the structure of this page here can be improved https://damianavila.github.io/RISE/customize.html

    I suggest 3 parts

    1. how to customize config. variables (using javascript, using python, mention the trick with jupyter --paths)
    2. what : the list of available settings, their possible values, and effects
    3. keyboard : list of actions as exposed to Jupyter keybindings system, their default binding when relevant

    optionnally the last part could be made a separate section, of course

    PS. as a side note I must add that I am not at all comfortable with this RST thing (to state things politely;) How about moving to markdown instead ?

    task Low Priority 
    opened by parmentelat 43
  • No button appears

    No button appears

    Hi, I really like this add-on, however I cannot install it correctly.

    git clone https://github.com/damianavila/RISE.git python setup.py install

    after that run Jupyter, the cell toolbar has slideshow option.

    docs Medium Priority Low Severity 
    opened by kurt1984 40
  • trouble installing RISE // no button visible

    trouble installing RISE // no button visible

    I am installing RISE in a python 3.6 virtualenv with pip and the following dependencies:

    jupyter==1.0.0 jupyter-client==5.3.4 jupyter-console==6.0.0 jupyter-core==4.6.1 nbconvert==5.6.1 nbformat==4.4.0 notebook==6.0.2 rise==5.5.1

    I am NOT running jupyter-nbextension install rise --py --sys-prefixas recommended.

    However, after installation and running jupyter in the shell, there is no RISE button next to the keyboard and hotkeys won't work either.

    Is this a compatibility issue? I tried downgrading juptyer, notebook and rise but it didn't solve the issue.

    question more-input-needed 
    opened by paulelvers 37
  • Hide input cells

    Hide input cells

    It would be great if this had the ability to hide input cells, like you do for nbconvert here:

    http://www.damian.oquanta.info/posts/hide-the-input-cells-from-your-ipython-slides.html

    That would make the ability to mix hidden python stuff with purposefully displayed python.

    enhancement High Priority 
    opened by jmshea 37
  • RISE is not always enabled in notebooks

    RISE is not always enabled in notebooks

    I am sorry this is a very "fuzzy" issue description, but I have not yet figured out exactly what reproduces this. I have a (somewhat largish) notebook that I successfully used to run a slideshow for teaching two days ago. Now, when I open the exact same file again, the "slideshow button" that usually enables slideshow mode simply does not appear. The only difference between now and then is that I executed most of the code cells in the notebook during the slideshow the other day and saved it afterwards. If I re-open the previous version of the notebook, from before I ran the slideshow, the "slideshow button" reappears. I have checked that the problematic version of the notebook is "trusted" by Jupyter. I can send the two versions of the notebook for comparison but would prefer to do so privately.

    bug 
    opened by ThomasA 26
  • Displaying the slide show

    Displaying the slide show

    Hi Damianavila,

    Great work on RISE! My issue is whenever I try to view the slides I've created, the Enter slideshow doesn't open the slides. I think something might be blocking it, could it be a port issue?

    Regards,

    question 
    opened by Rainz86 25
  • font size

    font size

    Hi,

    I want to change the font size of markdown cell because it is disproportionate compare to code cell in the presentation. I tried to add 'font-size': '80%' in ConfigManager but it is not working.

    How can we do that ?

    Thanks a lot

    discussion 
    opened by jcrichard 25
  • scrolling vertically

    scrolling vertically

    Hi,

    I have some big code cells that won't fit vertically on one slide. Unfortunately I've found no way to scroll in presentation mode, but maybe I'm just missing some configuration option :).

    best regards, jochen

    bug High Priority 
    opened by ephes 23
  • Vertical scrollbar not exported to HTML

    Vertical scrollbar not exported to HTML

    I have enabled the vertical scrollbar via metadata 'scroll': 'true' (cf. RISE doc) and it works fine in live presentation mode.

    Upon exporting to HTML, however, the scrollbar setting gets lost and vertically extending slide contents will simply be cut and become unaccessible.

    I'm running nbconvert==7.2.5, notebook==6.5.2 and rise==5.7.1 .. (I have seen this effect in both chromium 105.0.5195.102 and firefox 104.0)

    opened by aoeftiger 2
  • Weird layout when commands output large amounts of text

    Weird layout when commands output large amounts of text

    I'm using the bash kernel, but I assume this isn't specific to that kernel.

    If I create a cell that has tons of output, like grep --help here, the cell is initially positioned correctly:

    image

    Then, when I run the cell, the output is now present, but the cell is still positioned in the center of the screen instead of the top: image

    When I go forward a slide and then back, this resolves itself: image

    Here's a notebook that can be used to reproduce this. Note that this uses the Bash kernel:

    rise_bug.ipynb.txt

    opened by multimeric 6
  • Reveal / Speaker note: start at selected cell?

    Reveal / Speaker note: start at selected cell?

    Hi there,

    Thanks for the great extension, very nice!

    I'm wondering about something: when starting Rise, it's possible to enter the slideshow right at the selected cell. However, when it comes to testing the speaker note/speaker view, the only mode is restarting at the beginning.

    Is there an option to open the speaker notes at the selected cell by any chance?

    Thank you very much in advance, Jeremie

    opened by jchwenger 6
  • Invisible progress bars when using ipywidgets / tqdm progress bars

    Invisible progress bars when using ipywidgets / tqdm progress bars

    I always use ipywidgets to make tqdm progress bars look nicer in Jupyter notebooks: image

    Unfortunately, this does not render correctly when presenting in RiSE: image

    The progress bar is invisible, and the font sizes are too small.

    Is RiSE compatible with ipywidgets?

    opened by ndalchau 2
  • RISE not showing among extensions.

    RISE not showing among extensions.

    Hi,

    Rise button is not showing up in my notebook. I installed rise through anaconda in my main environment, but when I type jupyter nbextensions list I get the following

    config dir: /Users/lmng/.jupyter/nbconfig notebook section nbextensions_configurator/config_menu/main enabled - Validating: problems found: - require? X nbextensions_configurator/config_menu/main contrib_nbextensions_help_item/main enabled - Validating: OK collapsible_headings/main enabled - Validating: OK toc2/main enabled - Validating: OK varInspector/main enabled - Validating: OK rise/main enabled - Validating: problems found: - require? X rise/main

    Can you help me out? Thank you,

    opened by lucamungo 1
  • Question: View Downloaded Drawing From .json File

    Question: View Downloaded Drawing From .json File

    Hi, I tried to download my drawings using the '' command and it gave me a .json file as predicted. However, I'm kind of confused on could I re-use this file or even view this .json file to see my drawings? Is this .json setting inherent from the reveal.js or from other plug-ins? Thanks!

    opened by xwshiba 0
Owner
Damian Avila
Father, Software Developer, Quant, (formerly) Biochemist, and some other things ;-)
Damian Avila
Turn your IPad into a Screen-Slaver with 1 simple Pythonista script

ScreenSlaver Turn your IPad into a Screen-Slaver with 1 simple Pythonista script

null 6 Jul 9, 2022
NotesToCommands - a fully customizable notes / command template program, allowing users to instantly execute terminal commands

NotesToCommands is a fully customizable notes / command template program, allowing users to instantly execute terminal commands with dynamic arguments grouped into sections in their notes/files. It was originally created for pentesting uses, to avoid the needed remembrance and retyping of sets of commands for various attacks.

zxro 5 Jul 2, 2022
Turn a raspberry pi into a Bluetooth Midi device

PiBluetoothMidSetup This will change serveral system wide packages/configurations Do not run this on your primary machine or anything you don't know h

MyLab6 40 Sep 19, 2022
A python script to turn tabs into spaces the right way.

detab A python script to turn tabs into spaces the right way. detab turns all tabs into spaces, not just leading tabs. Not all tabs have the same leng

null 1 Jan 26, 2022
STAC in Jupyter Notebooks

stac-nb STAC in Jupyter Notebooks Install pip install stac-nb Usage To use stac-nb in a project, start Jupyter Lab (jupyter lab), create a new noteboo

Darren Wiens 32 Oct 4, 2022
A plugin for poetry that allows you to execute scripts defined in your pyproject.toml, just like you can in npm or pipenv

poetry-exec-plugin A plugin for poetry that allows you to execute scripts defined in your pyproject.toml, just like you can in npm or pipenv Installat

null 38 Jan 6, 2023
Sardana integration into the Jupyter ecosystem.

sardana-jupyter Sardana integration into the Jupyter ecosystem.

Marc Espín 1 Dec 23, 2021
Turn crypto miner on/off depending on powerwall charge level

Mining Crypto with Tesla Solar and Powerwalls This script turns a crypto miner on and off when the Tesla Powerwall level drops/rises above a certain t

Matt 1 Nov 9, 2021
Shutdown Time - A pretty much useless application that allows you to shut your computer down in x time with a GUI.

A pretty much useless application that allows you to shut your computer down in x time with a GUI. Should eventually support Windows (all versions), Linux (v2.0+), MacOS (probably with Linux, idk)

null 1 Nov 8, 2022
switching computer? changing your setup? You need to automate the download of your current setup? This is the right tool for you :incoming_envelope:

?? setup_shift(SS.py) switching computer? changing your setup? You need to automate the download of your current setup? This is the right tool for you

Mohamed Elfaleh 15 Aug 26, 2022
Nuclei - Burp Extension allows to run nuclei scanner directly from burp and transforms json results into the issues

Nuclei - Burp Extension Simple extension that allows to run nuclei scanner directly from burp and transforms json results into the issues. Installatio

null 106 Dec 22, 2022
This is a vscode extension with a Virtual Assistant that you can play with when you are bored or you need help..

VS Code Virtual Assistant This is a vscode extension with a Virtual Assistant that you can play with when you are bored or you need help. Its currentl

Soham Ghugare 6 Aug 22, 2021
You can easily send campaigns, e-marketing have actually account using cash will thank you for using our tools, and you can support our Vodafone Cash +201090788026

*** Welcome User Sorry I Mean Hello Brother ✓ Devolper and Design : Mokhtar Abdelkreem ========================================== You Can Follow Us O

Mo Code 1 Nov 3, 2021
A simple service that allows you to run commands on the server using text

Server Text A simple flask service that allows you to run commands on the server/computer over sms. Think of it as a shell where you run commands over

MT Devs 49 Nov 9, 2021
EasyBuild is a software build and installation framework that allows you to manage (scientific) software on High Performance Computing (HPC) systems in an efficient way.

EasyBuild is a software build and installation framework that allows you to manage (scientific) software on High Performance Computing (HPC) systems in an efficient way.

EasyBuild community 87 Dec 27, 2022
Allows you to purge all reply comments left by a user on a YouTube channel or video.

YouTube Spammer Purge Allows you to purge all reply comments left by a user on a YouTube channel or video. Purpose Recently, there has been a massive

null 4.3k Jan 9, 2023
This is a Saleae Logic custom high level analyzer that allows you to search and mark specific packets.

SaleaePacketParser This is a Saleae Logic custom high level analyzer that allows you to search and mark specific packets. Field "Search For" is used f

null 1 Dec 16, 2021
The ldapconsole script allows you to perform custom LDAP requests to a Windows domain

ldapconsole The ldapconsole script allows you to perform custom LDAP requests to a Windows domain. Features Authenticate with password Authenticate wi

Podalirius 38 Dec 9, 2022