-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into feature/dockerfile
- Loading branch information
Showing
13 changed files
with
227 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| { | ||
| "files": [ | ||
| "README.md" | ||
| ], | ||
| "imageSize": 100, | ||
| "contributorsPerLine": 7, | ||
| "badgeTemplate": "[](#contributors)", | ||
| "contributors": [ | ||
| { | ||
| "login": "yeej2", | ||
| "name": "Joshua Yee", | ||
| "avatar_url": "https://avatars1.githubusercontent.com/u/22895281?v=4", | ||
| "profile": "https://github.com/yeej2", | ||
| "contributions": [ | ||
| "code", | ||
| "infra", | ||
| "review", | ||
| "doc" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "Michionlion", | ||
| "name": "Saejin Mahlau-Heinert", | ||
| "avatar_url": "https://avatars1.githubusercontent.com/u/5274499?v=4", | ||
| "profile": "https://saejinmh.com", | ||
| "contributions": [ | ||
| "code", | ||
| "infra", | ||
| "platform", | ||
| "review" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "quigley-c", | ||
| "name": "Carson Quigley", | ||
| "avatar_url": "https://avatars1.githubusercontent.com/u/35495466?v=4", | ||
| "profile": "https://github.com/quigley-c", | ||
| "contributions": [ | ||
| "doc" | ||
| ] | ||
| }, | ||
| { | ||
| "login": "JattMones", | ||
| "name": "Matt", | ||
| "avatar_url": "https://avatars0.githubusercontent.com/u/22432176?v=4", | ||
| "profile": "https://github.com/JattMones", | ||
| "contributions": [ | ||
| "doc" | ||
| ] | ||
| } | ||
| ], | ||
| "projectName": "quizagator", | ||
| "projectOwner": "GatorEducator", | ||
| "repoType": "github", | ||
| "repoHost": "https://github.com" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,95 @@ | ||
|  | ||
|
|
||
| # Quiz-A-Gator | ||
|
|
||
|  | ||
|
|
||
| [](https://travis-ci.com/GatorEducator/quizagator) | ||
| []( | ||
| http://codecov.io/github/GatorEducator/gatorquizagator?branch=master) | ||
| http://codecov.io/github/GatorEducator/quizagator?branch=master) | ||
| [](#contributors) | ||
| []( | ||
| https://www.python.org/) | ||
|
|
||
| This Django web application provides an interface for faculty to develop and | ||
| distribute quizzes to students. The student answers can then be | ||
| automatically graded based on information or scripts the faculty member | ||
| uploads. | ||
| ## A Quiz Creation Tool for File Upload and Custom Grading | ||
|
|
||
| It may seem obvious that there are many other tools for creating quizzes, but | ||
| interestingly the quiz creation tools out there all have one thing in common: | ||
| Web-based GUI. Quizagator is a web application that provides an interface for | ||
| creating quizzes without the overhead of a GUI making quizzes creation tedious | ||
| and--in the case that the design of the GUI tool changes--confusing. By allowing | ||
| quiz creation through a text-based syntax it is possible to make quiz creation | ||
| lightning fast and much more consistent than fiddling with GUI tools. Not to | ||
| mention a text-based quiz creation allows for easy question duplication and | ||
| modification. Quizagator supports uploading quizzes in CSV format and allows for | ||
| grading with a custom grading program. The tool uses Flask with noSQL to manage | ||
| quizzes and results, as well as storing any custom grading tools uploaded to the | ||
| quizzes. | ||
|
|
||
| Quizagator uses it's own custom quiz creation syntax in CSV format that is | ||
| designed to be programmer-friendly to allow for more mutable quiz creation that | ||
| comes with all the benefits a text-based system allows, namely the ability to use | ||
| your favorite text editor rather than the ever-present GUI's. | ||
|
|
||
| Quiz questions look like this: | ||
|
|
||
| ```csv | ||
| "Quizquestion?","correct answer","answer1","answer2","answer3","answer4" | ||
| "What's the best quiz creation tool?","1","Quizagator","Google Forms","Sakai Quizzes","Quiz Maker" | ||
| ``` | ||
|
|
||
| Once a quiz has been created a grading program can be uploaded to implement a | ||
| custom grading scheme for the quiz. Quizagator will run the program on the | ||
| results of the quiz and return the output. | ||
|
|
||
| ## Pipenv | ||
|
|
||
| Quizagator uses a [Pipenv](https://project/pipenv/)-built virtual environment | ||
| to standardize the execution of the project. If you don't have pipenv we highly | ||
| recommend installing it using `pip`: | ||
|
|
||
| ``` | ||
| pip install pipenv | ||
| ``` | ||
|
|
||
| If for some reason this doesn't work for you, you can check out the [pipenv | ||
| github](https://github.com/pypa/pipenv). | ||
|
|
||
| ## Commands | ||
| After cloning the repo for the first time, run the `pipenv install --dev` | ||
| command to install develop and default packages. Other commands can be seen | ||
| below. | ||
|
|
||
| List of scripts: `cat Pipfile` | ||
| After cloning the repo for the first time, run | ||
|
|
||
| ``` | ||
| pipenv install --dev | ||
| ``` | ||
|
|
||
| to install the developer and default packages. To get a list of scripts for the | ||
| project, inspect the `[scripts]` tag in `Pipfile`: | ||
|
|
||
| ``` | ||
| cat Pipfile | ||
| ``` | ||
|
|
||
| Finally, to run the project locally: | ||
|
|
||
| ``` | ||
| pipenv run server | ||
| ``` | ||
|
|
||
| Or use the following to see all the options: | ||
|
|
||
| ``` | ||
| pipenv run python run.py --help | ||
| ``` | ||
|
|
||
| ## Contributors | ||
|
|
||
| Check out our contributors! | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> | ||
| <!-- prettier-ignore --> | ||
| <table><tr><td align="center"><a href="https://github.com/yeej2"><img src="https://avatars1.githubusercontent.com/u/22895281?v=4" width="100px;" alt="Joshua Yee"/><br /><sub><b>Joshua Yee</b></sub></a><br /><a href="https://github.com/GatorEducator/quizagator/commits?author=yeej2" title="Code">💻</a> <a href="#infra-yeej2" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#review-yeej2" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/GatorEducator/quizagator/commits?author=yeej2" title="Documentation">📖</a></td><td align="center"><a href="https://saejinmh.com"><img src="https://avatars1.githubusercontent.com/u/5274499?v=4" width="100px;" alt="Saejin Mahlau-Heinert"/><br /><sub><b>Saejin Mahlau-Heinert</b></sub></a><br /><a href="https://github.com/GatorEducator/quizagator/commits?author=Michionlion" title="Code">💻</a> <a href="#infra-Michionlion" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#platform-Michionlion" title="Packaging/porting to new platform">📦</a> <a href="#review-Michionlion" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/quigley-c"><img src="https://avatars1.githubusercontent.com/u/35495466?v=4" width="100px;" alt="Carson Quigley"/><br /><sub><b>Carson Quigley</b></sub></a><br /><a href="https://github.com/GatorEducator/quizagator/commits?author=quigley-c" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/JattMones"><img src="https://avatars0.githubusercontent.com/u/22432176?v=4" width="100px;" alt="Matt"/><br /><sub><b>Matt</b></sub></a><br /><a href="https://github.com/GatorEducator/quizagator/commits?author=JattMones" title="Documentation">📖</a></td></tr></table> | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-LIST:END --> | ||
|
|
||
| Serve our site: `pipenv run server` | ||
| Don't know what the emoji's mean? Check out the [key](https://allcontributors.org/docs/en/emoji-key)! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| """Configuration file for the test suite""" | ||
|
|
||
| import os | ||
| import sys | ||
|
|
||
| GO_BACK_A_DIRECTORY = "/../" | ||
|
|
||
| # set the system path to contain the previous directory | ||
| PREVIOUS_DIRECTORY = os.path.dirname(os.path.abspath(__file__)) | ||
| sys.path.insert(0, PREVIOUS_DIRECTORY + GO_BACK_A_DIRECTORY) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| """ basic tests """ | ||
| import pytest | ||
|
|
||
| from application import app | ||
| from application import login | ||
|
|
||
|
|
||
|
|
||
| def test_app_created(): | ||
| """Start with a blank database.""" | ||
| assert app is not None | ||
|
|
||
| class FlaskrTestCase(unittest.TestCase): | ||
|
|
||
| def setUp(self): | ||
| self.db_fd, flaskr.app.config['DATABASE'] = tempfile.mkstemp() | ||
| flaskr.app.testing = True | ||
| self.app = flaskr.app.test_client() | ||
| with flaskr.app.app_context(): | ||
| flaskr.init_db() | ||
|
|
||
|
|
||
| # def test_index(app): | ||
| # res = app.get("/") | ||
| # # print(dir(res), res.status_code) | ||
| # assert res.status_code == 200 | ||
| # assert b"" in res.data |