Skip to main content

The JupyterLab notebook server extension.

Project description

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.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

jupyterlab-2.1.0b0.tar.gz (8.6 MB view details)

Uploaded Source

Built Distribution

jupyterlab-2.1.0b0-py3-none-any.whl (7.8 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-2.1.0b0.tar.gz.

File metadata

  • Download URL: jupyterlab-2.1.0b0.tar.gz
  • Upload date:
  • Size: 8.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.8.2

File hashes

Hashes for jupyterlab-2.1.0b0.tar.gz
Algorithm Hash digest
SHA256 a4c94bfa59e0574dea908aab8693154e152d2e2d04aa299c5d3ad0dfd2c9b76e
MD5 e34d19be453579c97aaca3687455e393
BLAKE2b-256 58f8b2fb3d444c6c0cd3c375cb2c1991f48dc8ac74358b3821cab0904e9cd570

See more details on using hashes here.

File details

Details for the file jupyterlab-2.1.0b0-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab-2.1.0b0-py3-none-any.whl
  • Upload date:
  • Size: 7.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.8.2

File hashes

Hashes for jupyterlab-2.1.0b0-py3-none-any.whl
Algorithm Hash digest
SHA256 5bf3a44054edf4adf1101630888ce0a7f2d038152534808b89b700e956d2a3c2
MD5 e4cdb1fbaa779766660a1007e479ed91
BLAKE2b-256 da272d5283793b350d0040d38740230082f8d1f7adff1836abe3f579de7077a3

See more details on using hashes here.

Supported by

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