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 230 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 230 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!

ullrichd21 and others added 30 commits July 28, 2022 19:43
@ullrichd21
Add JSON output with "--report" or "-r" flags.
df8df34
@ullrichd21
Fix test to support returned tuple.
6d7d223
@ullrichd21
Fix codestyle/linting.
6c0ee64
@ullrichd21
Fix codestyle/linting, add encoding type.
feae40d
@ullrichd21
Fix codestyle/linting.
58dc7c2
@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 gkapfham marked this pull request as draft October 24, 2024 18:06
@rebekahrudd
Copy link
Collaborator

This branch has been updated to current version of gatorgrade

Terminal output of the command gatorgrade --version
s-version

Terminal output of command gatorgrade --help
s-help

rebekahrudd
rebekahrudd approved these changes Nov 22, 2024
View reviewed changes
Copy link
Collaborator

@rebekahrudd rebekahrudd left a comment

Choose a reason for hiding this comment

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

This updated works on Linux, though the --help command does not show the complete version output.

@rebekahrudd rebekahrudd marked this pull request as ready for review November 23, 2024 04:11
@boulais01 boulais01 self-requested a review December 2, 2024 20:28
dyga01
dyga01 approved these changes Dec 9, 2024
View reviewed changes
Copy link
Collaborator

@dyga01 dyga01 left a comment

Choose a reason for hiding this comment

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

These changes appear to be working on Mac Os. LGTM!

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

@dyga01 dyga01 dyga01 approved these changes

@rebekahrudd rebekahrudd rebekahrudd approved these changes

@boulais01 boulais01 boulais01 approved these changes

@AlishChhetri AlishChhetri Awaiting requested review from AlishChhetri

@PCain02 PCain02 Awaiting requested review from PCain02

@CalebKendra CalebKendra Awaiting requested review from CalebKendra

@Chezka109 Chezka109 Awaiting requested review from Chezka109

@burgess01 burgess01 Awaiting requested review from burgess01

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.
8 participants
@gkapfham @rebekahrudd @burgess01 @boulais01 @dyga01 @ullrichd21 @Yanqiao4396 @Michionlion