Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the --help menu and add the --version and -v flags to the command-line interface #105

Open
wants to merge 50 commits into
base: main
Choose a base branch
from
Open

Improve the --help menu and add the --version and -v flags to the command-line interface #105

wants to merge 50 commits into from

Conversation

gkapfham
Copy link
Collaborator

@gkapfham gkapfham commented Sep 10, 2022 •
edited
Loading

Improve the help menu and command-line interface

Description

Currently it is not possible to determine what version of GatorGrade you have installed through the use of either --help or the --version flags. This means that the only way you can know the version of gatorgrade that you are using is to carefully observe this information when you install it with pipx or to, alternatively, uninstall and then reinstall gatorgrade.

This is what the output now looks like when you use --help:

image

This is what the output now looks like when you use --version:

image

If you want to install and try out this version you can use this command:

pipx install git+https://github.com/GatorEducator/gatorgrade.git@feat/add-version

Linked Issues

None.

Type of Change

  • Feature
  • Bug fix
  • Documentation

Contributors

Reminder

  • All GitHub Actions should be in a passing state before any pull request is merged.
  • All PRs must be reviewed by at least one team member and one member of the Integration team!
  • Any issues this PR closes are tagged in the description!

@gkapfham
feat: Add draft of new help message with version info in main.
44fcc81
@gkapfham
feat: Add version module with get_gatorgrade_version and
50b5e61 
get_gatorgrader_version.
@gkapfham
fix: Refine the phrase in the epilog_message in main.
d779154
@gkapfham
refactor: Reorganize gatorgrade function in main to handle version
babc827 
parameter.
@gkapfham
fix: Delete the extra help_message not needed in main module.
04a29e9
@gkapfham
feat: Add get_project_version and refactor version functions.
e95731a
@gkapfham
refactor: Use improved markdown version strings in the main module.
8372f9f
@gkapfham
refactor: Remove a not-needed and commented-out global message in main.
b2a7f61
@gkapfham
feat: Add constants and all projects in PROJECTS list in version.
6063901
@gkapfham
refactor: Further improve help and epilog messages in main.
573e44a
@gkapfham
fix: Remove spaces in a multi-line string in main.
ce82d5b
@gkapfham
fix: Remove spaces in a multi-line string in main.
d02d49b
@gkapfham
refactor: Add version module in the util package.
da47102
@gkapfham
refactor: Rewrite import for version to be in gatorgrade.util in main.
e67be95
@gkapfham
refactor: Delete the version module in top-level package.
a36cb57
@gkapfham
coms: Add two and update one comment in main module.
bf92c80
@gkapfham
fix: Delete conditional logic on help that was not needed in main.
b890e10
@gkapfham
feat: Add draft of the --version output in main.
9d01e2b
@gkapfham
feat: Add versions module in util to not conflict with --version in
df32e7c 
main.
@gkapfham
refactor: Remove version module that conflicts with --version in main.
9940fa0
@gkapfham
feat: Improve the help_message_markdown in main.
93f0237
@gkapfham
coms: Improve a comment in gatorgrade function in main.
07495e2
@gkapfham
refactor: Make the variable GATORGRADE_EMOJI in main module constants.
8ab46d8
@gkapfham
feat: Improve main so that github_message is generated.
a1ff3ec
@gkapfham
style: Reformat the source code in versions.
fc0a4f3
@gkapfham
feat: Add the github module in util with get_github_projects function.
b72c6ee
@gkapfham
refactor: Use the GATORGRADE_EMOJI_RICH constant in main.
9b15c73
@gkapfham
fix: Delete not-needed variables for GitHub projects in main.
3dda163
@gkapfham
refactor: Use the RICH_MARKUP_MODE_DEFAULT constant in main.
a9d9a99
@gkapfham gkapfham added the enhancement New feature or request label Sep 10, 2022
@gkapfham gkapfham self-assigned this Sep 10, 2022
burgess01
burgess01 approved these changes Sep 11, 2022
View reviewed changes
Copy link
Contributor

@burgess01 burgess01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! I just had one question. I saw in the versions.py file that you had functions specifically for getting the versions of gatorgrade and gatorgrader, and that these functions aren't currently in use. Especially since these don't have formatting like the others do, are you planning on using these in the future or are they just if-needed? Thanks!

@gkapfham
Copy link
Collaborator Author

Hello @burgess01, thanks for pointing out this oversight!

I'm pretty sure that those functions are no longer needed and should be removed from the code base before merging this PR.

I will review everything again on Monday and most likely remove those functions and make additional tweaks as needed.

@gkapfham gkapfham requested review from burgess01 and removed request for dluman September 19, 2022 01:55
@gkapfham
Copy link
Collaborator Author

Hi @burgess01 and @Yanqiao4396 --- this PR is now very out of date.

However, once we have repaired the build and made a release of your new feature(s), perhaps we can revisit this PR, patch it up, and then release it so that these flags are available?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@burgess01 burgess01 burgess01 approved these changes

Assignees

@gkapfham gkapfham

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@gkapfham @burgess01