# Homework checker #
This is a python module and script that can be used to check homeworks.
The idea behind the script is the following:
- There is a homework yaml file, see [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) that follows the [schema](schema/schema.yml)
- In this file we define the structure of the homework
- The homework checker library knows how to execute certain types of tasks following the guides in the yaml file
It is expected that the submitted homework will follow the folder structure specified in the `homework.yml` file.
## Core functionality ##
### Run different tests ###
For now we support running tests for code written in different languages:
- c++
- bash
### Inject data into homeworks ###
We sometimes want to inject a certain folder before running tests, there is an option to do this here.
## How it works ##
I will probably not go into details here at this level of the package maturity. For now you can start digging from the [`check_homework.py`](homework_checker/check_homework.py) script and hopefully the code is clear enough. You can also look at the [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) file that we use to test all the implemented functionality.
Raw data
{
"_id": null,
"home_page": "https://github.com/cpp-for-yourself/homework_checker",
"name": "homework-checker",
"maintainer": "Igor Bogoslavskyi",
"docs_url": null,
"requires_python": "",
"maintainer_email": "igor.bogoslavskyi@gmail.com",
"keywords": "homework-checker",
"author": "Igor Bogoslavskyi",
"author_email": "igor.bogoslavskyi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e6/61/9368bf0e56676f861ef64858c60e84c6699bada0c463da36a3da23923143/homework_checker-2.0.0.tar.gz",
"platform": null,
"description": "# Homework checker #\n\nThis is a python module and script that can be used to check homeworks.\n\nThe idea behind the script is the following:\n- There is a homework yaml file, see [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) that follows the [schema](schema/schema.yml)\n- In this file we define the structure of the homework\n- The homework checker library knows how to execute certain types of tasks following the guides in the yaml file\n\nIt is expected that the submitted homework will follow the folder structure specified in the `homework.yml` file. \n\n## Core functionality ##\n\n### Run different tests ###\nFor now we support running tests for code written in different languages:\n- c++\n- bash\n\n### Inject data into homeworks ###\nWe sometimes want to inject a certain folder before running tests, there is an option to do this here.\n\n## How it works ##\n\nI will probably not go into details here at this level of the package maturity. For now you can start digging from the [`check_homework.py`](homework_checker/check_homework.py) script and hopefully the code is clear enough. You can also look at the [`homework.yml`](homework_checker/core/tests/data/homework/example_job.yml) file that we use to test all the implemented functionality.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "A generic homework checker.",
"version": "2.0.0",
"split_keywords": [
"homework-checker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "adca8d563ab33f21163e695a9b2aeacf9185a341fe49275706c4ad9c8cbcab2b",
"md5": "d1116237eab94a919ca2a1f4eee1c56f",
"sha256": "587aa6e720e4c0c4ac0f064234bb254f6103d9193042ccaaa74c57b1b72e7f85"
},
"downloads": -1,
"filename": "homework_checker-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d1116237eab94a919ca2a1f4eee1c56f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23064,
"upload_time": "2023-01-02T22:51:20",
"upload_time_iso_8601": "2023-01-02T22:51:20.765553Z",
"url": "https://files.pythonhosted.org/packages/ad/ca/8d563ab33f21163e695a9b2aeacf9185a341fe49275706c4ad9c8cbcab2b/homework_checker-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e6619368bf0e56676f861ef64858c60e84c6699bada0c463da36a3da23923143",
"md5": "7064fca33ce8d378a8e6418466893a00",
"sha256": "04eddc523dced9c8b2f64936fdf8ac29f1f033ca9c10929a1a84beaaa4142052"
},
"downloads": -1,
"filename": "homework_checker-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "7064fca33ce8d378a8e6418466893a00",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19364,
"upload_time": "2023-01-02T22:51:21",
"upload_time_iso_8601": "2023-01-02T22:51:21.930856Z",
"url": "https://files.pythonhosted.org/packages/e6/61/9368bf0e56676f861ef64858c60e84c6699bada0c463da36a3da23923143/homework_checker-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-02 22:51:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "cpp-for-yourself",
"github_project": "homework_checker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "homework-checker"
}
JSON
