jp-CoffeeScript: A CoffeeScript Kernel for the Jupyter Notebook
jp-CoffeeScript is an npm package that implements a
CoffeeScript kernel for the Jupyter notebook). A Jupyter
notebook combines the creation of rich-text documents (including equations,
plots and videos) with the execution of code in a number of programming
languages.
jp-CoffeeScript provides 5 executables: jp-coffee-install,
jp-coffee-notebook, jp-coffee-console, jp-coffee-kernel and jp-coffee.
Their purpose and basic use is described in the sections below. Please, refer to
the usage notes for
further details.
jp-coffee-install registers the jp-CoffeeScript kernel with Jupyter, so that
other tools (e.g. the Jupyter notebook) can invoke it. The following command
flags are recognised:
--debug enable debug messages
--help show this help
--hide-undefined do not show undefined results
--install=[local|global] install kernel for current user or globally
--protocol=version set messaging protocol version, e.g. 5.0
--show-undefined show undefined results
--spec-path=[none|full] set whether kernel spec uses full paths
--startup-script=path run script on kernel startup
(path can be a file or a folder)
--version show kernel version
--versions show kernel and library versions
--working-dir=path set kernel working directory
(default = current working directory)
jp-coffee-notebook: jp-CoffeeScript notebook
After running jp-coffee-install, Jupyter notebook users can invoke the Jupyter
notebook as usual. jp-coffee-notebook is provided for convenience to users of
the IPython notebook prior to version 3. jp-coffee-notebook is a wrapper
around ipython notebook. It extends the command flags accepted by ipython notebook with the following:
--help show jp-CoffeeScript and notebook help
--jp-debug enable debug messages
--jp-help show this help
--jp-hide-undefined do not show undefined results
--jp-install=[local|global] install kernel for current user or globally
--jp-protocol=version set protocol version, e.g. 5.0
--jp-show-undefined show undefined results
--jp-spec-path=[none|full] set whether kernel spec uses full paths
--jp-startup-script=path run script on startup
(path can be a file or a folder)
--jp-working-dir=path set kernel working directory
(default = current working directory)
--version show kernel version
--versions show kernel and library versions
jp-coffee-console: jp-CoffeeScript console
jp-coffee-console is provided for convenience to users as a wrapper around
jupyter console. The following command flags are recognised:
--help show jp-CoffeeScript and notebook help
--jp-debug enable debug messages
--jp-help show this help
--jp-hide-undefined do not show undefined results
--jp-install=[local|global] install kernel for current user or globally
--jp-protocol=version set protocol version, e.g. 5.0
--jp-show-undefined show undefined results
--jp-spec-path=[none|full] set whether kernel spec uses full paths
--jp-startup-script=path run script on startup
(path can be a file or a folder)
--jp-working-dir=path set kernel working directory
(default = current working directory)
--version show kernel version
--versions show kernel and library versions
jp-coffee-kernel: jp-CoffeeScript kernel
jp-coffee-kernel is the executable invoked by Jupyter tools (e.g. the
notebook) and that appears in the kernel spec that jp-coffee-install creates
for jp-CoffeeScript. You won't need this command, unless you want to create a
custom kernel spec.
Usage:
jp-coffee-kernel [options] connection_file
Options:
--debug enable debug messages
--hide-undefined do not show undefined results
--protocol=Major[.minor[.patch]] set protocol version, e.g. 5.0
--session-working-dir=path set session working directory
--show-undefined show undefined results
--startup-script=path run script on startup
(path can be a file or a folder)
jp-coffee: Deprecated CLI
jp-coffee is provided for backwards-compatibility. It will be removed in the
next major-version update. Please, use jp-coffee-install or
jp-coffee-notebook instead.
Contributions
First of all, thank you for taking the time to contribute. The maintenance of
IJavascript is currently my priority. I would really appreciate some help.
Please, read CONTRIBUTING and use the issue
tracker for any
contributions: support requests, bug reports, enhancement requests, pull
requests, submission of tutorials, ...
请发表评论