Is there a way to use pipenv with Jupyter notebook?
Or more specifically, with an atom nteract/hydrogen python 3 kernel?
Add a comment
|
5 Answers
Just tried the following with success.
In your project folder:
pipenv install ipykernel
pipenv shell
This will bring up a terminal in your virtualenv like this:
(my-virtualenv-name) bash-4.4$
In that shell do:
python -m ipykernel install --user --name=my-virtualenv-name
Launch jupyter notebook:
jupyter notebook
In your notebook, Kernel -> Change Kernel. Your kernel should now be an option.
Source: IPythonNotebookVirtualenvs
8 Comments
u-phoria
Works great, thanks. To inline the virtualenv name lookup:
python -m ipykernel install --user --name=`basename $VIRTUAL_ENV` 
chrisfauerbach
This worked perfectly for me. I had to get my env name with 'which python' while in my pipenv shell
ClaytonJY
is it possible to further avoid the ipykernel dependency, by using a standard kernel that somehow points to the virtualenv? I'm thinking of projects where I want to use jupyter, but others may not. I'd prefer to avoid anything specific to me in the pipenv deps.
ClaytonJY
Note the ipykernel can be installed with one-line commands as well:
pipenv run python -m ipykernel install --user --name=`pipenv run basename '$VIRTUAL_ENV'` (standard config, venvs in ~/.venv/) pipenv run python -m ipykernel install --user --name=`pipenv run dirname '$VIRTUAL_ENV' | xargs basename` (when PIPENV_VENV_IN_PROJECT=1)Jim
@ClaytonJY I found out that I'm wrong, using pip install ipykernel in pipenv shell is same as pipenv install ipykernel. The only difference is pipenv install will record package to Pipfile and pip install doesn't.
|
Install and start jupyter inside pipenv:
pipenv install jupyter
pipenv run jupyter notebook
Any other packages that are installed via pipenv (e.g. pipenv install numpy) will also be available to your jupyter notebook session.
1 Comment
Kevin Wittek
This is also the most simple way for me. I just wonder, is this idiomatic? Quite contrary to how this would be done in other languages.
Luis' answer works perfectly for jupyter notebooks.
But for hydrogen/atom specifically the recipe is:
pipenv install ipykernel
pipenv shell
launch atom from within the pipenv shell
> atom
Should be good to go!
1 Comment
David Folkner
For use here...I still had to do the
python -m ipykernel install --user --name=my-virtualenv-name command.My answer is based on previous answers, but I found one more step was necessary (pipenv install notebook). So in total:
Step 1. On terminal, first install both jupyter and (jupyter) notebook. In my experience, the latter had to be explicitly installed:
pipenv install jupyter notebook
Step 2. Install the Pipenv kernelspec for jupyter (modified from u-phoria's comment).
pipenv run python -m ipykernel install --user --name=`basename $VIRTUAL_ENV`
Now the following should work:
pipenv run jupyter notebook
Note: If in the Pipenv shell for the virtual environment, pipenv run can be removed from the above. If Pipenv is being forced to ignore virtual environments, the run commands should be run in the shell for the environment
For the original question of using Atom, it can then be run by this pipenv:
pipenv run atom
Comments
In previous answers is assumed that IPython is part of Pipenv. If it is not and you want
to work in Pipenv from Jupyter Notebook do:
pipenv install ipykernel
pipenv shell
ipython kernel install --name=`basename $VIRTUAL_ENV` --user
jupyther notebook
# select .venv kernel
Note that ipython installation is made.
5 Comments
Chris
This just repeats the highly-voted, seven and a half year old, accepted answer with less detail. Please don't repeat answers.
zashto
Sorry. Where is pointed out that
ipython could be used?Chris
That answer uses slightly different syntax to invoke the same command:
python -m ipykernel install....zashto
It doesn't work for me. I've tried. May be because
ipython is outside the pipenv. By the way in the given URL (help.pythonanywhere.com/pages/IPythonNotebookVirtualenvs) ipython is used.Chris
ipython probably shouldn't be outside the virtual environment. In any case, that's a detail of how you've set up your system, not something inherent to the question.