Metadata-Version: 2.1
Name: vibecheck
Version: 0.0.5
Summary: vibecheck is a Python library for getting hyperlocal feedback from notebook users.
Home-page: https://github.com/KordingLab/vibecheck/tarball/0.0.5
Author: Jordan Matelsky
Author-email: opensource@matelsky.com
License: Apache 2.0
Keywords: datatops,serverless,jupyter,notebook
Description-Content-Type: text/markdown
License-File: LICENSE


# jupyter-vibecheck

A Jupyter Widget to get atomic feedback as a student progresses through a didactic jupyter notebook.

## Setup

```
pip install vibecheck datatops
```

## Usage

```python
from vibecheck import DatatopsContentReviewContainer

DatatopsContentReviewContainer(
    "",  # No text prompt
    "W1D1-GD-Explanation-v1",
    {
        "url": "https://datatops-example-server.com",
        "name": "deep-learning-101",
        "user_key": "30d8xnd2",
    },
).render()
```

![image](https://user-images.githubusercontent.com/693511/234666584-f09e84af-148e-4cb0-aef4-68104b512dbf.png)

For more information, see the [documentation](./docs/).
