Setup to get jupyter running in local using a virtualenv (created with pipenv)

jupyter_with_pipenv.md

Setup for running the following steps

export PROJECT_NAME=the_name_of_the_project
export PY_VERSION=3.10.5

mkdir $PROJECT_NAME
cd $PROJECT_NAME

Creating the virtualenv

pyenv local $PY_VERSION

pipenv install --python $PY_VERSION

git init
git add .
git commit -m "First commit for '$PROJECT_NAME'"

# Activate the virtualenv
pipenv shell

Installing dependencies

# Option 1: just installing for testing the package. It will not be added to the Pipfile
pip install requests

# Option 2: installing via pipenv for development -> it will be included in the Pipfile
pipenv install --dev requests

Installing jupyther & kernel

pipenv install jupyter ipykernel

# kernel for this virtualenv
python -m ipykernel install --user --name $PROJECT_NAME --display-name "$PROJECT_NAME - `python --version`"

Run jupyther

jupyter notebook

Cleanup all the stuff

# uninstall the kernel
jupyter kernelspec uninstall $PROJECT_NAME

pipenv --rm

Miscelanious

# list all the availables kernels for Jupyter
jupyter kernelspec list