Jupyter Read this in other languages: English, Español, Português, Français Jupyter metapackage for installation and documents Documentation structure This documentation uses the Sphinx documentation engine. The documentation is located in…
Jupyter
*Read this in other languages: [English](README.md), [Español](README.es-ES.md), [Português](README.pt-BR.md), [Français](README.fr-FR.md)*
Jupyter metapackage for installation and documents
Documentation structure
This documentation uses the Sphinx documentation engine.
The documentation is located in the docs/source folder. When you build the documentation, it will be placed in the docs/build folder.
It is written in a combination of reStructuredText and MyST Markdown.
Build the documentation locally
There are a few ways to build the documentation; see below for instructions:
Build the documentation automatically with nox
The easiest way to build the documentation locally is by using the nox command line tool. This tool makes it easy to automate commands in a repository, and we have included a docs command to quickly install the dependencies and build the documentation.
To build and preview the site locally, follow these steps:
1. Clone this repository.
console
$ git clone https://github.com/jupyter/jupyter
$ cd jupyter
2. Install nox
console
$ pip install nox
3. Run the docs command
console
$ nox -s docs
This will install the needed dependencies in a virtual environment using pip.
It will then place the documentation in the docs/build/html folder.
You may explore these HTML files in order to preview the site.
Create a live server to automatically preview changes
There is another nox command that will do the above, and also create a live server that watches your source files for changes, and auto-builds the website any time a change is made.
To start this live server, use the following nox command:
console
$ nox -s docs-live
When the build is finished, go to the URL that is displayed. It should show a live preview of your documentation.
To stop serving the website, press Ctrl-C in your terminal
Build the documentation manually
To build the documentation manually, follow these steps:
First, install the miniconda Python distribution.
Next, navigate to the /docs directory and create a conda environment:
bash
conda env create -f environment.yml
Activate the environment:
bash
source activate jupyter_docs
Build the docs using Sphinx with the following commands:
bash
make clean
make html
The docs will be built in build/html. They can be viewed by opening build/html/index.html or starting an HTTP server and navigating to 0.0.0.0:8000 in your web browser.
bash
python3 -m http.server
Releasing the jupyter metapackage
Anyone with push access to this repo can make a release
of the Jupyter metapackage (this happens very rarely).
We use [tbump][] to publish releases.
tbump updates version numbers and publishes the git tag of the version.
Our GitHub Actions
then build the releases and publish them to PyPI.
The steps involved:
1. Install tbump: pip install tbump
2. Tag and publish the release tbump $NEW_VERSION.
That's it!
[tbump]: https://github.com/your-tools/tbump
-
jupyter
Jupyter metapackage for installation and documentation
Python ★ 15k 14d agoExplain → -
notebook
Jupyter Interactive Notebook
Jupyter Notebook ★ 13k 2d agoExplain → -
docker-stacks
Ready-to-run Docker images containing Jupyter applications
Python ★ 8.4k 23h agoExplain → -
nbdime
Tools for diffing and merging of Jupyter notebooks.
TypeScript ★ 2.8k 10d agoExplain → -
nbviewer
nbconvert as a web service: Render Jupyter Notebooks as static web pages
Python ★ 2.3k 2mo agoExplain → -
nbconvert
Jupyter Notebook Conversion
Python ★ 1.9k 19d agoExplain → -
nbgrader
A system for assigning and grading notebooks
Python ★ 1.4k 4d agoExplain → -
dashboards ▣
[RETIRED] See Voilà as a supported replacement
Jupyter Notebook ★ 976 6y agoExplain → -
colaboratory ▣
[deprecated] Jupyter CoLaboratory, goto google colab now
JavaScript ★ 734 8y agoExplain → -
tmpnb ▣
Creates temporary Jupyter Notebook servers using Docker containers. [DEPRECATED - See BinderHub project]
JavaScript ★ 526 8y agoExplain → -
jupyter_client
Jupyter protocol client APIs
Python ★ 473 8d agoExplain → -
jupyter-drive
Google drive for jupyter notebooks
TypeScript ★ 420 6y agoExplain → -
terminado
Terminals served by tornado websockets
Python ★ 375 10mo agoExplain → -
nbformat
Reference implementation of the Jupyter Notebook format
Python ★ 310 19d agoExplain → -
atom-notebook
[Deprecated] Jupyter Notebook, but inside Atom.
JavaScript ★ 301 5y agoExplain → -
help ▣
:sparkles: Need some help or have some questions? Please visit our Discourse page.
★ 290 7y agoExplain → -
jupyter_console
Jupyter Terminal Console
Python ★ 280 8mo agoExplain → -
jupyter_core
Core Jupyter functionality
Python ★ 214 19d agoExplain → -
jupyter.github.io
Project Jupyter's home on the World Wide Web
HTML ★ 209 3d agoExplain → -
jupyter-sphinx
Sphinx extension for rendering of Jupyter interactive widgets.
Python ★ 194 11mo agoExplain → -
docker-notebook ▣
Docker containers for the IPython notebook (+SciPy Stack)
Shell ★ 185 10y agoExplain → -
nbclient
A client library for executing notebooks. Formally nbconvert's ExecutePreprocessor
Python ★ 183 16d agoExplain → -
dashboards_server ▣
[RETIRED] Server that runs and renders Jupyter notebooks as interactive dashboards
JavaScript ★ 181 8y agoExplain → -
nbconvert-examples
Examples that illustrate how nbconvert can be used
Jupyter Notebook ★ 177 7y agoExplain → -
kernel_gateway_demos
Demos associated with the kernel gateway incubator project
Jupyter Notebook ★ 160 2y agoExplain → -
enhancement-proposals
Enhancement proposals for the Jupyter Ecosystem
Python ★ 127 4mo agoExplain → -
declarativewidgets ▣
[RETIRED] Jupyter Declarative Widget Extension
HTML ★ 120 8y agoExplain → -
nbclassic
Jupyter Notebook as a Jupyter Server extension
JavaScript ★ 111 28d agoExplain → -
governance
The governance process and model for Project Jupyter
Python ★ 99 19d agoExplain → -
papyri
No description.
Python ★ 86 1d agoExplain → -
design
Design related materials for Project Jupyter
HTML ★ 85 1y agoExplain → -
roadmap
Master roadmap for Project Jupyter
★ 84 7y agoExplain → -
scipy-advanced-tutorial ▣
Advance Tutorial For SciPy
JavaScript ★ 79 8y agoExplain → -
dashboards_bundlers ▣
[RETIRED] Converts a notebook to a dashboard and deploys it / downloads it
Python ★ 79 8y agoExplain → -
services ▣
This repository is deprecated. It has been moved to https://github.com/jupyterlab/jupyterlab as a sub-package
TypeScript ★ 75 6y agoExplain → -
docker-demo-images ▣
Demo images for use in try.jupyter.org and tmpnb.org
Jupyter Notebook ★ 75 8y agoExplain → -
nb2kg ▣
No description.
Python ★ 73 6y agoExplain → -
accessibility
A repository for ongoing work around making Jupyter's software accessible and inclusive
Python ★ 72 2mo agoExplain → -
jupyter_kernel_test
A tool for testing Jupyter kernels
Python ★ 66 2y agoExplain → -
jupyter-packaging
Tools to help build and install Jupyter Python packages
Python ★ 65 19d agoExplain → -
nbmanager
View and stop running IPython notebook servers
Python ★ 52 1y agoExplain → -
telemetry
Configurable event-logging for Jupyter applications and extensions.
Python ★ 50 2y agoExplain → -
echo_kernel
A simple example kernel for Jupyter
Python ★ 48 9mo agoExplain → -
jupyter-js-notebook ▣
JupyterLab notebook
TypeScript ★ 46 10y agoExplain → -
ngcm-tutorial
Materials for the IPython/Jupyter workshop at the NGCM Summer Academy, at Southampton University, Boldrewood campus.
Jupyter Notebook ★ 45 8y agoExplain → -
debugger ▣
Research and explorations for an interactive debugger for Jupyter
★ 41 6y agoExplain → -
ipython-py3k ▣
**DO NOT USE THIS REPOSITORY AT ALL** This repo has been merged into the main IPython one that now contains Python 3 support. This is kept only as a reference to developers.
Python ★ 33 14y agoExplain → -
jsplugins ▣
JavaScript Plugins for the IPython Notebook
★ 32 10y agoExplain → -
testpath
Test utilities for Python code working with files and commands
Python ★ 31 6mo agoExplain → -
jupyterhub-2016-workshop ▣
Materials for an online mini-workshop around JupyterHub use cases, held July 22nd, 2016
★ 31 9y agoExplain → -
dashboards_setup ▣
[RETIRED] Recipes for setting up components related to the incubating dashboards effort
Jupyter Notebook ★ 28 8y agoExplain → -
security
No description.
Python ★ 26 5d agoExplain → -
jvm-repr
API for converting JVM objects to representations by MIME type, for the Jupyter ecosystem.
Java ★ 26 6y agoExplain → -
surveys
Surveys and datasets collected by Project Jupyter
Jupyter Notebook ★ 26 2y agoExplain → -
strata-sv-2015-tutorial ▣
Strata Silicon Valley 2015 Tutorial
Python ★ 24 11y agoExplain → -
jupyter-sphinx-theme
A Sphinx theme for Jupyter and IPython documentation
HTML ★ 23 5y agoExplain → -
jupyter-js-plugins ▣
No description.
TypeScript ★ 23 10y agoExplain → -
jupyter_events
Configurable event system for Jupyter applications and extensions.
Python ★ 21 1d agoExplain → -
notebook-research ▣
Research on the usage of Jupyter notebooks
Jupyter Notebook ★ 19 6y agoExplain → -
tutorial-dashboards-declarativewidgets ▣
Materials for the PyData Carolinas 2016 tutorial, Turning Jupyter Notebooks into Data Applications
Jupyter Notebook ★ 18 9y agoExplain → -
tmpnb-deploy
Deploying tmpnb nodes
Python ★ 18 8y agoExplain → -
cookiecutter-docker-stacks
Cookiecutter for community-maintained Jupyter Docker images
Python ★ 17 19d agoExplain → -
kernels ▣
Kernel testing and listing infrastructure
Python ★ 17 8y agoExplain → -
jupyterlab_json ▣
This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript ★ 16 8y agoExplain → -
try-jupyter
A JupyterLite deployment to try JupyterLab, Jupyter Notebook and IPython in the browser
Jupyter Notebook ★ 13 18d agoExplain → -
nature-demo ▣
Materials for the November 2014 Nature Article
Jupyter Notebook ★ 13 8y agoExplain → -
newsletter ▣
A repo for collecting content for the Jupyter Newsletter
Jupyter Notebook ★ 13 9y agoExplain → -
mozfest15-training ▣
Notebooks for Jupyter training session at Mozfest 2015
Jupyter Notebook ★ 13 8y agoExplain → -
jupyterlab_geojson ▣
This repository is deprecated. The extension has moved to https://github.com/jupyterlab/jupyter-renderers
JavaScript ★ 13 9y agoExplain → -
tmpnb-redirector ▣
Simple HTTP redirector for tmpnb nodes
Python ★ 12 8y agoExplain → -
extension-builder ▣
This repository is deprecated.
TypeScript ★ 12 8y agoExplain → -
try.jupyter.org
Try Jupyter!
HTML ★ 11 8y agoExplain → -
phosphor-notebook ▣
Phosphor-based jupyter notebook
TypeScript ★ 11 11y agoExplain → -
ipython-components ▣
third-party javascript dependencies of IPython
JavaScript ★ 11 9y agoExplain → -
jupyter-js-ui ▣
No description.
TypeScript ★ 10 10y agoExplain → -
jupyter-js-output-area ▣
DEPRECATED: Javascript APIs for Jupyter output areas
TypeScript ★ 10 10y agoExplain → -
ideas
A place for the Jupyter community to connect on ideas
★ 9 7y agoExplain → -
pr-triage-board-bot
Sync PRs to a GitHub Project Board to make triage easier
TypeScript ★ 8 20d agoExplain → -
jvm-magics
A plugin system for magic function implementations across JVM kernels.
Java ★ 8 7y agoExplain → -
jupyter_markdown ▣
Documentation and tests related to Jupyter's Markdown syntax
Jupyter Notebook ★ 8 9y agoExplain → -
kernel_gateway_bundlers ▣
Converts a notebook to a kernel gateway microservice bundle for download
Python ★ 8 10y agoExplain → -
talks ▣
A collection of talks about Jupyter and IPython projects
Jupyter Notebook ★ 8 8y agoExplain → -
cdn.jupyter.org
Assets and layout for cdn.jupyter.org
Python ★ 7 6y agoExplain → -
notebook_shim
A shim layer for notebook traits and config
Python ★ 6 1y agoExplain → -
docs-team-compass
Documentation Work Group Discussions
HTML ★ 6 1y agoExplain → -
jupyter_logger ▣
Allows you to log Jupyter notebook user events anonymously.
TypeScript ★ 6 8y agoExplain → -
jupyter-js-utils ▣
JavaScript utilities for the Jupyter frontend
TypeScript ★ 6 9y agoExplain → -
jupyter-communitycalls
📣 Resources for planning and hosting the Jupyter Community Calls
★ 5 1y agoExplain → -
kernels-team-compass
The team-compass for the Jupyter Kernels Subproject
★ 5 1y agoExplain → -
jupyter-sprints ▣
Resources for running a sprint
HTML ★ 5 10y agoExplain → -
win-tornado-terminals ▣
Windows terminal backend for tornado
Python ★ 5 8y agoExplain → -
jupyter-js-input-area ▣
DEPRECATED: Javascript APIs for Jupyter input areas
TypeScript ★ 5 10y agoExplain → -
spreadsheet ▣
A spreadsheet component for phosphor
JavaScript ★ 5 10y agoExplain → -
jupyter-js-filebrowser ▣
DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui
TypeScript ★ 5 10y agoExplain → -
jupyterhub-carina ▣
[RETIRED] JupyterHub integration with Carina
Python ★ 5 9y agoExplain → -
jupyterlab-fasta ▣
DEPRECATED: Moved to https://github.com/jupyterlab/jupyter-renderers. A JupyterLab Fasta viewer
TypeScript ★ 5 8y agoExplain → -
nbcache ▣
Notebook Caching layer in Docker
★ 5 8y agoExplain → -
sphinxcontrib_github_alt
Github roles for Sphinx docs
Python ★ 5 6y agoExplain → -
schema
The canonical place for Jupyter schema descriptions
Python ★ 4 6mo agoExplain → -
distinguished-contributors
Jupyter Distinguished Contributors
★ 4 7mo agoExplain → -
lbnl-jupyterday ▣
Materials for the Jupyter workshop at LBNL, 17 July 2015
Python ★ 4 8y agoExplain → -
project-mgt ▣
No description.
★ 4 8y agoExplain → -
jupyter-js-editor ▣
DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-notebook
TypeScript ★ 4 10y agoExplain → -
jupyter-js-phosphide ▣
A Phosphide-based studio/workbench
CSS ★ 4 10y agoExplain → -
showcase ▣
[RETIRED] A spot to try demos of one or more incubating Jupyter projects in Binder
Makefile ★ 4 8y agoExplain → -
tutorial-devteam-jupyterhub-2017 ▣
Resources for the dev team tutorial on JupyterHub 2017-01-27
★ 4 9y agoExplain → -
community-committee
No description.
Python ★ 3 3d agoExplain → -
nbviewer.org-deploy
Deployment files for nbviewer.jupyter.org
Python ★ 3 19d agoExplain → -
scipy-sprint ⑂ ▣
Sprint organization and planning
HTML ★ 3 10y agoExplain → -
notebook-team-compass ▣
Team Compass for the Jupyter Notebook subproject
★ 3 2y agoExplain → -
nbindex ▣
Indexing IPython Notebooks
Python ★ 3 11y agoExplain → -
jupyter-js-cells ▣
DEPRECATED: Javascript APIs for Jupyter cells
TypeScript ★ 3 10y agoExplain → -
practice
A practice repo for submitting pull requests
★ 3 7y agoExplain → -
software-steering-council-team-compass
Team compass page for the Jupyter Software Steering Council
★ 2 4d agoExplain → -
github-data
Scrapes, publishes, and shows off github issue data from around the Jupyter ecosystem.
Python ★ 2 5mo agoExplain → -
foundations-and-standards-team-compass
No description.
★ 2 1y agoExplain → -
experiments ▣
No description.
★ 2 10y agoExplain → -
scipy-2015-advanced-topics ▣
Advanced topics in Jupyter tutorial for SciPy 2015.
★ 2 11y agoExplain → -
jupyter-blog-theme ▣
Backup of blog.jupyter.org
CSS ★ 2 8y agoExplain → -
etph ▣
System to report anonymous usage statistics from local applications
Python ★ 2 12y agoExplain → -
jupyter-alabaster-theme
No description.
CSS ★ 2 8y agoExplain → -
kernel-protocol
Specification of the Jupyter Kernel Protocol
★ 1 3y agoExplain → -
conf-event-log ▣
Repo for storing team conference and event cards and communicating about specific conferences and events
★ 1 9y agoExplain → -
test-grid ▣
Extra tests for Jupyter packages
Shell ★ 1 8y agoExplain → -
nbshot ▣
Creates images for social media cards and nbviewer's front page
JavaScript ★ 1 11y agoExplain → -
jupyter-js-domutils ▣
DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui
TypeScript ★ 1 10y agoExplain → -
jupyter-js-terminal ▣
DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui
TypeScript ★ 1 10y agoExplain → -
jupyter-js-docmanager ▣
DEPRECATED: This code was copied into https://github.com/jupyter/jupyter-js-ui. Document Manager for JupyterLab
TypeScript ★ 1 10y agoExplain → -
joss-papers ▣
Jupyter related papers submitted to the Journal of Open Source Software
★ 1 9y agoExplain → -
tutorial-devteam-projectmgt-2017 ▣
Resources for the dev team tutorial on JupyterHub 2017-02-24
★ 1 9y agoExplain → -
council
This repository provides a standardized process for community members to submit formal requests to the Executive Committee (EC) or Software Security Council (SSC).
★ 0 29d agoExplain → -
.github
No description.
★ 0 1y agoExplain → -
markdown
Specify the Jupyter Markdown flavor.
★ 0 2y agoExplain → -
jupytercon2023 ▣
No description.
★ 0 3y agoExplain → -
team-compass-template
A template for team-compass repositories
Python ★ 0 3y agoExplain →
No repos match these filters.