README.md

Workspaces

Setup

Create workspace and initialize git repository.

PROJECT="project_name"
VERSION="3.11" # Minor version
mkdir -p $PROJECT
cd $PROJECT
git init
cat > .gitignore <<EOF
.venv
__pycache__
*.pyc
.ipynb_checkpoints
EOF

Create Python virtual environment and install Jupyter kernel.

# Run on host machine terminal
"python${VERSION}" -m venv .venv
source .venv/bin/activate
pip install ipykernel nbconvert

Add kernel to JupyterHub.

# Run inside JupyterHub integrated terminal
python -m ipykernel install --user --name=$PROJECT

Push the repository to GitHub when ready and update the README with a link to the new workspace.