Skip to content

uomlms/corrector

Repository files navigation

C Python TypeScript Kafka

Corrector Service

Corrector Service is responsible for correcting the assignments that students submits. Does not provide endpoints, only Kafka Consumers and Producers.

Bugs, Feature Requests and Contributing

We'd love to see community contributions. We like to keep it simple and use Github issues to track bugs and feature requests and pull requests to manage contributions.

Kafka

Event Flow Diagram

Corrector service consumes AssignmentSubmitEvent which indicates that an assignment has submitted. After correction, publishes AssignmentCorrectionEvent and SendMailEvent.

Full list of Events can be found here.

event-flow

Python Script

Parameters

  • Configuration File: the path of configuration file
  • Submission File: the path of submission file

Example:

python3 corrector.py config_path submit_path

Expected Return Values

Return value should be valid JSON string in stdout

Example:

# python3 code
return json.dumps({
   'result': "The actual result",
   'status': "success" | "partial-success" | "fail"
})

Quickstart

Using Docker Compose

Dependencies

  • Docker
  • Docker Compose
$ git clone https://github.com/uomlms/corrector.git
$ cd corrector
$ docker-compose up

Authors

License

License

About

Corrector service corrects the assignments

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published