Code update: refactor the way the report files are defined in the command line and passed into the configure_reports function

[rebekahrudd]

Code update: refactor the way the report files are defined in the command line and passed into the configure_reports function

Description

This latest change to gatorgrade is to refactor the code that configures the report. This update changes the command line interface and the commands that are passed in. There is no longer a `--report`` command rather there are three that address different aspects.
The purpose of this is to have better documentation for users to understand the acceptable options for each part of generating a report.

Linked Issues

https://github.com/GatorEducator/gatorgrade/issues/145

closes: #145

Type of Change

• Feature
• Bug fix
• Documentation

Contributors

• @rebekahrudd

Testing this PR

Setup:

1. Choose any unfinished repo with gatorgrade to test this gatorgrade update.
2. In the pyproject.toml file of the repo you chose add the command pipx install git+https://github.com/rebekahrudd/gatorgrade in place of the command pipx install gatorgrade
3. Save and push this update to Github
4. Wait for Github actions to run

How to check if this PR worked:

1. In GitHub actions check Gatorgrade to ensure you see "This is the new update of gatorgrade" printed next to FAILURES. This way you will know that rebekahrudd's branch ran and not the latest pipx version of gatorgrade
2. When you are on the summary page of Github actions you should be able to see the GatorInsights Report. It should look like this:
   

If you see the report and have confirmed that it was my version of Github that ran then this update is working and this PR can get approved!

[gkapfham]

Hello @rebekahrudd can you please give us several examples of the way in which you have changed the code and, in particular, can you clarify whether or not these refactorings are going to change the output and/or behavior of GatorGrade?

[rebekahrudd]

The inputs to gatorgrade have changed though the output has not.

Here is a screenshot of the updated help menu:

[hemanialaparthi]

@rebekahrudd! I just tested this out locally and my --help function has the intented output:

(venv) hemanialaparthi@Hemanis-MacBook-Air executable-examination-example-solution % gatorgrade --help
                                                                                                                                                                              
 Usage: gatorgrade [OPTIONS] COMMAND [ARGS]...                                                                                                                                
                                                                                                                                                                              
 🐊 Run the GatorGrader checks in the specified gatorgrade.yml file.                                                                                                          
                                                                                                                                                                              
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --config                 -c      PATH        Name of the yml file. [default: gatorgrade.yml]                                                                               │
│ --report-location                [file|env]  [default: None]                                                                                                               │
│ --report-storing-type            [json|md]   [default: None]                                                                                                               │
│ --storing-location-name          [github]    [default: None]                                                                                                               │
│ --help                                       Show this message and exit.                                                                                                   │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

And, I can see my GitHub Actions reporting the insights:

NOTE: for future people testing this PR, the build.yml file is in the .github and also if you don't see your GitHub Actions, make sure you check if you have them enable for your repo.

[suppo01]

Looks good to me! I got the expected output using my fork of the solution repo.

[CalebKendra]

LGTM, descriptive commit messages

[suppo01]

Looks good to me!

[hemanialaparthi]

This works!