Skip to content

Automates grading of student submissions using AI and provides detailed feedback via CLI.

License

Notifications You must be signed in to change notification settings

michael-borck/gradebot-guru

GradeBot Guru: Your AI Grading Assistant 👨‍🏫🤖

PyPI Version License

GradeBot Guru is your friendly AI-powered grading assistant, designed to automate the evaluation of student submissions and provide fast, accurate, and insightful feedback.

Table of Contents

Features ✨

  • Automated Grading: Quickly and consistently grade student work based on a provided rubric.
  • Detailed Feedback: Generate personalized feedback highlighting strengths and areas for improvement.
  • Configurable LLM: Choose your preferred Large Language Model (LLM) provider (e.g., Gemini).
  • Easy-to-Use CLI: Simple and intuitive command-line interface for seamless integration into your workflow.

Installation 🛠️

  1. Install from PyPI:

    pip install gradebot-guru
  2. Install from Source (Development Setup):

    git clone https://github.com/teaching-repositories/gradebot-guru.git
    cd gradebot-guru
    uv sync --all-extras --dev

Usage 🚀

gradebot-guru --config <config_path> --submissions <submissions_dir>
  • <config_path>: Path to the configuration file (JSON format with LLM settings and rubric path).
  • <submissions_dir>: The path to the directory containing student submissions (e.g., essays, code).

Configuration ⚙️

  • LLM Provider: Set your preferred LLM provider in the configuration file (config.py). Currently supports Gemini.

Examples 📚

# Basic usage with demo configuration
gradebot-guru --config demo/config.json --submissions demo/text-submissions

# Using custom configuration
gradebot-guru --config my-config.json --submissions ./student-essays

Development 👩‍💻

  1. Running Tests:

    uv run pytest
  2. Code Formatting and Linting:

    uv run ruff format .
    uv run ruff check .
  3. Type Checking:

    uv run mypy .
  4. Building Documentation:

    uv run mkdocs serve

Contributing 🙌

Contributions are welcome! Please see the Contributing Guidelines for more details.

License 📄

This project is licensed under the MIT License. See the LICENSE file for details.

Contact 📬

For questions or feedback, please contact Michael Borck at michael@borck.me.

Additional Resources

About

Automates grading of student submissions using AI and provides detailed feedback via CLI.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages