Skip to main content

Next generation slides from Jupyter Notebooks

Project description

# nbpresent > remix your Jupyter Notebooks as interactive slideshows

## Installation `shell pip install nbpresent python -m nbpresent.install `

Then either run `python %reload_ext nbpresent `

_every time you start the notebook or _enable_ the extension for every notebook launch: `shell python -m nbpresent.install --enable `

### Coming soon - [conda package](https://github.com/ContinuumIO/nbpresent/issues/1)

## Export Stock nbconvert doesn’t store quite enough information, so you’ll need to do something like this: `shell python -m nbpresent.present notebooks/README.ipynb > README.html ` The resulting file can be hosted and viewed (but not edited!) on any site with fallback to Github.

## Development There are several development scenarios

### The Hard Way The nbpresent nbextension is built from src in a checked out repo with: - less for style - babel for es2015 - browserify for packaging

These are installed via npm: `shell npm install `

To build everything with sourcemaps: `shell npm run build `

To rebuild on every save: `shell npm run watch `

To build everything, and optimize it: `shell npm run build `

To ensure that you always get the right assets, install the nbextension with the symlink, force and enable options: `shell python -m nbpresent.install --overwrite --symlink --enable --user `

### Developing with conda A conda package, which pre-builds the static assets and installs itself into the local conda environment, is built from conda.recipe

` conda build conda.recipe `

When developing with conda, you may want to use your conda environment to store assets and configuration: `shell python -m nbpresent.install --overwrite --symlink --enable --prefix="${CONDA_ENV_PATH}" `

### Developing with docker compose A number of intermediate Dockerfiles are available for different development workflows. These are most easily managed with docker-compose.

For building a pristine conda environment, use conda_base. For a build of nbpresent, with all tests, use conda_build. For a live, running notebook with nbpresent installed, use conda.

>> META: TODO: make templates?

Here is the build chain:

`shell docker-compose build conda_base && \ docker-compose build conda_build && \ docker-compose build conda && \ docker-compose up conda `

> META: force build 1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbpresent-0.4.0.tar.gz (115.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbpresent-0.4.0-py2.py3-none-any.whl (119.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file nbpresent-0.4.0.tar.gz.

File metadata

  • Download URL: nbpresent-0.4.0.tar.gz
  • Upload date:
  • Size: 115.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nbpresent-0.4.0.tar.gz
Algorithm Hash digest
SHA256 e5d38e30b6ff2f70642745bd525b4600aff4c550500b23cc1c13d440903f7233
MD5 286a16689d6260bcc19aaf671c85b41e
BLAKE2b-256 bb0216f65e81d3ccb48b228b028ea959e27f6d9ee72ace8f77a9cb299e6f9e09

See more details on using hashes here.

File details

Details for the file nbpresent-0.4.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for nbpresent-0.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c044c7c43fc3577dac0929e57533f40f1d1aeca6c1ad874b479396e26a4ae09a
MD5 fa1b37bc1bde338efa653d9d330bcd91
BLAKE2b-256 4f73df59095623fcbed482063c6067560680106342918f09ae74da8b5705eada

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page