| Name | utsam JSON |
| Version |
0.1.25
JSON |
| download |
| home_page | None |
| Summary | UTS Assignment Marking Package |
| upload_time | 2024-10-20 06:48:53 |
| maintainer | None |
| docs_url | None |
| author | Your Name |
| requires_python | <3.11,>=3.10 |
| license | Proprietary License |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
git tag -a v0.1.1 -m "version 0.1.1"
#poetry version 0.1.1
poetry build
poetry publish
```
poetry run pytest
```
# Code in src Folder
```
src
├─── assignment => Folder that contains Py scripts for managing an assignment
│ │
│ ├─── __init__.py => Contains `AssignmentMarking` class that is used for running the marking engine for an assignment (no need to change it)
│ │
│ ├─── config.py => Contains the variables that will be used during marking (need to update it according to the assignment requirements)
│ │
│ ├─── utils => Folder that contains Py scripts that will be useful for assessing some defined citeria
│ │
│ ├─── __init__.py => Contains `BaseFolder` class that is used to managed the directory structure for each student's submission (no need to change it)
│ │
│ ├─── similarities.py => Contains functions used for assessing similarities between texts or numerics (can add more functionalities)
│ │
│ └─── sysmodules.py => Contains functions used for adding the path to the students folders in order to import thaier functions and/or classes (can add more functionalities)
│
├─── checks => Folder that contains Py scripts used for performing checks and provide marks (need to update it according to the assignment requirements)
│ │
│ └─── pythonfile
│ │ ├─── __init__.py => Contains `PythonFileChecker` class that is used to perform checks on python scripts only (no need to change it)
│ │ ├─── api_test.py => Contains list of scenarios used for marking student's apy.py (need to update it according to the assignment requirements)
│ │ ├─── currency_test.py => Contains list of scenarios used for marking student's currency.py (need to update it according to the assignment requirements)
│ │ └─── frankfurter_test.py => Contains list of scenarios used for marking student's frankfurter.py (need to update it according to the assignment requirements)
│ │
│ └─── structure
│ │ ├─── __init__.py => Contains `TemplateChecker` class that is used to verify if student's submission complies with the provided template structure (no need to change it)
│ │ └─── template.py => Contains list of scenarios used for verifying and marking compliance of student's submission to provided template (need to update it according to the assignment requirements)
|
└─── submission.py => Contains `StudentMarking` class that is used to perform all checks on a student's submission complies with the provided template structure (need to update it according to the assignment requirements)
```
At the end of the marking process, a grouping is performed on the raw CSV file for each student in order to get the final view by category for each student.
# Notebook
A Jupyter notebook is saved in the `notebooks` folder. This is used to import the relevant classes and launch the marking engine.
You need to install all required dependencies by running:
```
poetry install
```
Then you can launch Jupyter:
```
poetry run jupyter lab
```
Raw data
{
"_id": null,
"home_page": null,
"name": "utsam",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.11,>=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "you@example.com",
"download_url": "https://files.pythonhosted.org/packages/9e/0e/18a4e93d1dfc599f20fdbbc6fd7009348fbdf0cccb98680c248982626ebd/utsam-0.1.25.tar.gz",
"platform": null,
"description": "\ngit tag -a v0.1.1 -m \"version 0.1.1\"\n#poetry version 0.1.1\npoetry build\npoetry publish\n\n```\npoetry run pytest\n```\n\n# Code in src Folder\n```\nsrc\n\u251c\u2500\u2500\u2500 assignment => Folder that contains Py scripts for managing an assignment\n\u2502 \u2502\n\u2502 \u251c\u2500\u2500\u2500 __init__.py => Contains `AssignmentMarking` class that is used for running the marking engine for an assignment (no need to change it)\n\u2502 \u2502\n\u2502 \u251c\u2500\u2500\u2500 config.py => Contains the variables that will be used during marking (need to update it according to the assignment requirements)\n\u2502 \u2502\n\u2502 \u251c\u2500\u2500\u2500 utils => Folder that contains Py scripts that will be useful for assessing some defined citeria\n\u2502 \u2502 \n\u2502 \u251c\u2500\u2500\u2500 __init__.py => Contains `BaseFolder` class that is used to managed the directory structure for each student's submission (no need to change it)\n\u2502 \u2502\n\u2502 \u251c\u2500\u2500\u2500 similarities.py => Contains functions used for assessing similarities between texts or numerics (can add more functionalities)\n\u2502 \u2502\n\u2502 \u2514\u2500\u2500\u2500 sysmodules.py => Contains functions used for adding the path to the students folders in order to import thaier functions and/or classes (can add more functionalities)\n\u2502 \n\u251c\u2500\u2500\u2500 checks => Folder that contains Py scripts used for performing checks and provide marks (need to update it according to the assignment requirements)\n\u2502 \u2502\n\u2502 \u2514\u2500\u2500\u2500 pythonfile\n\u2502 \u2502 \u251c\u2500\u2500\u2500 __init__.py => Contains `PythonFileChecker` class that is used to perform checks on python scripts only (no need to change it)\n\u2502 \u2502 \u251c\u2500\u2500\u2500 api_test.py => Contains list of scenarios used for marking student's apy.py (need to update it according to the assignment requirements)\n\u2502 \u2502 \u251c\u2500\u2500\u2500 currency_test.py => Contains list of scenarios used for marking student's currency.py (need to update it according to the assignment requirements)\n\u2502 \u2502 \u2514\u2500\u2500\u2500 frankfurter_test.py => Contains list of scenarios used for marking student's frankfurter.py (need to update it according to the assignment requirements)\n\u2502 \u2502\n\u2502 \u2514\u2500\u2500\u2500 structure\n\u2502 \u2502 \u251c\u2500\u2500\u2500 __init__.py => Contains `TemplateChecker` class that is used to verify if student's submission complies with the provided template structure (no need to change it)\n\u2502 \u2502 \u2514\u2500\u2500\u2500 template.py => Contains list of scenarios used for verifying and marking compliance of student's submission to provided template (need to update it according to the assignment requirements)\n|\n\u2514\u2500\u2500\u2500 submission.py => Contains `StudentMarking` class that is used to perform all checks on a student's submission complies with the provided template structure (need to update it according to the assignment requirements)\n```\n\n\nAt the end of the marking process, a grouping is performed on the raw CSV file for each student in order to get the final view by category for each student.\n\n# Notebook\n\nA Jupyter notebook is saved in the `notebooks` folder. This is used to import the relevant classes and launch the marking engine.\n\nYou need to install all required dependencies by running:\n```\npoetry install\n```\n\nThen you can launch Jupyter:\n```\npoetry run jupyter lab\n```\n",
"bugtrack_url": null,
"license": "Proprietary License",
"summary": "UTS Assignment Marking Package",
"version": "0.1.25",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "83fd71ba3c7d1d6ab81057b860af3b0107fb1f394aacc8fd8ff16d70eb14c3a9",
"md5": "97555d7a84ee97a425cc2fb86edce81f",
"sha256": "bac0edfdb46a1333e445093572992010bd1b9fcb250a29441da0122e94f14bac"
},
"downloads": -1,
"filename": "utsam-0.1.25-py3-none-any.whl",
"has_sig": false,
"md5_digest": "97555d7a84ee97a425cc2fb86edce81f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.11,>=3.10",
"size": 19886,
"upload_time": "2024-10-20T06:48:51",
"upload_time_iso_8601": "2024-10-20T06:48:51.967483Z",
"url": "https://files.pythonhosted.org/packages/83/fd/71ba3c7d1d6ab81057b860af3b0107fb1f394aacc8fd8ff16d70eb14c3a9/utsam-0.1.25-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e0e18a4e93d1dfc599f20fdbbc6fd7009348fbdf0cccb98680c248982626ebd",
"md5": "4771f25122102135c59c0ba64e1abf69",
"sha256": "643ec81e462634a3873bddc5df37b1658e5d6f656d7765615effc7a806dfec27"
},
"downloads": -1,
"filename": "utsam-0.1.25.tar.gz",
"has_sig": false,
"md5_digest": "4771f25122102135c59c0ba64e1abf69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.11,>=3.10",
"size": 12778,
"upload_time": "2024-10-20T06:48:53",
"upload_time_iso_8601": "2024-10-20T06:48:53.503203Z",
"url": "https://files.pythonhosted.org/packages/9e/0e/18a4e93d1dfc599f20fdbbc6fd7009348fbdf0cccb98680c248982626ebd/utsam-0.1.25.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 06:48:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "utsam"
}
