| Name | jupyterquest JSON |
| Version |
0.3.0
JSON |
| download |
| home_page | |
| Summary | A Python package for automating grading of Jupyter notebook files. |
| upload_time | 2024-03-06 05:38:00 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2024 Greg T. Chism Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
education
autograder
jupyter
notebook
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# jupyterquest: The Advanced .ipynb Autograder
| Category | Badges |
| --- | --- |
| Website | [](https://app.netlify.com/sites/jupyterquest/deploys) |
| Testing | [](https://github.com/Gchism94/jupyterquest/actions/workflows/autograder.yml) |
| License | [](LICENSE) |
| Version | [](#) |
## Overview
**jupyterquest** is a comprehensive autograding tool designed to elevate the standard of Jupyter Notebook (.ipynb) submissions. Seamlessly integrated with GitHub Actions, it provides an automated evaluation process that spans across code style, structure, commit history, security vulnerabilities, and dependency checks. This tool is invaluable for educators, mentors, and development teams aiming to uphold best practices in code quality, security, and project organization.
## Features
- **Code Style and Formatting Checks**: Enforces best practices and consistency in coding styles.
- **Code Structure Analysis**: Assesses the organization and readability of code for maintainability.
- **Commit Message Quality**: Evaluates the clarity and conformity of commit messages to best practices.
- **Repository Structure Validation**: Ensures a logical and standardized file organization within repositories.
- **Security Vulnerability Scans**: Identifies known vulnerabilities in project dependencies to ensure code safety.
- **Dependency Analysis**: Checks for outdated or insecure dependencies that might compromise the project.
- **Extensible and Automated**: Designed for easy integration with CI/CD workflows, offering customizable options to meet various grading and analysis needs.
## Getting Started
### Prerequisites
- A GitHub account and a basic understanding of GitHub Actions.
- Knowledge of Jupyter Notebooks and the `.ipynb` file format.
### Installation
1. **Fork or Clone This Repository**:
Start by forking this repository to your account or cloning it directly to your local environment.
2. **Configure GitHub Actions**:
In your repository on GitHub, navigate to the 'Actions' tab. Set up a new workflow with the provided `autograder.yml` workflow file.
3. **Customize the Autograder** (Optional):
Adjust the `autograder.py` and other relevant scripts to fine-tune the grading criteria and checks according to your project or course requirements.
### Usage
- **Automatic Execution**: jupyterquest runs automatically with each push to the repository, thanks to GitHub Actions integration.
- **Reports**: The autograder generates detailed Markdown reports, offering actionable insights on code improvements and highlighting commendable practices.
## Contribution
We encourage contributions! If you're interested in enhancing jupyterquest or adding new features, please consult our contributing guidelines for more information on how to get started.
## License
jupyterquest is made available under the MIT License. For more details, see the [LICENSE](LICENSE) file.
## Support and Contact
Need help or have questions? Feel free to [open an issue](https://github.com/Gchism94/jupyterquest/issues) in this repository for support and inquiries.
Raw data
{
"_id": null,
"home_page": "",
"name": "jupyterquest",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "education,autograder,jupyter,notebook",
"author": "",
"author_email": "Greg Chism <gchism@arizona.edu>",
"download_url": "https://files.pythonhosted.org/packages/12/ce/bcb981371fb9167aea9ddfa8f655c703925687c32f52e93bc1ce79b7dfa7/jupyterquest-0.3.0.tar.gz",
"platform": null,
"description": "# jupyterquest: The Advanced .ipynb Autograder\n\n| Category | Badges |\n| --- | --- |\n| Website | [](https://app.netlify.com/sites/jupyterquest/deploys) |\n| Testing | [](https://github.com/Gchism94/jupyterquest/actions/workflows/autograder.yml) |\n| License | [](LICENSE) |\n| Version | [](#) |\n\n\n## Overview\n**jupyterquest** is a comprehensive autograding tool designed to elevate the standard of Jupyter Notebook (.ipynb) submissions. Seamlessly integrated with GitHub Actions, it provides an automated evaluation process that spans across code style, structure, commit history, security vulnerabilities, and dependency checks. This tool is invaluable for educators, mentors, and development teams aiming to uphold best practices in code quality, security, and project organization.\n\n## Features\n- **Code Style and Formatting Checks**: Enforces best practices and consistency in coding styles.\n- **Code Structure Analysis**: Assesses the organization and readability of code for maintainability.\n- **Commit Message Quality**: Evaluates the clarity and conformity of commit messages to best practices.\n- **Repository Structure Validation**: Ensures a logical and standardized file organization within repositories.\n- **Security Vulnerability Scans**: Identifies known vulnerabilities in project dependencies to ensure code safety.\n- **Dependency Analysis**: Checks for outdated or insecure dependencies that might compromise the project.\n- **Extensible and Automated**: Designed for easy integration with CI/CD workflows, offering customizable options to meet various grading and analysis needs.\n\n## Getting Started\n### Prerequisites\n- A GitHub account and a basic understanding of GitHub Actions.\n- Knowledge of Jupyter Notebooks and the `.ipynb` file format.\n\n### Installation\n1. **Fork or Clone This Repository**: \n Start by forking this repository to your account or cloning it directly to your local environment.\n\n2. **Configure GitHub Actions**:\n In your repository on GitHub, navigate to the 'Actions' tab. Set up a new workflow with the provided `autograder.yml` workflow file.\n\n3. **Customize the Autograder** (Optional):\n Adjust the `autograder.py` and other relevant scripts to fine-tune the grading criteria and checks according to your project or course requirements.\n\n### Usage\n- **Automatic Execution**: jupyterquest runs automatically with each push to the repository, thanks to GitHub Actions integration.\n- **Reports**: The autograder generates detailed Markdown reports, offering actionable insights on code improvements and highlighting commendable practices.\n\n## Contribution\nWe encourage contributions! If you're interested in enhancing jupyterquest or adding new features, please consult our contributing guidelines for more information on how to get started.\n\n## License\njupyterquest is made available under the MIT License. For more details, see the [LICENSE](LICENSE) file.\n\n## Support and Contact\nNeed help or have questions? Feel free to [open an issue](https://github.com/Gchism94/jupyterquest/issues) in this repository for support and inquiries.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Greg T. Chism Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A Python package for automating grading of Jupyter notebook files.",
"version": "0.3.0",
"project_urls": {
"Source": "https://github.com/Gchism94/jupyterquest",
"Tracker": "https://github.com/Gchism94/jupyterquest/issues"
},
"split_keywords": [
"education",
"autograder",
"jupyter",
"notebook"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14a769d4b0d00d9541660516bfd58210b6c03de4e2283cecc6caf14acb9b3523",
"md5": "3d3ec2a568d95c9da057774cc4fd6450",
"sha256": "e32111a624cf6275cf406e4a15e72c34d7a5f00f0609b9354036fb60fe783fad"
},
"downloads": -1,
"filename": "jupyterquest-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d3ec2a568d95c9da057774cc4fd6450",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15282,
"upload_time": "2024-03-06T05:37:57",
"upload_time_iso_8601": "2024-03-06T05:37:57.207387Z",
"url": "https://files.pythonhosted.org/packages/14/a7/69d4b0d00d9541660516bfd58210b6c03de4e2283cecc6caf14acb9b3523/jupyterquest-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "12cebcb981371fb9167aea9ddfa8f655c703925687c32f52e93bc1ce79b7dfa7",
"md5": "e2792497f84353c3c50ac9b3fac0cf18",
"sha256": "b5e70a7a1e3dbaffd590b9de448937ecbe3eba38c670f33747fad67e16274571"
},
"downloads": -1,
"filename": "jupyterquest-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "e2792497f84353c3c50ac9b3fac0cf18",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11778,
"upload_time": "2024-03-06T05:38:00",
"upload_time_iso_8601": "2024-03-06T05:38:00.116417Z",
"url": "https://files.pythonhosted.org/packages/12/ce/bcb981371fb9167aea9ddfa8f655c703925687c32f52e93bc1ce79b7dfa7/jupyterquest-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 05:38:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gchism94",
"github_project": "jupyterquest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "jupyterquest"
}
