Skip to main content

hintbot

A JupyterLab extension that generates AI-powered hints based on students' buggy code and reflection.

This extension is composed of a Python package named hintbot for the server extension and a NPM package named hintbot for the frontend extension.

Workflow

  1. Consent the use of the extension

  1. (Optional) View explanations of the three hint types

  1. Click one of the type buttons to request hint

  1. (Optional) Reflect on the problem

  1. Retrieve AI-generated hints based on the buggy code and reflection

  1. View and evaluate AI hints

  1. (Optional) Request instructor help if the AI hints are not helpful

  1. Review previous hint

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install hintbot

Uninstall

To remove the extension, execute:

pip uninstall hintbot

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

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 hintbot directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable hintbot
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable hintbot
pip uninstall hintbot

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 hintbot within that folder.

Packaging the extension

See RELEASE

Metadata

Release files for hintbot 4.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hintbot 4.0.2
File Size Uploaded Provenance Actions
hintbot-4.0.2.tar.gz 1.9 MB Without provenance Details for hintbot-4.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for hintbot 4.0.2
File Interpreter ABI Platform Actions
hintbot-4.0.2-py3-none-any.whl Python 3 none any Details for hintbot-4.0.2-py3-none-any.whl

Total release size: 2.0 MB

Release files / hintbot-4.0.2.tar.gz

Download URL hintbot-4.0.2.tar.gz
Size 1.9 MB
Tags Source
SHA-256 checksum
How to use checksums
c1d22f080dbdb4496a462280a143aaf48222cfcdc3645968a774addee8b7f4e8
BLAKE2b-256 checksum
How to use checksums
d50d1fc2e93a254d1e1e8377424df977820a811c52eaeaae830d0306a26a4150
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Release files / hintbot-4.0.2-py3-none-any.whl

Download URL hintbot-4.0.2-py3-none-any.whl
Size 55.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c39bad8924610d841c3a8ea41bfb801b21124cf0de37994c7432d042f033a464
BLAKE2b-256 checksum
How to use checksums
75c63e47494101f285d7ccf4ea0eee62aa4ccb8ce8258e0182cd662ff80e6e0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.12.2

Security for hintbot 4.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page