jupyter_core 4.5

This documentation only describes the public API in the jupyter_core package. For overview information about using Jupyter, see the main Jupyter docs.

Contents:

Paths for Jupyter files

Specific directories

jupyter_core.paths.jupyter_config_dir()

Get the Jupyter config directory for this platform and user.

Returns JUPYTER_CONFIG_DIR if defined, else ~/.jupyter

jupyter_core.paths.jupyter_data_dir()

Get the config directory for Jupyter data files.

These are non-transient, non-configuration files.

Returns JUPYTER_DATA_DIR if defined, else a platform-appropriate path.

jupyter_core.paths.jupyter_runtime_dir()

Return the runtime dir for transient jupyter files.

Returns JUPYTER_RUNTIME_DIR if defined.

Respects XDG_RUNTIME_DIR on non-OS X, non-Windows, falls back on data_dir/runtime otherwise.

Search paths

jupyter_core.paths.jupyter_config_path()

Return the search path for Jupyter config files as a list.

jupyter_core.paths.jupyter_path(*subdirs)

Return a list of directories to search for data files

JUPYTER_PATH environment variable has highest priority.

If *subdirs are given, that subdirectory will be added to each element.

Examples:

>>> jupyter_path()
['~/.local/jupyter', '/usr/local/share/jupyter']
>>> jupyter_path('kernels')
['~/.local/jupyter/kernels', '/usr/local/share/jupyter/kernels']

Changes in jupyter-core

4.4

4.4.0

on GitHub

  • jupyter troubleshoot gets the list of packages from the Python environment it’s in, by using sys.executable to call pip list (PR #104).
  • Added utility function ensure_dir_exists, and switched to using it over the one from ipython_genutils, which does permissions wrong (PR #113).
  • Avoid creating the ~/.ipython directory when checking if it exists for config migration (PR #118).
  • Fix mistaken description in zsh completions (PR #98).
  • Fix subcommand tests on Windows (PR #103).
  • The README now describes how to work on jupyter_core and build the docs (PR #110).
  • Fix a broken link to a release in the docs (PR #109).

4.3

4.3.0

on GitHub

  • Add JUPYTER_NO_CONFIG environment variable for disabling all Jupyter configuration.
  • More detailed error message when failing to launch subcommands.

4.2

4.2.1

on GitHub

  • Fix error message on Windows when subcommand not found.
  • Correctly display PATH in jupyter troubleshoot on Windows.

4.2.0

on GitHub

  • Make jupyter directory top priority in search path for subcommands, so that jupyter-subcommand next to jupyter will always be picked if present.
  • Avoid using shell=True for subcommand dispatch on Windows.

4.1

4.1.1

on GitHub

  • Include symlink directory and real location on subcommand PATH when jupyter is a symlink.

4.1.0

on GitHub

  • Add jupyter.py module, so that python -m jupyter always works.
  • Add prototype jupyter troubleshoot command for displaying environment info.
  • Ensure directory containing jupyter executable is included when dispatching subcommands.
  • Unicode fixes for Legacy Python.

4.0

4.0.6

on GitHub

  • fix typo preventing migration when custom.css is missing

4.0.5

on GitHub

  • fix subcommands on Windows (yes, again)
  • fix migration when custom.js/css are not present

4.0.4

on GitHub

  • fix subcommands on Windows (again)
  • ensure jupyter --version outputs to stdout

4.0.3

on GitHub

  • setuptools fixes needed to run on Windows

4.0.2

on GitHub

  • fixes for jupyter-migrate

4.0.1

on GitHub

This is the first release of the jupyter-core package.

Indices and tables