examify-io is an online examination system that offers automatic grading , exam statistics , proctoring and programming tests , multiple user roles

Overview

College Graduation project 2021 , REST API backend

Getting Started

Installing Dependencies

Python

Follow instructions to install the latest version of python for your platform in the python docs

Virtual Enviornment

I recommend working within a virtual environment whenever using Python for projects. This keeps your dependencies for each project separate and organaized. Instructions for setting up a virual enviornment for your platform can be found in the python docs

PIP Dependencies

Once you have your virtual environment setup and running, install dependencies by naviging to the /backend directory and running:

pip install -r requirements.txt

This will install all of the required packages we selected within the requirements.txt file.

Key Dependencies
  • Django is a backend framework. Django is required to handle requests and responses.

  • Django-rest-framework Django REST framework is a powerful and flexible toolkit for building Web APIs.

Running the server

From within the backend directory first ensure you are working using your created virtual environment.

To run the server, execute:

Mac , Linux

python3 manage.py runserver

To run the server, execute:

Windows

python manage.py runserver

Endpoints

General

POST /dj-rest-auth/registration/

  • General:
    • Returns Token and user type.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/dj-rest-auth/registration/ -X POST -H "Content-Type: application/json" -d '{ "username": "name", "password1":"Aa123456789", "password2":"Aa123456789", "email":"[email protected]", "user_type":"1" }'
  • Response Sample:
{
    "key": "52862e084f56792e2644b1801952a728a75fd8e5",
    "user_type": 1
}

POST /dj-rest-auth/login/

  • General:
    • Returns Token and user type.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/dj-rest-auth/login/ -X POST -H "Content-Type: application/json" -d '{ "username": "name", "password":"Aa123456789" }'
  • Response Sample:
{
    "key": "bd5188970056063a94afcf859820713f8cab743e",
    "user_type": 2
}

For Examiner:

GET /most-recent-exam/

  • General:
    • Returns the most recent exam id for the logged in examiner.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/most-recent-exam/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "id": 157
}

POST /exam/

  • General:
    • Returns exam data.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "exam_name":"Exam 1", "exam_startdate":"2021-05-27 02:25:33+02:00", "exam_duration": 3.0 }'
  • Response Sample:
{
    "id": 1,
    "exam_name": "Exam 1",
    "exam_startdate": "2021-05-27 02:25:33+02:00",
    "exam_duration": 3.0,
    "examiner": 2
}

GET /exam/

  • General:
    • Returns exam list for the logged in examiner.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    {
        "id": 1,
        "exam_name": "Exam 1",
        "exam_startdate": "2021-05-25T14:52:37Z",
        "exam_duration": 3.0,
        "examiner": 2
    }
}

GET /exam/{exam_id}/

  • General:
    • Returns a whole exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "id": 13,
    "exam": "Movies",
    "startdate": "2021-05-25T14:52:37Z",
    "duration": 3.0,
    "questions": [
        {
            "id": 18,
            "text": "what was tom hank's name in you've got mail ?",
            "mark": 10.0,
            "answers": {
                "12": {
                    "text": "Joe Fox",
                    "is_correct": true
                },
                "13": {
                    "text": "Joe Tom",
                    "is_correct": false
                },
                "14": {
                    "text": "Jack Tom",
                    "is_correct": false
                },
                "15": {
                    "text": "Jack Daniels",
                    "is_correct": false
                }
            }
        },
        {
            "id": 19,
            "text": "what was Sophie Turner's name in game of thrones ?",
            "mark": 10.0,
            "answers": {
                "16": {
                    "text": "Sansa Snow",
                    "is_correct": false
                },
                "17": {
                    "text": "Sansa Stark",
                    "is_correct": true
                },
                "18": {
                    "text": "Sansa Greyhound",
                    "is_correct": false
                },
                "19": {
                    "text": "Sansa Sand",
                    "is_correct": false
                }
            }
        },
        {
            "id": 20,
            "text": "what was Tom Hank's name in cast away ?",
            "mark": 10.0,
            "answers": {
                "20": {
                    "text": "Chuck Noland",
                    "is_correct": true
                },
                "21": {
                    "text": "Chuck Neil",
                    "is_correct": false
                },
                "22": {
                    "text": "Charles Neil",
                    "is_correct": false
                },
                "23": {
                    "text": "Charl Neil",
                    "is_correct": false
                }
            }
        }
    ]
}

PATCH /exam/{exam_id}/

  • General:
    • Returns 200 ok.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/ -X PATCH -H "Content-Type: application/json" "Authorization: Token " '{ "id": 13, "exam": "Movies", "startdate": "2021-05-25T14:52:37Z", "duration": 3.0 }'
  • Response Sample:
HTTP 200 OK

Delete /exam/{exam_id}/

  • General:
    • Returns 200 ok.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/ -X Delete -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
HTTP 200 OK

POST /exam/{exam_id}/question/

  • General:
    • Returns the question that has been added.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/question/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "text": "how old are you now wrong ?", "mark": 100 }'
  • Response Sample:
{
    "id": 6,
    "text": "how old are you now?",
    "mark": 100.0,
    "exam": 1,
    "previous_question": null
}

PATCH /exam/{exam_id}/question/{question_id}/

  • General:
    • Returns 200 ok.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/question/{question_id}/ -X PATCH -H "Content-Type: application/json" "Authorization: Token " -d '{ "id": 157, "text": "what was Sophie Turner's name in game of thrones ? edited question", "mark": 11.0 }'
  • Response Sample:
200 OK

DELETE /exam/{exam_id}/question/{question_id}/

  • General:
    • Returns 200 ok.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/question/{question_id}/ -X DELETE -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
200 OK

POST /exam/question/{question_id}/answer/

  • General:
    • Returns the answer that has been added.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/question/{question_id}/answer/ -X POST -H "Content-Type: application/json" -H "Content-Type: application/json" "Authorization: Token " -d '{ "text":"15", "is_correct":true }'
  • Response Sample:
{
    "id": 3,
    "text": "15",
    "is_correct": true,
    "question": 6
}

PATCH /exam/question/{question_id}/answer/{answer_id}/

  • General:
    • Returns 200 OK.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/question/{question_id}/answer/{answer_id}/ -X PATCH -H "Content-Type: application/json" -H "Content-Type: application/json" "Authorization: Token " -d '{ "text": "Sansa Snow new", "is_correct": false }'
  • Response Sample:
200 OK

DELETE /exam/question/{question_id}/answer/{answer_id}/

  • General:
    • Returns 200 OK.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/question/{question_id}/answer/{answer_id}/ -X DELETE -H "Content-Type: application/json" -H "Content-Type: application/json" "Authorization: Token " -d
  • Response Sample:
200 OK

POST exam/{exam_id}/allowed-students/

  • General:
    • Returns list of students that has been added.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/allowed-students/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "students":["student1","student2"] }'
  • Response Sample:
{
    "id": 2,
    "student": [
        10,
        6
    ],
    "exam": 1
}

GET exam/{exam_id}/allowed-students/

  • General:
    • Returns list of students allowed to enter the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/allowed-students/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
    {
    "exam": 165,
    "student": [
        {
            "student_id": 28,
            "student_name": "stu1"
        },
        {
            "student_id": 19,
            "student_name": "stu2"
        },
        {
            "student_id": 18,
            "student_name": "stu3"
        },
        {
            "student_id": 1,
            "student_name": "stu4"
        },
        {
            "student_id": 6,
            "student_name": "stu5"
        }
    ]
}

DELETE exam/{exam_id}/allowed-students/{student_id}/

  • General:
    • Delete allowed student to enter the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/allowed-students/{student_id}/ -x DELETE -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
  200 OK

GET exam/{exam_id}/supervisors/

  • General:
    • Retruns list of supervisors for the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/supervisors/ -X GET -H "Content-Type: application/json" "Authorization: Token " -d
  • Response Sample:
[
    {
        "supervisor_id": 45,
        "supervisor_name": "super1",
        "students": [
            "stu1",
            "stu2",
            "stu3"
        ]
    },
    {
        "supervisor_id": 46,
        "supervisor_name": "super2",
        "students": [
            "stu4",
            "stu5"
        ]
    }
]

GET exam/{exam_id}/statistics/

  • General:
    • Retruns statistics for a single exam and its questions.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/statistics/ -X GET -H "Content-Type: application/json" "Authorization: Token " -d
  • Response Sample:
[
    {
        "id": 163,
        "total_mark": 20.0,
        "name": "Movies",
        "exam_statistics": {
            "avg": 29.5,
            "max": 63.0,
            "min": 10.0,
            "num_of_students_submited_the_exam": 4,
            "standard_deviation": 20.081085628023203
        }
    },
    {
        "0": {
            "id": 269,
            "text": "what was Sophie Turner's name in game of thrones ?",
            "correct_answer": "Sansa",
            "mark": 10.0,
            "correct_count": 1,
            "wrong_count": 1
        },
        "1": {
            "id": 270,
            "text": "what was Christian Bale's name in The Dark Knight  ?",
            "correct_answer": "Bruce Wayne",
            "mark": 10.0,
            "correct_count": 2,
            "wrong_count": 0
        }
    }
]

POST exam/{exam_id}/supervisors/

  • General:
    • adds supervisors to exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/supervisors/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "supervisor": [ "super1", "super2", "super3" ] }'
  • Response Sample:
201 Created 

DELETE exam/{exam_id}/supervisor/{supervisor_id}/

  • General:
    • delete assigned supervisor to exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/supervisor/{supervisor_id}/ -X DELETE -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
200 OK 

GET /exam/{exam_id}/attendance/

  • General:
    • Returns list of students allowed to enter the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/attendance/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "student_name": "student1",
        "supervisor_name": "supervisor1",
        "enter_time": "2021-05-18T18:34:37Z",
        "submit_time": "2021-05-18T18:34:39Z"
    },
    {
        "student_name": "student2",
        "supervisor_name": "supervisor2"git ,
        "enter_time": "2021-05-18T18:32:12Z",
        "submit_time": "2021-05-18T18:32:14Z"
    },
    {
        "student_name": "student3",
        "supervisor_name": "supervisor3",
        "enter_time": "2021-05-18T18:32:47Z",
        "submit_time": "2021-05-18T18:33:02Z"
    }
]

GET /exam/{exam_id}/marks/

  • General:
    • Returns list of students marks in exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/marks/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "id": 41,
        "student_name": "student 1",
        "mark": 40.0
    },
    {
        "id": 6,
        "student_name": "student 2",
        "mark": 39.5
    }
]

GET /exam/{exam_id}/violations/

  • General:
    • Returns list of students marks in exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/violations/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "id": 165,
    "exam_name": "Performance",
    "violations": [
        {
            "id": 6,
            "student": "student1",
            "violation": "cheating from the mobile phone",
            "supervisor": "super2",
            "time": "2021-07-10 18:04:39.827472+00:00"
        },
        {
            "id": 18,
            "student": "student2",
            "violation": "cheating from the book",
            "supervisor": "super3",
            "time": "2021-07-11 01:37:53.449630+00:00"
        }
    ]
}

GET /exam/{exam_id}/student/{student_id}/

  • General:
    • Returns the exam of the student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/student/{student_id}/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "student_name": "student 1",
        "student": 41,
        "exam": 13,
        "exam_name": "Movies",
        "question": 18,
        "question_text": "how old are you now wrong new?",
        "answer": 12,
        "answer_text": "Joe Fox",
        "is_correct": true
    },
    {
        "student_name": "student 1",
        "student": 41,
        "exam": 13,
        "exam_name": "Movies",
        "question": 19,
        "question_text": "how old are you now wrong new?",
        "answer": 17,
        "answer_text": "Sansa Stark",
        "is_correct": true
    },
    {
        "student_name": "student 1",
        "student": 41,
        "exam": 13,
        "exam_name": "Movies",
        "question": 20,
        "question_text": "how old are you now wrong new?",
        "answer": 20,
        "answer_text": "Chuck Noland",
        "is_correct": true
    }
]

GET /exam/{exam_id}/time-left/

  • General:
    • Returns time left for the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/time-left/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "time_left": "2:56:45.558412"
}

For Examiner --- Programming Test

POST /programming-test/

  • General:
    • Returns the data of the added programming test.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "test_name":"programming test - python ", "test_startdate":"2021-09-27 02:25:33+02:00", "test_duration": 3.0 }'
  • Response Sample:
{
    "id": 2,
    "test_name": "programming test - python",
    "test_startdate": "2021-09-27T00:25:33Z",
    "test_duration": 3.0,
    "examiner": 40
}

GET /programming-test/

  • General:
    • Returns lists of programming tests for the logged in examiner.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "id": 1,
        "test_name": "First programming test",
        "test_startdate": "2021-07-27T00:25:33Z",
        "test_duration": 3.0,
        "examiner": 40
    },
    {
        "id": 2,
        "test_name": "programming test - python",
        "test_startdate": "2021-09-27T00:25:33Z",
        "test_duration": 3.0,
        "examiner": 40
    }
]

GET /programming-test/{test_id}/

  • General:
    • Returns a whole test.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "id": 1,
    "test": "First programming test",
    "startdate": "2021-07-27T00:25:33Z",
    "duration": 3.0,
    "questions": [
        {
            "id": 1,
            "text": "write a python fuction that takes an int list as an argument and returns the sum of it elements , list_sum(numbers)  , call it 2 time for (30 60 5 7 95 21) ( 4 51 -25 96 -74 60)"
        },
        {
            "id": 2,
            "text": "write a python fuction that takes an int list as an argument and returns the average of it elements , list_avg(numbers)  , call it 2 time for (30 60 5 7 95 21) ( 4 51 -25 96 -74 60)"
        }
    ]
}

POST /programming-test/{test_id}/question/

  • General:
    • Returns the question that has been added.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{tes_id}/question/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "text" : "write a python fuction that takes an int list as an argument and returns the sum of it elements , list_sum(numbers) , call it 2 time for (30 60 5 7 95 21) ( 4 51 -25 96 -74 60) " }'
  • Response Sample:
{
    "id": 1,
    "text": "write a python fuction that takes an int list as an argument and returns the sum of it elements , list_sum(numbers)  , call it 2 time for (30 60 5 7 95 21) ( 4 51 -25 96 -74 60)",
    "test": 1
}

POST /programming-test/{test_id}/allowed-students/

  • General:
    • Returns 201 or 400
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/allowed-students/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "students":["student1","student2"] }'
  • Response Sample:
{
    "id": 2,
    "student": [
        10,
        6
    ],
    "test" 1
}

GET programming-test/{test_id}/allowed-students/

  • General:
    • Returns list of students allowed to enter the exam.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/allowed-students/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
    {
    "test": 1,
    "student": [
        "student1",
        "student2"
    ]
}

GET /programming-test/{test_id}/student/{student_id}/

  • General:
    • Returns the test answers of the student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/student/{student_id}/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "student_name": "ameerstudent",
        "student": 28,
        "test": 3,
        "test_name": "programming test - ruby",
        "question": 3,
        "question_text": "write a ruby fuction that takes an int list as an argument and returns the sum of it elements",
        "answer": "x=2 \ny=5\nprint(x+y)",
        "programming_language": "python3",
        "output": "{\"output\":\"7\\n\",\"statusCode\":200,\"memory\":\"7348\",\"cpuTime\":\"0.02\"}"
    },
    {
        "student_name": "ameerstudent",
        "student": 28,
        "test": 3,
        "test_name": "programming test - ruby",
        "question": 4,
        "question_text": "write a ruby fuction that takes an int list as an argument and returns the avg of it elements",
        "answer": "x=2 \ny=5\nprint(x+y)",
        "programming_language": "python3",
        "output": "{\"output\":\"7\\n\",\"statusCode\":200,\"memory\":\"7432\",\"cpuTime\":\"0.01\"}"
    }
]

For Student:

GET student/dashboard/

  • General:
    • Returns all exams for the logged in student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/student/dashboard/ -H "Authorization: Token "
  • Response Sample:
[
    {
        "exam_id": 140,
        "exam_name": "Movies",
        "student_id": 6,
        "student_name": "stu1",
        "full_mark": 20.0,
        "student_mark": 10.0,
        "is_started": "The Exam is Closed"
    },
    {
        "exam_id": 163,
        "exam_name": "Physics",
        "student_id": 6,
        "student_name": "stu1",
        "full_mark": 4.0,
        "student_mark": 0,
        "is_started": "The Exam is Open"
    },
    {
        "exam_id": 147,
        "exam_name": "Maths",
        "student_id": 6,
        "student_name": "stu1",
        "full_mark": 100.0,
        "student_mark": 0,
        "is_started": "The Exam is Closed"
    }
]

GET /exam/{exam_id}/start/

  • General:
    • Returns the whole exam for the student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/start/ -H "Authorization: Token "
  • Response Sample:
{
    "exam_name": "Exam test",
    "exam_starttime": "2021-05-09T20:47:36Z",
    "exam_duration": 4.0,
    "questions": {
        "how old are you now wrong ?": {
            "mark": 1.0,
            "previous_question": null,
            "answers": {}
        },
        "how old are you now wrong 2?": {
            "mark": 1.0,
            "previous_question": null,
            "answers": {
                "10": "answer 1",
                "11": "answer 2"
            }
        }
    }
}

POST /exam/{exam_id}/submit/

  • General:
    • Submits all exam answers for the student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/submit/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ "student_answers": { "18" : 12, "19":17, "20" : 20, "21":24, "22":29 } }'
    • where question id and 12 is chosen answer id
  • Response Sample:
HTTP 200 OK

For Student -- Programming

GET student/dashboard/programming-tests/

  • General:
    • Returns all programming tests for the logged in student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/student/dashboard/programming-tests/ -H "Authorization: Token "
  • Response Sample:
[
{"test_id":1,"test_name":"First programming test",
"test_startdate":"2021-07-27T00:25:33Z",
"test_duration":3.0,"student_id":28,
"student_name":"ameerstudent"
} ,

{"test_id":2,"test_name":"programming test - python",
"test_startdate":"2021-07-29T00:25:33Z",
"test_duration":3.0,"student_id":28,
"student_name":"ameerstudent"
}

]

GET /programming-test/{test_id}/start/

  • General:
    • Returns the whole exam for the student.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/start/ -H "Authorization: Token "
  • Response Sample:
{
"test_name":"programming test - ruby",
"test_starttime":"2021-07-10T22:00:00Z",
"test_duration":24.0,
"questions":
{"3":"write a ruby fuction that takes an int list as an argument and returns the sum of it elements",
"4":"write a ruby fuction that takes an int list as an argument and returns the avg of it elements"}}

POST /programming-test/{test_id}/submit/

  • General:

    • Submits all exam answers for the student.
  • Request Sample: ```curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/programming-test/{test_id}/submit/ -X POST -H "Content-Type: application/json" "Authorization: Token " -d '{ { "student_answers" : { "3" : ["python3" , "x=2 \ny=5\nprint(x+y)"],

    "4" : ["python3" , "x=2 \ny=5\nprint(x+y)"] } } }'```

    • where question id is 3 and python3 is chosen programming language , "x=2 \ny=5\nprint(x+y)" is the code snippet and it should be an escaped string
  • Response Sample:

HTTP 200 OK

For Supervisor:

GET supervisor/dashboard/

  • General:
    • Returns list of exams for the logged in supervisor.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/supervisor/dashboard/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
[
    {
        "exam_id": 165,
        "exam_name": "Performance",
        "exam_startdate": "2021-06-27T23:37:05Z",
        "exam_duration": 2.0,
        "is_started": "The Exam is Open"
    }
]

GET exam/{exam_id}/supervise/

  • General:
    • Returns some exam details and assigned students to supervise.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/supervise/ -H "Content-Type: application/json" "Authorization: Token "
  • Response Sample:
{
    "exam_id": 165,
    "exam_name": "Performance",
    "exam_startdate": "2021-06-27T23:37:05Z",
    "exam_duration": 3.0,
    "students": [
        {
            "student_id": 6,
            "student_name": "stu1"
        },
        {
            "student_id": 19,
            "student_name": "stu2"
        },
        {
            "student_id": 1,
            "student_name": "stu3"
        }
    ]
}

POST exam/{exam_id}/supervise/student/{student_id}/

  • General: -Assigned supervisor can reports a violation.
  • Request Sample: curl http://ec2-18-191-113-113.us-east-2.compute.amazonaws.com:8000/exam/{exam_id}/supervise/student/{student_id}/ -H "Authorization: Token "
  • Response Sample:
{
    "violation": "cheating from the mobile phone"
}
  • Response Sample:
200 OK
Owner
Ameer Nasser
Software Engineer
Ameer Nasser
Python module for generating and verifying JSON Web Tokens

python-jwt Module for generating and verifying JSON Web Tokens. Note: From version 2.0.1 the namespace has changed from jwt to python_jwt, in order to

David Halls 210 Dec 24, 2022
A simple model based API maker written in Python and based on Django and Django REST Framework

Fast DRF Fast DRF is a small library for making API faster with Django and Django REST Framework. It's easy and configurable. Full Documentation here

Mohammad Ashraful Islam 18 Oct 05, 2022
Foundation Auth Proxy is an abstraction on Foundations' authentication layer and is used to authenticate requests to Atlas's REST API.

foundations-auth-proxy Setup By default the server runs on http://0.0.0.0:5558. This can be changed via the arguments. Arguments: '-H' or '--host': ho

Dessa - Open Source 2 Jul 03, 2020
Basic auth for Django.

easy-basicauth WARNING! THIS LIBRARY IS IN PROGRESS! ANYTHING CAN CHANGE AT ANY MOMENT WITHOUT ANY NOTICE! Installation pip install easy-basicauth Usa

bichanna 2 Mar 25, 2022
Object Moderation Layer

django-oml Welcome to the documentation for django-oml! OML means Object Moderation Layer, the idea is to have a mixin model that allows you to modera

Angel Velásquez 12 Aug 22, 2019
Toolkit for Pyramid, a Pylons Project, to add Authentication and Authorization using Velruse (OAuth) and/or a local database, CSRF, ReCaptcha, Sessions, Flash messages and I18N

Apex Authentication, Form Library, I18N/L10N, Flash Message Template (not associated with Pyramid, a Pylons project) Uses alchemy Authentication Authe

95 Nov 28, 2022
FastAPI Simple authentication & Login API using GraphQL and JWT

JeffQL A Simple FastAPI authentication & Login API using GraphQL and JWT. I choose this Name JeffQL cause i have a Low level Friend with a Nickname Je

Yasser Tahiri 26 Nov 24, 2022
A secure authentication module to validate user credentials in a Streamlit application.

Streamlit-Authenticator A secure authentication module to validate user credentials in a Streamlit application. Installation Streamlit-Authenticator i

M Khorasani 336 Dec 31, 2022
PetitPotam - Coerce NTLM authentication from Windows hosts

Python implementation for PetitPotam

ollypwn 137 Dec 28, 2022
Local server that gives you your OAuth 2.0 tokens needed to interact with the Conta Azul's API

What's this? This is a django project meant to be run locally that gives you your OAuth 2.0 tokens needed to interact with Conta Azul's API Prerequisi

Fábio David Freitas 3 Apr 13, 2022
OAuth2 goodies for the Djangonauts!

Django OAuth Toolkit OAuth2 goodies for the Djangonauts! If you are facing one or more of the following: Your Django app exposes a web API you want to

Jazzband 2.7k Jan 01, 2023
Social auth made simple

Python Social Auth Python Social Auth is an easy-to-setup social authentication/registration mechanism with support for several frameworks and auth pr

Matías Aguirre 2.8k Dec 24, 2022
Accounts for Django made beautifully simple

Django Userena Userena is a Django application that supplies your Django project with full account management. It's a fully customizable application t

Bread & Pepper 1.3k Sep 18, 2022
Per object permissions for Django

django-guardian django-guardian is an implementation of per object permissions [1] on top of Django's authorization backend Documentation Online docum

3.3k Jan 01, 2023
Web authentication testing framework

What is this This is a framework designed to test authentication for web applications. While web proxies like ZAProxy and Burpsuite allow authenticate

OWASP 88 Jan 01, 2023
Simple Login - Login Extension for Flask - maintainer @cuducos

Login Extension for Flask The simplest way to add login to flask! Top Contributors Add yourself, send a PR! How it works First install it from PyPI. p

Flask Extensions 181 Jan 01, 2023
AddressBookApp - Address Book App in Django

AddressBookApp Application Name Address Book App in Django, 2022 Technologies La

Joshua K 1 Aug 18, 2022
Authentication Module for django rest auth

django-rest-knox Authentication Module for django rest auth Knox provides easy to use authentication for Django REST Framework The aim is to allow for

James McMahon 878 Jan 04, 2023
Automatizando a criação de DAGs usando Jinja e YAML

Automatizando a criação de DAGs no Airflow usando Jinja e YAML Arquitetura do Repo: Pastas por contexto de negócio (ex: Marketing, Analytics, HR, etc)

Arthur Henrique Dell' Antonia 5 Oct 19, 2021
Boilerplate/Starter Project for building RESTful APIs using Flask, SQLite, JWT authentication.

auth-phyton Boilerplate/Starter Project for building RESTful APIs using Flask, SQLite, JWT authentication. Setup Step #1 - Install dependencies $ pip

sandhika 0 Aug 03, 2022