Skip to content

Latest commit

 

History

History
63 lines (48 loc) · 1.45 KB

README.md

File metadata and controls

63 lines (48 loc) · 1.45 KB
Raw

jupyter-paths

NPM

Pure JavaScript implementation of jupyter-paths.

npm install jupyter-paths

Usage

$ node
> var jp = require('jupyter-paths')

runtimeDir()

Returns immediately with the path to running kernels

> jp.runtimeDir()
'/Users/rgbkrk/Library/Jupyter/runtime'

dataDirs()

> jp.dataDirs()
[ '/Users/rgbkrk/Library/Jupyter',
  '/usr/share/jupyter',
  '/usr/local/share/jupyter' ]

If you want the paths to include the sys.prefix paths (for Anaconda installs), an optional opts parameter is accepted with key withSysPrefix. This changes the return to a promise for you instead.

> jp.dataDirs({ withSysPrefix: true })
Promise { <pending> }
> jp.dataDirs({ withSysPrefix: true }).then(console.log)
Promise { <pending> }
> [ '/Users/rgbkrk/Library/Jupyter',
  '/usr/local/Cellar/python/2.7.11/Frameworks/Python.framework/Versions/2.7/share/jupyter',
  '/usr/share/jupyter',
  '/usr/local/share/jupyter' ]

configDirs()

Like dataDirs, an optional opts parameter is accepted with key withSysPrefix as an argument.

> jp.configDirs({ withSysPrefix: true }).then(console.log)
Promise { <pending> }
> [ '/Users/rgbkrk/.jupyter',
  '/usr/local/Cellar/python/2.7.11/Frameworks/Python.framework/Versions/2.7/etc/jupyter',
  '/usr/local/etc/jupyter',
  '/etc/jupyter' ]