https://github.com/gatoreducator/execexam
:rocket: ExecExam runs executable examinations that assess Python programming skills
https://github.com/gatoreducator/execexam
examination-system programming python testing
Last synced: 8 months ago
JSON representation
:rocket: ExecExam runs executable examinations that assess Python programming skills
- Host: GitHub
- URL: https://github.com/gatoreducator/execexam
- Owner: GatorEducator
- Created: 2024-08-22T20:53:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-06T04:00:53.000Z (10 months ago)
- Last Synced: 2025-05-08T00:03:54.695Z (8 months ago)
- Topics: examination-system, programming, python, testing
- Language: Python
- Homepage: https://pypi.org/project/execexam/
- Size: 630 KB
- Stars: 2
- Watchers: 1
- Forks: 6
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 🚀 ExecExam
[](https://github.com/GatorEducator/execexam/actions)
[](https://github.com/GatorEducator/execexam/commits/main/)
ExecExam is a powerful tool that runs executable examinations in which a
student provides solutions to programming problems that are checked by Pytest
test suites. If you are a computer science or software engineering instructor
who wants to administer programming examinations
## 🌟 Main Features
- **Automated Checks**: Run a series of checks on your Python projects to ensure
they're up to standard.
- **Detailed Reports**: See the results of the checks, including which ones
passed and which ones failed.
- **Advice on Failures**: When code fails a check, receive advice on what to do next.
- **Syntax Highlighting**: Enjoy syntax highlighting in the console output.
- **Verbose Mode**: Want to see more details? Just enable the verbose mode!
## 🤝 LLM-Based Advice
ExecExam uses the LLM-based advice system to provide students with feedback
when one of their answers fails a check. You can either specify the complete
URL of a LiteLLM API proxy or set an API key for a cloud-based LLM provider.
Here are examples of some of the LLM models that are supported through the use
of [LiteLLM](https://docs.litellm.ai/docs/providers):
- `anthropic/claude-3-haiku-20240307`
- `anthropic/claude-3-opus-20240229`
- `groq/llama3-8b-8192`
- `openrouter/meta-llama/llama-3.1-8b-instruct:free`
- `openrouter/google/gemma-2-9b-it:free`
## 🔧 Requirements
- Python 3.12
- Execexam leverages numerous Python packages, including notable ones such as:
- [Rich](https://github.com/Textualize/rich): Full-featured formatting and display of text in the terminal
- [Typer](https://github.com/tiangolo/typer): Easy-to-implement and fun-to-use command-line interfaces
- The developers of Execexam use [Poetry](https://github.com/python-poetry/poetry) for packaging and dependency management
## 🔽 Installation
Follow these steps to install the `execexam` program:
- Install Python 3.12 for your operating system
- Install [pipx](https://github.com/pypa/pipx) to support program installation in isolated environments
- Type `pipx install execexam` to install ExecExam
- Type `pipx list` and confirm that ExecExam is installed
- Type `execexam --help` to learn how to use the tool
## 🧗Improvement
- Found a bug or have a feature that the development team should implement?
[Raise an issue](https://github.com/gkapfham/execexam/issues)!
- Interesting in learning more about tool usage details? [Check the
wiki](https://github.com/gkapfham/execexam/wiki)!
- Contact [Gregory M. Kapfhammer](https://www.gregorykapfhammer.com/) with any
questions or suggestions about ExecExam!
## Contributing to Execexam
If you would like to contribute to Execexam, please refer to the [Execexam Wiki](https://github.com/GatorEducator/gatorgrade/wiki/Contributing-Guidelines) for contributing guidelines.