Jupyter Project Documentation

Welcome to the Jupyter Project documentation. This website acts as “meta” documentation for the Jupyter ecosystem. It has a collection of resources to navigate the tools and communities in this ecosystem, and to help you get started.

Start Here

These are a few high-level topics to help you learn more about the Jupyter community and ecosystem.

Get started with Jupyter Notebook Try the notebook	Community Sustainability and growth
Architecture What is Jupyter?	Contributor Guides How to contribute to the projects
Narratives and Use Cases Narratives of common deployment scenarios	Release Notes New features, upgrades, deprecation notes, and bug fixes
IPython An interactive Python kernel and REPL	Reference APIs
Installation, Configuration, and Usage Documentation for users	Advanced Documentation for advanced use-cases

Sub-project documentation

Sub-projects are major technical and community efforts, and generally have their own documentation for their communities. Below is a list of documentation for major parts of the Jupyter ecosystem.

User Interfaces

• JupyterLab

• Jupyter Notebook

• nbclassic

• Jupyter Console

• Qt console

• Voilà

JupyterHub

• JupyterHub

• Configurable HTTP proxy

• Authenticators: LDAP, OAuth, Native, LTI

• Spawners: sudo, Docker, Kubernetes

• Zero to JupyterHub

• All JupyterHub Projects…

Working with Notebooks

• nbclient - execution

• nbconvert - conversion

• nbviewer - viewing

• nbdime - comparing and merging

• nbgrader - grading

• nbformat - modification and validation

Kernels

• IPython

• IRkernel

• IJulia

• Xeus kernels

• Community maintained kernels

IPython

• IPython

• ipykernel

• ipyparallel

• traitlets

Architecture and Specification

• nbformat - Jupyter Notebook Format

• jupyter-client - Jupyter Messaging Protocol

• jupyter-core

• jupyter-server

• jupyterlab-server

Deployment

• Docker Stacks

• Kernel Gateway

• Enterprise Gateway

Widgets

• ipywidgets

• widget-cookiecutter

• All Widget Projects…

Table of Contents

The rest of the documentation on this site covers major use-cases of the Jupyter ecosystem, as well as topics that will help you navigate the various parts of the Jupyter community. For more in-depth documentation about a specific tool, we recommend checking out that tool’s documentation (see the list above).

• Try Jupyter
  • Try in Your Browser. No Installation Needed.
  • Next step: install Jupyter locally

• Usage
  • Use and Configure
  • How do I decide which packages I need?
  • Advanced topics

• Projects
  • Jupyter Projects and Communities
  • More information

• Community
  • Jupyter Community Meetings
  • Jupyter communications
  • Governance
  • Code of conduct
  • Running Jupyter Events
  • What is a Jovyan?

• Contributing
  • Getting Started Contributing
  • Developer Guide
  • Documentation Guide
  • Communications Guide
  • IPython Development Guide (source: old IPython wiki)
  • Do I really have something to contribute to Jupyter?
  • What kinds of contributions can I make?

• Reference
  • Custom mimetypes (MIME types)
  • IPython
  • Glossary
  • Resources

Resources

Site	Description
Jupyter website	Keep up to date on Jupyter
IPython website	Learn more about IPython
Jupyter Discourse forum	Start here for help and support questions
Jupyter Accessibility	Accessibility sub-project documentation
Jupyter mailing list	General discussion of Jupyter’s use
Jupyter in Education group	Discussion of Jupyter’s use in education
NumFocus	Promotes world-class, innovative, open source scientific software
Donate to Project Jupyter	Please contribute to open science collaboration and sustainability

Indices and tables

• Index

• Glossary

• Search Page