Code Evaluator

A simple web-based Python code evaluator using Flask.

Table of Contents

• Introduction
• Features
• Prerequisites
• Installation
• Usage
• Contributing
• License

Introduction

The Code Evaluator is a web-based application developed using the Flask framework. Its primary functionality revolves around the evaluation of Python code, facilitating a comparative analysis between the resultant output and the anticipated output. This application has been meticulously crafted to serve as a valuable instrument for the automated testing and validation of Python code fragments. Furthermore, it offers a distinctive feature in the form of a visual differentiation tool that enables users to discern disparities between the actual and expected output. Additionally, users can also employ file upload capabilities to specify the anticipated output.

Features

• Evaluate Python code snippets.
• Compare the actual output with the expected output.
• Visual diff between actual and expected output.
• Option to upload an expected output file.
• Option to manually enter the expected output.
• Create an assignment with a description and the expected output (see below).

Prerequisites

Before you begin, ensure you have met the following requirements:

• Python 3.x installed.
• A virtual environment for managing project dependencies (optional but recommended).

Installation

1. Clone the repository:

   git clone https://github.com/ochotzas/code-evaluator.git

2. Navigate to the project directory:

   cd code-evaluator

3. Create a virtual environment:

    python -m venv venv

4. Activate the virtual environment:

    source venv/bin/activate

5. Install the project dependencies:

    pip install -r requirements.txt

Usage

1. Start the Flask application:

    python app.py

2. Open a web browser and go to http://localhost:8080 to access the Code Evaluator.

3. Enter your Python code in the "Enter Python Code" textarea.

4. Optionally, upload an expected output file or manually enter the expected output in the "Expected Output" textarea.

5. Click the "Evaluate Code" button to run the code and see the evaluation results.

or (see below Evaluate Code & Post/Create Assignment)

Evaluate code using the API

Use the API by calling the endpoint /evaluate with a POST request and passing the Python code and expected output as form data.

Example:

curl --location 'http://localhost:8080/evaluate' \
--header 'Content-Type: application/json' \
--data '{
  "code": "print(\"Hello, World!\")",
  "expected_output": "Hello, World!\n"
}'

In this case, the response will be a JSON object with the following structure:

{
    "message": "Output matches the expected output.",
    "success": true
}

Create/Post an assignment using the API

Use the API by calling the endpoint /post-assignment with a POST request and passing the assignment description and expected output like the following example:

{
  "description": "Write a Python program to print \"Hello, World!\".",
  "expected_output": "Hello, World!\n"
}

In this case, the response will be a JSON object with the following structure:

{
    "key": "uid",
    "message": "Assignment created successfully.",
    "success": true
}

The key is a unique identifier for the assignment. You can use this key to retrieve the assignment details by calling the http://localhost:8080/?assigment=uid for example.

Screenshots

1. Home page.

   

2. Assignment page with the description and expected output.

   

3. Assignment page with user's wrong output.

   

4. Assignment page with user's correct output.

   

5. Assignment page with user's syntax error.

   

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Create a pull request describing your changes.

License

This project is licensed under the MIT License.