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

Commits on Sep 8, 2022

  1. feat: Add draft of new help message with version info in main.

    @gkapfham
    gkapfham committed Sep 8, 2022
    Configuration menu
    Copy the full SHA
    44fcc81 View commit details
    Browse the repository at this point in the history

  2. feat: Add version module with get_gatorgrade_version and 

    get_gatorgrader_version.
    @gkapfham
    gkapfham committed Sep 8, 2022
    Configuration menu
    Copy the full SHA
    50b5e61 View commit details
    Browse the repository at this point in the history

  3. fix: Refine the phrase in the epilog_message in main.

    @gkapfham
    gkapfham committed Sep 8, 2022
    Configuration menu
    Copy the full SHA
    d779154 View commit details
    Browse the repository at this point in the history

  4. refactor: Reorganize gatorgrade function in main to handle version 

    parameter.
    @gkapfham
    gkapfham committed Sep 8, 2022
    Configuration menu
    Copy the full SHA
    babc827 View commit details
    Browse the repository at this point in the history

  5. fix: Delete the extra help_message not needed in main module.

    @gkapfham
    gkapfham committed Sep 8, 2022
    Configuration menu
    Copy the full SHA
    04a29e9 View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2022

  1. feat: Add get_project_version and refactor version functions.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    e95731a View commit details
    Browse the repository at this point in the history

  2. refactor: Use improved markdown version strings in the main module.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    8372f9f View commit details
    Browse the repository at this point in the history

  3. refactor: Remove a not-needed and commented-out global message in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    b2a7f61 View commit details
    Browse the repository at this point in the history

  4. feat: Add constants and all projects in PROJECTS list in version.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    6063901 View commit details
    Browse the repository at this point in the history

  5. refactor: Further improve help and epilog messages in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    573e44a View commit details
    Browse the repository at this point in the history

  6. fix: Remove spaces in a multi-line string in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    ce82d5b View commit details
    Browse the repository at this point in the history

  7. fix: Remove spaces in a multi-line string in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    d02d49b View commit details
    Browse the repository at this point in the history

  8. refactor: Add version module in the util package.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    da47102 View commit details
    Browse the repository at this point in the history

  9. refactor: Rewrite import for version to be in gatorgrade.util in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    e67be95 View commit details
    Browse the repository at this point in the history

  10. refactor: Delete the version module in top-level package.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    a36cb57 View commit details
    Browse the repository at this point in the history

  11. coms: Add two and update one comment in main module.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    bf92c80 View commit details
    Browse the repository at this point in the history

  12. fix: Delete conditional logic on help that was not needed in main.

    @gkapfham
    gkapfham committed Sep 9, 2022
    Configuration menu
    Copy the full SHA
    b890e10 View commit details
    Browse the repository at this point in the history

Commits on Sep 10, 2022

  1. feat: Add draft of the --version output in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    9d01e2b View commit details
    Browse the repository at this point in the history

  2. feat: Add versions module in util to not conflict with --version in 

    main.
    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    df32e7c View commit details
    Browse the repository at this point in the history

  3. refactor: Remove version module that conflicts with --version in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    9940fa0 View commit details
    Browse the repository at this point in the history

  4. feat: Improve the help_message_markdown in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    93f0237 View commit details
    Browse the repository at this point in the history

  5. coms: Improve a comment in gatorgrade function in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    07495e2 View commit details
    Browse the repository at this point in the history

  6. refactor: Make the variable GATORGRADE_EMOJI in main module constants.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    8ab46d8 View commit details
    Browse the repository at this point in the history

  7. feat: Improve main so that github_message is generated.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    a1ff3ec View commit details
    Browse the repository at this point in the history

  8. style: Reformat the source code in versions.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    fc0a4f3 View commit details
    Browse the repository at this point in the history

  9. feat: Add the github module in util with get_github_projects function.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    b72c6ee View commit details
    Browse the repository at this point in the history

  10. refactor: Use the GATORGRADE_EMOJI_RICH constant in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    9b15c73 View commit details
    Browse the repository at this point in the history

  11. fix: Delete not-needed variables for GitHub projects in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    3dda163 View commit details
    Browse the repository at this point in the history

  12. refactor: Use the RICH_MARKUP_MODE_DEFAULT constant in main.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    a9d9a99 View commit details
    Browse the repository at this point in the history

  13. chore: Increase minimal version of Python to 3.8 in pyproject.toml.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    18e977e View commit details
    Browse the repository at this point in the history

  14. chore: Use Python 3.8 and 3.10 on ubuntu-latest and 3.9 on macos-latest 

    and windows-latest in main.yml.
    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    4528f52 View commit details
    Browse the repository at this point in the history

  15. chore: Bump the poetry-version to 1.2 in the main.yml file.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    0070a2b View commit details
    Browse the repository at this point in the history

  16. chore: Update poetry.lock file to reflect move to Python 3.8 minimum.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    12808aa View commit details
    Browse the repository at this point in the history

  17. fix: Revert/increment poetry-version in main.yml to 1.1.14 as 1.2 fails.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    02c1231 View commit details
    Browse the repository at this point in the history

  18. Merge branch 'main' into feat/add-version

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    726a864 View commit details
    Browse the repository at this point in the history

  19. chore: Specify Python 3.8 as the minimum version in publish.yml.

    @gkapfham
    gkapfham committed Sep 10, 2022
    Configuration menu
    Copy the full SHA
    bf24b98 View commit details
    Browse the repository at this point in the history

Commits on Sep 19, 2022

  1. Merge branch 'main' into feat/add-version

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    7bce6fb View commit details
    Browse the repository at this point in the history

  2. coms: Add a comment to versions to explain PROJECTS variable.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    7bfa554 View commit details
    Browse the repository at this point in the history

  3. coms: Fix an incorrect docstring in the versions module.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    5e80c32 View commit details
    Browse the repository at this point in the history

  4. coms: Add comments to explain steps in the get_project_versions in ve… 

    …rsions.
    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    dd4de85 View commit details
    Browse the repository at this point in the history

  5. refactor: Delete two not-needed functions in the versions module.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    ad8b4d9 View commit details
    Browse the repository at this point in the history

  6. fix: Stop using an epilog in main and add more to version output.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    ba76bbf View commit details
    Browse the repository at this point in the history

  7. feat: Improve the output of --version in the main module.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    4499728 View commit details
    Browse the repository at this point in the history

  8. coms: Improve two comments in the main module.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    6d7b904 View commit details
    Browse the repository at this point in the history

  9. fix: Delete the GATORGRADE_EMOJI constant in main.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    2bb8c01 View commit details
    Browse the repository at this point in the history

  10. refactor: Delete a not-needed variable in main.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    6fc26d7 View commit details
    Browse the repository at this point in the history

  11. coms: Add comments to explain steps in get_github_projects in github.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    87d4587 View commit details
    Browse the repository at this point in the history

  12. coms: Delete a not-needed comment for typer app in main.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    e52e20a View commit details
    Browse the repository at this point in the history

  13. coms: Clarify the docstring comment in main.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    5af4b70 View commit details
    Browse the repository at this point in the history

  14. chore: Bump the semver in the pyproject.toml file.

    @gkapfham
    gkapfham committed Sep 19, 2022
    Configuration menu
    Copy the full SHA
    a5850e2 View commit details
    Browse the repository at this point in the history