Helium
Let Sublime Text talk with Jupyter.
Details
Installs
- Total 12K
- Win 5K
- Mac 4K
- Linux 3K
Oct 8 | Oct 7 | Oct 6 | Oct 5 | Oct 4 | Oct 3 | Oct 2 | Oct 1 | Sep 30 | Sep 29 | Sep 28 | Sep 27 | Sep 26 | Sep 25 | Sep 24 | Sep 23 | Sep 22 | Sep 21 | Sep 20 | Sep 19 | Sep 18 | Sep 17 | Sep 16 | Sep 15 | Sep 14 | Sep 13 | Sep 12 | Sep 11 | Sep 10 | Sep 9 | Sep 8 | Sep 7 | Sep 6 | Sep 5 | Sep 4 | Sep 3 | Sep 2 | Sep 1 | Aug 31 | Aug 30 | Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 1 | 0 | 3 | 1 | 0 | 0 | 2 | 1 | 4 | 1 | 3 | 2 | 0 | 2 | 2 | 0 | 2 | 5 | 1 | 1 | 0 | 1 | 0 | 0 | 1 | 2 | 0 | 1 | 0 | 2 | 4 | 0 | 1 | 1 | 0 |
Mac | 1 | 0 | 1 | 1 | 0 | 1 | 1 | 1 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 2 | 1 | 2 | 2 | 0 | 3 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 1 | 0 | 2 | 1 | 2 | 1 | 1 | 0 | 0 | 2 | 0 | 1 | 2 | 1 | 0 | 0 | 0 | 1 |
Linux | 2 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 2 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 2 | 0 | 2 | 1 | 1 | 1 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 1 |
Readme
- Source
- raw.githubusercontent.com
Helium package for Sublime Text
Helium is a package for Sublime Text, which provides in-editor code execution and autocomplete in interaction with Jupyter kernels. The concept of an editor extension communicating Jupyter kernels is inspired by @nteract's splendid Atom package Hydrogen. I want something like it in Sublime Text, too.
Any feedback is highly welcome. I hope this package will help your life with ST3!
Installation
Now this package is under the package control channel!
You can install it with Package Control plugin, run Package Control: Install Package
, then choose Helium
from the package list.
Usage
Connecting to Jupyter kernels
1. The most basic way, start a kernelspec installed locally, as a subprocess of ST3 (the process stops when Sublime stops)
- Run
Helium: connect kernel
command. - Choose
New kernel
. - Choose the kernelspec you want to run.
2. Connect to the kernel already runnning and connected to Helium
- Run
Helium: connect kernel
command. - Choose the kernel you want to connect.
3. Connect to a kernel already running under some other Jupyter app (such as Notebook)
- Get connection info of the kernel. The way to get connection info differ among kernels, see the doc of each kernel (in ipython kernel, you can get it by
%connect_info
magic.) - Run
Helium: connect kernel
command. - Choose
New kernel
. - Choose
(Enter connection info)
. - Enter the connection info (Helium accepts a path or connection info itself).
Using Python kernel installed via Conda
Python kernel installed via Conda is not found by Jupyter by default. You should add the path to kernel into the jupyter_path
entry of the config file.
Execution
Execute code by Helium: Execute Block
(whose command name is helium_execute_block
).
Code cell
Regions surrounded by # %%
or # <codecell>
(you can configure it in cell_delimiter_pattern
option item) are considered as “code cells”.
You can execute a region by Helium: Execute cell
(helium_execute_cell
) or Helium: Execute Cell and Move
command.
Each cell has a clickable “Run Cell” phantom that appears next to the cell markers to run the cell.
Object inspection
Get Object Inspection by Helium: Get Object Inspection
(whose command name is helium_get_object_inspection
).
Autocomplete
You should be able to get autocomplete from the kernel from the time you connected. If you don't want autocomplete, set "complete"
as false
in setting file.
Other kernel manipulations
You can restart, shutdown, and interrupt process via Helium: Restart Kernel
, Helium: Shutdown Kernel
, Helium: Interrupt Kernel
commands.
You can also run these command as a submenu of Helium: List Kernels
command.
Motivation of development
Why using Jupyter?
We can execute code, retrieve results including images, get completions and object inspections by the Jupyter protocol regardless of the interpreter implementation of languages if it has Jupyter kernel. If we try to do that by directly running interpreters there should be several interpreter-specific problems, but we can entrust the kernel maintainers on language-specific problems by using Jupyter.
Why not using Jupyter Notebook?
I admit Jupyter Notebook is a powerful tool for instantly sharing small analysis work, exploring data or APIs, or making executable tutorials. Yes, I often use it, too.
However, in my opinion, it is not suited for projects with large code bases.
I want to jumpt across files instantly, make modules organized (not saved as .ipynb
s), kick scripts with various parameters, and make project code more reusable and reproducible… but still I want to edit them with interactive feedback.