Skip to content
JupyterLab computational environment.
JavaScript TypeScript Python CSS HTML Shell
Branch: master
Clone or download
blink1073 Merge pull request #7879 from ikiw/master
Resolve #7874 - stop too many fetch calls to docmanager-extension on …
Latest commit b66bb79 Feb 14, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update Periodic Labeler Jan 6, 2020
binder Update Binder README Feb 3, 2020
buildutils Fix bumpversion script to properly switch to alpha for a minor release Feb 6, 2020
design The title has a typo Oct 30, 2019
dev_mode bump ui-components version Feb 4, 2020
docs Update import for the StateDB example in dev docs Feb 10, 2020
examples New version Feb 4, 2020
jupyter-config/jupyter_notebook_config.d Add data_files support (#3546) Jan 6, 2018
jupyterlab Update suggested build type on troubleshoot msg Feb 13, 2020
packages Merge pull request #7879 from ikiw/master Feb 15, 2020
release Add a Docker file for a clean release environment Aug 24, 2019
scripts update ci_script Jan 30, 2020
tests bump ui-components version Feb 4, 2020
testutils New version Feb 4, 2020
typedoc-theme/partials Switch to ts 3.1 Sep 25, 2018
.bumpversion.cfg bump version Feb 4, 2020
.cleanignore implemented fallback arg for LabIcon.resolveX methods Jan 29, 2020
.eslintignore configure all linters to ignore generated iconimports.ts Jan 3, 2020
.eslintrc cleanup May 28, 2019
.gitattributes Upgrade to yarn 1.5.1 Mar 6, 2018
.gitignore implemented fallback arg for LabIcon.resolveX methods Jan 29, 2020
.meeseeksdev.yml Add meessekdev bot config file Oct 15, 2018
.prettierignore type/signature fixes Jan 3, 2020
.prettierrc Add eslint interop Jul 2, 2018
.yarnrc Update lerna (#5262) Sep 4, 2018
CONTRIBUTING.md Change phosphor instructions to lumino for linking Dec 30, 2019
CORPORATE.md fix typo Jul 25, 2019
LICENSE Update copyright notice. (#4931) Jul 19, 2018
MANIFEST.in Workspaces CLI (#5166) Sep 20, 2018
README.md Sort maintainers list in alphabetical order Dec 18, 2019
RELEASE.md add minor version spacing Dec 11, 2019
azure-pipelines.yml fix pipeline config Jan 6, 2020
clean.py simplified .cleanignore, added `@` pattern syntax Aug 28, 2019
conftest.py Add slow marker for python tests Aug 22, 2019
lerna.json Update lerna (#5262) Sep 4, 2018
lint-staged.config.js attempt to fix lint-staged for both win and mac Jan 21, 2020
package.json Merge pull request #7784 from telamonian/fix-win-lint-staged Jan 29, 2020
readthedocs.yml Avoid installing jlab at all (#4929) Jul 19, 2018
setup.cfg release cleanup Jun 2, 2019
setup.py Update file check Dec 10, 2019
setupbase.py Exclude .js.map files from the package Aug 30, 2019
tsconfigbase.json Turn on strict null checks (except for services) Dec 20, 2019
tslint.json configure all linters to ignore generated iconimports.ts Jan 3, 2020
yarn.lock Merge pull request #7767 from telamonian/remove-jlicon-rendermime-int… Feb 3, 2020

README.md

Installation | Documentation | Contributing | License | Team | Getting help |

JupyterLab

PyPI version Downloads Build Status Documentation Status GitHub Discourse Gitter

Binder

An extensible environment for interactive and reproducible computing, based on the Jupyter Notebook and Architecture. Currently ready for users.

JupyterLab is the next-generation user interface for Project Jupyter offering all the familiar building blocks of the classic Jupyter Notebook (notebook, terminal, text editor, file browser, rich outputs, etc.) in a flexible and powerful user interface. JupyterLab will eventually replace the classic Jupyter Notebook.

JupyterLab can be extended using npm packages that use our public APIs. To find JupyterLab extensions, search for the npm keyword jupyterlab-extension or the GitHub topic jupyterlab-extension. To learn more about extensions, see the user documentation.

The current JupyterLab releases are suitable for general usage, and the extension APIs will continue to evolve for JupyterLab extension developers.

Read the latest version's documentation on ReadTheDocs.


Getting started

Installation

JupyterLab can be installed using conda or pip. For more detailed instructions, consult the installation guide.

Project installation instructions from the git sources are available in the contributor documentation.

conda

If you use conda, you can install it with:

conda install -c conda-forge jupyterlab

pip

If you use pip, you can install it with:

pip install jupyterlab

If installing using pip install --user, you must add the user-level bin directory to your PATH environment variable in order to launch jupyter lab.

Installing with Previous Versions of Jupyter Notebook

When using a version of Jupyter Notebook earlier than 5.3, the following command must be run after installation to enable the JupyterLab server extension:

jupyter serverextension enable --py jupyterlab --sys-prefix

Running

Start up JupyterLab using:

jupyter lab

JupyterLab will open automatically in the browser. See the documentation for additional details.

Prerequisites and Supported Browsers

Jupyter notebook version 4.3 or later is required. To check the notebook version, run the command:

jupyter notebook --version

The latest versions of the following browsers are currently known to work:

  • Firefox
  • Chrome
  • Safari

See our documentation for additional details.


Development

Contributing

To contribute to the project, please read the contributor documentation.

JupyterLab follows the Jupyter Community Guides.

Extending JupyterLab

To start developing an extension, see the developer documentation and the API docs.

License

JupyterLab uses a shared copyright model that enables all contributors to maintain the copyright on their contributions. All code is licensed under the terms of the revised BSD license.

Team

JupyterLab is part of Project Jupyter and is developed by an open community. The maintenance team is assisted by a much larger group of contributors to JupyterLab and Project Jupyter as a whole.

JupyterLab's current maintainers are listed in alphabetical order, with affiliation, and main areas of contribution:

  • Afshin Darian, Two Sigma (co-creator, application/high-level architecture, prolific contributions throughout the code base).
  • Vidar T. Fauske, JPMorgan Chase (general development, extensions).
  • Tim George, Cal Poly (UI/UX design, strategy, management, user needs analysis)
  • Brian Granger, AWS (co-creator, strategy, vision, management, UI/UX design, architecture).
  • Jason Grout, Bloomberg (co-creator, vision, general development).
  • Max Klein, JPMorgan Chase (UI Package, build system, general development, extensions).
  • Fernando Perez, UC Berkeley (co-creator, vision).
  • Ian Rose, Quansight/City of LA (general core development, extensions).
  • Saul Shanabrook, Quansight (general development, extensions)
  • Steven Silvester, AWS (co-creator, release management, packaging, prolific contributions throughout the code base).

Maintainer emeritus:

  • Chris Colbert, Project Jupyter (co-creator, application/low-level architecture, technical leadership, vision, PhosphorJS)
  • Cameron Oelsen, Cal Poly (UI/UX design).
  • Jessica Forde, Project Jupyter (demo, documentation)

This list is provided to give the reader context on who we are and how our team functions. To be listed, please submit a pull request with your information.


Getting help

We encourage you to ask questions on the Discourse forum. A question answered there can become a useful resource for others.

Please use the GitHub issues page to provide feedback or submit a bug report. To keep resolved issues self-contained, the lock bot will lock closed issues as resolved after a period of inactivity. If related discussion is still needed after an issue is locked, please open a new issue and reference the old issue.

Weekly Dev Meeting

We have videoconference meetings every week where we discuss what we have been working on and get feedback from one another.

Anyone is welcome to attend, if they would like to discuss a topic or just to listen in.

You can’t perform that action at this time.