update README and add scaffolding folder to autogenerated template.

Author: Nathan Sprague

README.md

@@ -19,33 +19,129 @@ Features include:
 *    A script that makes it possible to test the autograder logic
      locally before uploading to the Gradescope server:
      `test_autograder.py`
+*    A graphical tool for testing autograders and building autograder zip
+     files.
 
-Documentation can be found here: <https://jmu-cs.github.io/jmu_python_gradescope_utils/>
+API Documentation can be found here: <https://jmu-cs.github.io/jmu_python_gradescope_utils/>
 
 ## Installation
 
 ```
+pip3 install wheel
 pip3 install git+https://github.com/JMU-CS/jmu_python_gradescope_utils.git
 ```
 
-## Instructions
+On Linux, this will probably add the GUI script to your PATH so that it can be executed as:
 
-See `examples/hello_world_autograder/` for a sample autograder.
+```
+$ jmu_gradescope_builder.py
+```
+
+If that doesn't work, you may need to execute the script using the Python interpreter:
+
+```
+python3 jmu_python_gradescope_utils/scripts/jmu_gradescope_builder.py
+```
+
+## Autograder Format
+
+See `examples/hello_world/` and `hello_world_w_coverage` for a sample autograders.
+
+Autograder folders are organized as follows:
+
+```
+hello_world/
+│
+├── config.ini
+│
+├── configurations/
+│   ├── flake8.cfg
+│   ├── docstring.cfg
+│   └── requirements.txt
+│
+├── sample/
+│   └── hello_world.py
+│
+└── scaffolding/
+│
+└── tests/
+    └── test_hello.py
+```
+
+
+### `config.ini`
+
+This specifies the files that must be submitted by the student:
+
+```
+[SUBMIT]
+code: hello_world.py
+tests:
+```
+
+The `test` field should contain the names of student test files for assignments that require student-submitted unit tests.
 
-To perform a test run: 
+### `flake8.cfg`
 
-```bash
-$ cd /your/autograder
-$ test_autograder.py /path/to/sample/submission/folder
+This is the `flake8` configuration file that will be used by
+[assertPassesPep8](https://jmu-cs.github.io/jmu_python_gradescope_utils/jmu_test_case.html#jmu_gradescope_utils.jmu_test_case._JmuTestCase.assertPassesPep8).
+
+The [flake8](https://flake8.pycqa.org/en/latest/index.html) tool is
+used by our library for Python style checking.  The possible error
+codes are listed in the following locations:
+
+* [pycodestyle error codes](https://pycodestyle.pycqa.org/en/latest/intro.html#error-codes)
+* [flake8 error codes](https://flake8.pycqa.org/en/latest/user/error-codes.html)
+
+
+The current default looks like this:
+```
+[flake8]
+select = E, F, C90
+ignore = W, E226, E123, W504, N818, E704, E24, E121, E126
+max-line-length = 100
 ```
 
-The output of the test will be stored in a file named
-`test_results.json`.
+### `docstring.cfg`
+This is the `flake8` configuration file that will be used by [assertDocstringsCorrect](https://jmu-cs.github.io/jmu_python_gradescope_utils/jmu_test_case.html#jmu_gradescope_utils.jmu_test_case._JmuTestCase.assertDocstringsCorrect).  The current default looks like this:
 
-Once everything is working correctly, just zip the contents of the
-autograder folder and upload to Gradescope:
+```
+[flake8]
+select = D,DAR
+ignore = D401
+
+[pydocstyle]
+convention=google
 
-```bash
-$ cd /your/autograder
-$ zip -r autograder.zip .
+[darglint]
+docstring_style=google
 ```
+
+The available error codes for the two plugins can be found here:
+
+* `pydocstyle`: <http://www.pydocstyle.org/en/stable/error_codes.html>
+* `darglint`: <https://github.com/terrencepreilly/darglint#error-codes>
+
+
+### `requirements.txt`
+
+This file should list any python packages that are required for this
+assignment. They will be pip installed on the server by the autograder
+script. 
+
+### sample/
+
+This folder should contain a reference solution.  This isn't strictly
+necessary, but the autograder testing utility will expect to find a
+solution at this location.
+
+### scaffolding/
+
+Any files in this folder will be copied into the same folder as the
+student submission before testing.  This could be data files or Python
+modules.
+
+### tests/
+
+Instructor unit tests.
+

jmu_gradescope_utils/build_utils.py

@@ -10,7 +10,6 @@
 import subprocess
 import traceback
 import sys
-import shutil
 
 def create_template(folder):
     path = Path(folder)
@@ -21,9 +20,11 @@ def create_template(folder):
     source = pkg_resources.resource_filename('jmu_gradescope_utils',
                                              os.path.join('data', 'template'))
     shutil.copytree(source, path)
+    # Can't have empty folders in the template...
+    (path / 'scaffolding').mkdir(exist_ok=True)
     logging.info(f'Created {path}')
     return True
-    
+
 
 def test_autograder(autograder_folder, sample_folder,
                     delete_tmp_folder=True):

setup.py

@@ -22,14 +22,15 @@ def package_files(directory):
     author_email='nathan.r.sprague@gmail.com',
     description='Python Gradescope utilities',
     install_requires=[
-        'gradescope-utils',
+        'gradescope-utils>=0.4',
         'flake8',
-        'coverage',
+        'coverage>=6.0',
         'pep8-naming',
         'flake8-docstrings',
         'flake8-rst-docstrings',
         'darglint',
         'tk',
+        'importlib_metadata>=4.2',
     ],
     scripts=['scripts/test_autograder.py',
              'scripts/jmu_gradescope_builder.py'],