/jupyter-js-filebrowser

DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui

Primary LanguageTypeScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

DEPRECATED -Jupyter JS Filebrowser

File browser for Jupyter.

API Docs

Package Install

Prerequisites

npm install --save jupyter-js-filebrowser

Source Build

Prerequisites

git clone https://github.com/jupyter/jupyter-js-filebrowser.git
cd jupyter-js-filebrowser
npm install
npm run build

Rebuild

npm run clean
npm run build

Run Tests

Follow the source build instructions first.

npm test

Build Docs

Follow the source build instructions first.

npm run docs

Navigate to docs/index.html.

Build Example

Follow the source build instructions first. Requires a Python install with the Jupyter notebook 4.1+.

npm run build:example

Run python main.py from the example directory.

Supported Runtimes

The runtime versions which are currently known to work are listed below. Earlier versions may also work, but come with no guarantees.

  • IE 11+
  • Firefox 32+
  • Chrome 38+

Bundle for the Browser

Follow the package install instructions first.

Any bundler that understands how to require() files with .js and .css extensions can be used with this package.

Usage Examples

Note: This module is fully compatible with Node/Babel/ES6/ES5. Simply omit the type declarations when using a language other than TypeScript.