Project Jupyter

https://docs.jupyter.org/en/latest
Admin
Project Jupyter is a large umbrella project providing tools and standards for interactive computing...
Tokens:112,931
Snippets:936
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Start boot2docker VM

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/boot2docker.html

Starts the boot2docker virtual machine.

```bash
$ boot2docker up
```

--------------------------------

### Start IPython from source

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/testing.html

Runs IPython from the source directory without installing it system-wide.

```python
python2 -c "import IPython; IPython.start_ipython();"
```

--------------------------------

### Start IPython notebook from source

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/testing.html

Starts the web-based notebook interface from the source directory.

```python
python2 -c "import IPython; IPython.start_ipython(['notebook']);"
```

--------------------------------

### Install IPython in development mode

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/testing.html

Installs IPython so that the iptest script becomes available system-wide.

```python
python setup.py develop
```

--------------------------------

### Install notebook extensions with IPython

Source: https://docs.jupyter.org/en/latest/use/advanced/migrating.html

Old command for installing notebook extensions before migration. Use with optional --user flag.

```bash
ipython install-nbextension [--user] EXTENSION
```

--------------------------------

### Install kernel specs with IPython

Source: https://docs.jupyter.org/en/latest/use/advanced/migrating.html

Old command for installing kernel specs before migration. Use with optional --user flag.

```bash
ipython kernelspec install [--user] KERNEL
```

--------------------------------

### Install Notebook 7.5.0a1 with pip

Source: https://docs.jupyter.org/en/latest/community/community-call-notes/2025-september.html

Command to install the Notebook 7.5.0a1 alpha release for testing.

```bash
pip install notebook==7.5.0a1
```

--------------------------------

### Install sphinx from PyPI

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/documenting_ipython.html

Install the latest version of sphinx using pip. This is a prerequisite for building the documentation.

```bash
pip install sphinx
```

--------------------------------

### Install additional documentation packages

Source: https://docs.jupyter.org/en/latest/contributing/docs-contributions/getting-started.html

Install the additional packages needed for building the documentation: sphinxcontrib-spelling, sphinx_rtd_theme, nbsphinx, pyenchant, recommonmark 0.4.0, and jupyter_sphinx_theme.

```bash
pip install sphinxcontrib-spelling sphinx_rtd_theme nbsphinx pyenchant recommonmark==0.4.0 jupyter_sphinx_theme
```

--------------------------------

### Build distributions

Source: https://docs.jupyter.org/en/latest/contributing/dev-contributions/releasing.html

Builds the source distribution as gztar and the wheel distribution using setup.py.

```bash
python setup.py sdist --formats=gztar
python setup.py bdist_wheel
```

--------------------------------

### Open built HTML documentation in browser

Source: https://docs.jupyter.org/en/latest/contributing/docs-contributions/getting-started.html

Open the built HTML documentation in your browser. The example location provided is `build/html`.

```bash
open build/html/index.html
```

--------------------------------

### Run Jupyter Notebook

Source: https://docs.jupyter.org/en/latest/install/notebook-classic.html

After installing Anaconda, run this command in the terminal to start the Jupyter Notebook interface.

```bash
jupyter notebook
```

--------------------------------

### Basic IPython directive example with renumbered prompts

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/sphinx_directive.html

Shows a ReST code block using the ipython directive. The prompts are renumbered starting at 1, and the output is inserted from the embedded interpreter.

```reStructuredText
.. code:: python3

   In [136]: x = 2

   In [137]: x**3
   Out[137]: 8

```

--------------------------------

### Terminal output when starting the notebook server

Source: https://docs.jupyter.org/en/latest/running.html

Example output shown in the terminal after running 'jupyter notebook'. It includes the serving directory, active kernels, the server URL (default http://localhost:8888/), and the Control-C shortcut to stop the server.

```bash
$ jupyter notebook
[I 08:58:24.417 NotebookApp] Serving notebooks from local directory: /Users/catherine
[I 08:58:24.417 NotebookApp] 0 active kernels
[I 08:58:24.417 NotebookApp] The Jupyter Notebook is running at: http://localhost:8888/
[I 08:58:24.417 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).
```

--------------------------------

### GET /new

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/rest_api.html

Creates a new notebook with profile (or default, if no profile exists) settings.

```APIDOC
## GET /new

### Description
Creates a new notebook with profile (or default, if no profile exists) settings.

### Method
GET

### Endpoint
/new

### Response
#### Success Response (200)
- Creates a new notebook with profile settings.

```

--------------------------------

### Install notebook extensions with Jupyter

Source: https://docs.jupyter.org/en/latest/use/advanced/migrating.html

New command for installing notebook extensions after migration. Use with optional --user flag. Extensions are installed in a system-wide location or JUPYTER_DATA_DIR for --user installs.

```bash
jupyter nbextension install [--user] EXTENSION
```

--------------------------------

### Install kernel specs with Jupyter

Source: https://docs.jupyter.org/en/latest/use/advanced/migrating.html

New command for installing kernel specs after migration. Use with optional --user flag. Kernel specs are installed in a system-wide location or JUPYTER_DATA_DIR for --user installs.

```bash
jupyter kernelspec install [--user] KERNEL
```

--------------------------------

### Get help about notebook server options with --help

Source: https://docs.jupyter.org/en/latest/running.html

The notebook server provides help messages for other command line arguments using the --help flag.

```bash
jupyter notebook --help
```

--------------------------------

### Install Jupyter package from source with pip install .

Source: https://docs.jupyter.org/en/latest/contributing/dev-contributions/index.html

Run this command in the source directory of a Jupyter package to install it. Most Jupyter packages can be installed this way, but the notebook requires additional steps for building Javascript components.

```bash
pip install .
```

--------------------------------

### Show help options

Source: https://docs.jupyter.org/en/latest/use/config.html

Pass --help or --help-all to see abbreviated options. --help shows short options, --help-all includes options without short names.

```bash
jupyter {application} --help       # Just the short options
jupyter {application} --help-all   # Includes options without short names
```

--------------------------------

### Initialize boot2docker VM

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/boot2docker.html

Initializes the boot2docker virtual machine.

```bash
$ boot2docker init
```

--------------------------------

### List running Docker containers

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/boot2docker.html

Shows running containers after setting shellinit, with example output.

```bash
$ $(boot2docker shellinit)
$ docker ps
CONTAINER ID        IMAGE               COMMAND             CREATED             STATUS              PORTS                    NAMES
f6065f206519        ipython             "/bin/bash"         1 minutes ago       Up 1 minutes        0.0.0.0:8888->8888/tcp   ipython-dev
```

--------------------------------

### Install JupyterLab 4.5.0a3 with pip

Source: https://docs.jupyter.org/en/latest/community/community-call-notes/2025-september.html

Command to install the JupyterLab 4.5.0a3 alpha release for testing.

```bash
pip install jupyterlab==4.5.0a3
```

--------------------------------

### Install boot2docker and docker via Homebrew on macOS

Source: https://docs.jupyter.org/en/latest/contributing/ipython-dev-guide/boot2docker.html

Installs boot2docker and docker using Homebrew on macOS.

```bash
$ brew install boot2docker docker
```
Tokens:
Raw