heymans


Nameheymans JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryAI tutor for education
upload_time2025-08-30 12:44:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords ai chatbot llm education
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Heymans AI tutor

Copyright 2024-2025 University of Groningen, developed by @smathot and @wkruijne

Heymans AI tutor is a Python library and web app for LLM-based teaching tools. The initial focus will be on automated grading of open exams and interactive quizzes.

This software is in early stages of development and not ready for production.


## Dependencies

For Python dependencies, see `pyproject.toml`. Python 3.10 or later is required. In addition to these, a local `redis` server needs to run for persistent data between sessions. `pandoc` needs to be installed for generating invidual feedback reports.

## Using as Python library

See `example/heymans-brightspace-example.py` for an example of how to grade an open-ended exam. This example assumes that you're using the Brightspace learning environment. The example folder also contains example output that is generated during grading.


## Running as web server (development)

Download the source code, and in the folder of the source code execute the following:

```
pip install .               # install dependencies
python app.py               # start the app
```

Next, access the app (by default) through:

```
http://127.0.0.1:5000/app/quiz
```


## License

Heymans is distributed under the terms of the GNU General Public License 3. The full license should be included in the file `COPYING`, or can be obtained from:

- <http://www.gnu.org/licenses/gpl.txt>


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "heymans",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "ai, chatbot, llm, education",
    "author": null,
    "author_email": "Sebastiaan Math\u00f4t <s.mathot@rug.nl>, Wouter Kruijne <w.kruijne@rug.nl>",
    "download_url": "https://files.pythonhosted.org/packages/91/39/797ec1f2d35a6a3c3828445f736a2bb4093540e00bad6f8f3e25da602d69/heymans-0.1.0.tar.gz",
    "platform": null,
    "description": "# Heymans AI tutor\n\nCopyright 2024-2025 University of Groningen, developed by @smathot and @wkruijne\n\nHeymans AI tutor is a Python library and web app for LLM-based teaching tools. The initial focus will be on automated grading of open exams and interactive quizzes.\n\nThis software is in early stages of development and not ready for production.\n\n\n## Dependencies\n\nFor Python dependencies, see `pyproject.toml`. Python 3.10 or later is required. In addition to these, a local `redis` server needs to run for persistent data between sessions. `pandoc` needs to be installed for generating invidual feedback reports.\n\n## Using as Python library\n\nSee `example/heymans-brightspace-example.py` for an example of how to grade an open-ended exam. This example assumes that you're using the Brightspace learning environment. The example folder also contains example output that is generated during grading.\n\n\n## Running as web server (development)\n\nDownload the source code, and in the folder of the source code execute the following:\n\n```\npip install .               # install dependencies\npython app.py               # start the app\n```\n\nNext, access the app (by default) through:\n\n```\nhttp://127.0.0.1:5000/app/quiz\n```\n\n\n## License\n\nHeymans is distributed under the terms of the GNU General Public License 3. The full license should be included in the file `COPYING`, or can be obtained from:\n\n- <http://www.gnu.org/licenses/gpl.txt>\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "AI tutor for education",
    "version": "0.1.0",
    "project_urls": {
        "Source": "https://github.com/rug-gmw/heymans"
    },
    "split_keywords": [
        "ai",
        " chatbot",
        " llm",
        " education"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e93a1312ccd78fdf6aac32895563da770190466c318e78d66f9345e4b043bb96",
                "md5": "01228c93fa69c2d6ea126c5dafb8e81f",
                "sha256": "fa9d7e2b4df2b08d85c4f411543d27b4b7e86f2619d488cafed9091713fbc844"
            },
            "downloads": -1,
            "filename": "heymans-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "01228c93fa69c2d6ea126c5dafb8e81f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 173118,
            "upload_time": "2025-08-30T12:44:19",
            "upload_time_iso_8601": "2025-08-30T12:44:19.136467Z",
            "url": "https://files.pythonhosted.org/packages/e9/3a/1312ccd78fdf6aac32895563da770190466c318e78d66f9345e4b043bb96/heymans-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "9139797ec1f2d35a6a3c3828445f736a2bb4093540e00bad6f8f3e25da602d69",
                "md5": "f2f26cadb30ac5e82b1e2460b0cd72ca",
                "sha256": "c2045aa2c62eb274c8accd5f1501112113e8bdc33a1d890e9a803c711aa08f00"
            },
            "downloads": -1,
            "filename": "heymans-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "f2f26cadb30ac5e82b1e2460b0cd72ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 160020,
            "upload_time": "2025-08-30T12:44:20",
            "upload_time_iso_8601": "2025-08-30T12:44:20.524206Z",
            "url": "https://files.pythonhosted.org/packages/91/39/797ec1f2d35a6a3c3828445f736a2bb4093540e00bad6f8f3e25da602d69/heymans-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-30 12:44:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rug-gmw",
    "github_project": "heymans",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "heymans"
}
        
Elapsed time: 1.02063s