jupytutor

A Jupyter extension for providing students LLM feedback based on autograder results and supplied course context.

Requirements

• JupyterLab >= 4.0.0
• Python >= 3.9

Installation

pip install jupytutor

Configuration

jupytutor supports custom configuration through a JSON file in your home directory.

Quick Setup

1. Create the config directory:

   mkdir -p ~/.config/jupytutor
   

2. Create the config file at

   ~/.config/jupytutor/config.json
   

3. Edit the config file with your settings (reference the jupytutor repository (https://github.com/kevyg03/jupytutor), src/config.ts)

4. Restart JupyterLab

The config.json can only contain keys that exist in src/config.ts. Keys that aren't provided will default to the values set by config.ts.

Testing Locally

Create a new conda environment (conda create -n <env_name>) and enter it, then run:

pip install jupytutor

From another terminal in the same environment, run

jupyter lab

Right click and hit "Inspect Element" and navigate to "Console" to confirm everything is activated.

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupytutor directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall jupytutor

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupytutor within that folder.

Packaging the extension

See RELEASE