vibecheck

Name	vibecheck JSON
Version	0.0.5 JSON
	download
home_page	https://github.com/KordingLab/vibecheck/tarball/0.0.5
Summary	vibecheck is a Python library for getting hyperlocal feedback from notebook users.
upload_time	2024-02-09 21:09:46
maintainer
docs_url	None
author	Jordan Matelsky
requires_python
license	Apache 2.0
keywords	datatops serverless jupyter notebook
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            
# 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/).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/KordingLab/vibecheck/tarball/0.0.5",
    "name": "vibecheck",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "datatops,serverless,jupyter,notebook",
    "author": "Jordan Matelsky",
    "author_email": "opensource@matelsky.com",
    "download_url": "https://files.pythonhosted.org/packages/76/03/03f63484bb432235c09563aefdaa1b1ce4bd849aaeeb7a3e4be43cfdb1aa/vibecheck-0.0.5.tar.gz",
    "platform": null,
    "description": "\n# jupyter-vibecheck\n\nA Jupyter Widget to get atomic feedback as a student progresses through a didactic jupyter notebook.\n\n## Setup\n\n```\npip install vibecheck datatops\n```\n\n## Usage\n\n```python\nfrom vibecheck import DatatopsContentReviewContainer\n\nDatatopsContentReviewContainer(\n    \"\",  # No text prompt\n    \"W1D1-GD-Explanation-v1\",\n    {\n        \"url\": \"https://datatops-example-server.com\",\n        \"name\": \"deep-learning-101\",\n        \"user_key\": \"30d8xnd2\",\n    },\n).render()\n```\n\n![image](https://user-images.githubusercontent.com/693511/234666584-f09e84af-148e-4cb0-aef4-68104b512dbf.png)\n\nFor more information, see the [documentation](./docs/).\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "vibecheck is a Python library for getting hyperlocal feedback from notebook users.",
    "version": "0.0.5",
    "project_urls": {
        "Homepage": "https://github.com/KordingLab/vibecheck/tarball/0.0.5"
    },
    "split_keywords": [
        "datatops",
        "serverless",
        "jupyter",
        "notebook"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "760303f63484bb432235c09563aefdaa1b1ce4bd849aaeeb7a3e4be43cfdb1aa",
                "md5": "bec9b50f12dcdf10ad4d42cd181a5105",
                "sha256": "d5dff8372e2334941446093782b580082925ab50ef462b7e9336d8652d237d16"
            },
            "downloads": -1,
            "filename": "vibecheck-0.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "bec9b50f12dcdf10ad4d42cd181a5105",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8222,
            "upload_time": "2024-02-09T21:09:46",
            "upload_time_iso_8601": "2024-02-09T21:09:46.230827Z",
            "url": "https://files.pythonhosted.org/packages/76/03/03f63484bb432235c09563aefdaa1b1ce4bd849aaeeb7a3e4be43cfdb1aa/vibecheck-0.0.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 21:09:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "KordingLab",
    "github_project": "vibecheck",
    "github_not_found": true,
    "lcname": "vibecheck"
}