Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/liffiton/gen-ed
Gen-Ed is a framework for building web applications that use generative AI (LLMs) for education.
https://github.com/liffiton/gen-ed
Last synced: 3 months ago
JSON representation
Gen-Ed is a framework for building web applications that use generative AI (LLMs) for education.
- Host: GitHub
- URL: https://github.com/liffiton/gen-ed
- Owner: liffiton
- Created: 2023-12-31T02:19:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-20T02:05:43.000Z (3 months ago)
- Last Synced: 2024-11-01T04:42:32.629Z (3 months ago)
- Language: Python
- Homepage:
- Size: 3.03 MB
- Stars: 17
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSES/AGPL-3.0-only.txt
Awesome Lists containing this project
README
Gen-Ed: Generative AI for Education
===================================
Gen-Ed is a framework for building web applications that use generative AI
(LLMs) for education (i.e., organized around instructors and their classes of
students for use in teaching and learning contexts).
The framework provides most of the common functionality any application of this
type might need, including:
- Authentication, including single-sign-on from Google, Github, and Microsoft.
- Class enrollment, with separate instructor and student roles.
- Connecting to LMSes via LTI (for automatic authentication and enrolling).
- Class management and data export.
- Admin interfaces.
The repository also contains two applications that are built on Gen-Ed:
1. **CodeHelp** [1,2]: A tool for assisting students in computer science
classes without giving them solution code.
2. **Starburst**: A topic-exploration tool for writing assignments.
#### References
[1] [CodeHelp: Using Large Language Models with Guardrails for Scalable Support
in Programming Classes](https://arxiv.org/abs/2308.06921). Mark Liffiton, Brad
Sheese, Jaromir Savelka, and Paul Denny. 2023. In Proceedings of the 23rd Koli
Calling International Conference on Computing Education Research (Koli Calling
'23). DOI: [10.1145/3631802.3631830](https://doi.org/10.1145/3631802.3631830)
[2] [Patterns of Student Help-Seeking When Using a Large Language Model-Powered
Programming Assistant](https://arxiv.org/abs/2310.16984). Brad Sheese, Mark
Liffiton, Jaromir Savelka, and Paul Denny. 2024. In Proceedings of the 26th
Australasian Computing Education Conference (ACE '24). DOI:
[10.1145/3636243.3636249](https://doi.org/10.1145/3636243.3636249)
Install
-------
Requires Python 3.10 or higher.
1. Create and activate a Python virtual environment.
(E.g., `python3 -m venv venv; source venv/bin/activate`)
2. Install the Gen-Ed package and bundled applications in 'editable' mode:
```sh
pip install -e .
```
Set Up an Application
---------------------
1. In the root of the repository, create `.env` and populate it:
```
FLASK_INSTANCE_PATH=[path to an instance folder -- for storing the DB, etc. -- commonly "instance"]
SECRET_KEY=[a secure random string -- used to sign session cookies]
OPENAI_API_KEY=[your OpenAI API key]
```
*Optionally*, if you want to allow logins from 3rd party authentication
providers, set any of the following pairs with IDs/secrets obtained from
registering your application with the given provider:
```
GOOGLE_CLIENT_ID=[...]
GOOGLE_CLIENT_SECRET=[...]
GITHUB_CLIENT_ID=[...]
GITHUB_CLIENT_SECRET=[...]
MICROSOFT_CLIENT_ID=[...]
MICROSOFT_CLIENT_SECRET=[...]
```
Then, to set up an application (CodeHelp, for example):
2. Initialize database:
```sh
flask --app codehelp initdb
```
3. Create at least one admin user:
```sh
flask --app codehelp newuser --admin [username]
```
This will create and display a randomly-generated password.
To change the password:
```sh
flask --app codehelp setpassword [username]
```
4. (Optional) To serve files from `/.well-known` (for domain verification,
etc.), place the files in a `.well-known` directory inside the Flask
instance folder.
Running an Application
----------------------
For example, to run the CodeHelp app:
```sh
flask --app codehelp run
# or, during development:
flask --app codehelp --debug run
```
Running Tests
-------------
First, install test dependencies:
```sh
pip install -e .[test]
```
Run all tests:
```sh
pytest
```
For code coverage report:
```sh
pytest --cov=src/gened --cov=src/codehelp --cov-report=html && xdg-open htmlcov/index.html
```
For mypy type checking:
```sh
mypy
```
Developing
----------
See `DEVELOPING.md` for additional instructions and information for developing
an application and/or contributing to the project.
Author
------
Gen-Ed and the included applications are by Mark Liffiton.
Licenses
--------
Gen-Ed and the included applications are licensed under the GNU Affero General
Public License version 3 (AGPL-3.0-only).
Brand icons from [Simple Icons](https://simpleicons.org/) are licensed under
CC0-1.0. Other icons from [Lucide](https://lucide.dev/) are licensed under the
Lucide ISC license.
For the text of these licenses, see the LICENSES directory.