team4-GatorConfig

A simple Python project utilizing a CLI approach to automate generating configuration files for GatorGrader. The GitHub Actions workflow executes pytest (with coverage) and pylint using the Poetry configuration, and checks markdown with markdownlint and spelling with cspell.

Requirements

• Python
• Pipx
• Poetry

Usage

Installing Python dependencies

After cloning this project, you will likely want to instruct Poetry to create a virtual environment and install the Python packages (like pytest and pylint) listed in pyproject.toml.

To install Python dependencies:

poetry install

Running tasks

This project uses the taskipy task runner to simplify testing and linting. You can see the actual commands run when tasks are executed under the [tool.taskipy.tasks] header in pyproject.toml.

• Test your code with poetry run task test
• Lint your code with poetry run task lint

Running GatorConfig

GatorConfig is a tool that will utilize the command line interface, which was built to accommodate the users. To run the GatorConfig program in CLI, type the command:

poetry run gatorconfig

Once you run this command, the program will output

Wrote file to: C:\Users\<YOUR PATH>\GatorConfig\gatorgrader.yml

This command will auto-generate a default configuration file for GatorGradle named gatorgrader.yml which will contain a default input for the variables, such as the name, break, fastfail, etc.,

Additionally, you can run the poetry run gatorconfig --help for more information about the configuration. This command will list out the variables in the file as well as the defaults it outputs.