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.

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

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
Changes from 1 commit
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
44fcc81
feat: Add draft of new help message with version info in main.
gkapfham Sep 8, 2022
50b5e61
feat: Add version module with get_gatorgrade_version and
gkapfham Sep 8, 2022
d779154
fix: Refine the phrase in the epilog_message in main.
gkapfham Sep 8, 2022
babc827
refactor: Reorganize gatorgrade function in main to handle version
gkapfham Sep 8, 2022
04a29e9
fix: Delete the extra help_message not needed in main module.
gkapfham Sep 8, 2022
e95731a
feat: Add get_project_version and refactor version functions.
gkapfham Sep 9, 2022
8372f9f
refactor: Use improved markdown version strings in the main module.
gkapfham Sep 9, 2022
b2a7f61
refactor: Remove a not-needed and commented-out global message in main.
gkapfham Sep 9, 2022
6063901
feat: Add constants and all projects in PROJECTS list in version.
gkapfham Sep 9, 2022
573e44a
refactor: Further improve help and epilog messages in main.
gkapfham Sep 9, 2022
ce82d5b
fix: Remove spaces in a multi-line string in main.
gkapfham Sep 9, 2022
d02d49b
fix: Remove spaces in a multi-line string in main.
gkapfham Sep 9, 2022
da47102
refactor: Add version module in the util package.
gkapfham Sep 9, 2022
e67be95
refactor: Rewrite import for version to be in gatorgrade.util in main.
gkapfham Sep 9, 2022
a36cb57
refactor: Delete the version module in top-level package.
gkapfham Sep 9, 2022
bf92c80
coms: Add two and update one comment in main module.
gkapfham Sep 9, 2022
b890e10
fix: Delete conditional logic on help that was not needed in main.
gkapfham Sep 9, 2022
9d01e2b
feat: Add draft of the --version output in main.
gkapfham Sep 10, 2022
df32e7c
feat: Add versions module in util to not conflict with --version in
gkapfham Sep 10, 2022
9940fa0
refactor: Remove version module that conflicts with --version in main.
gkapfham Sep 10, 2022
93f0237
feat: Improve the help_message_markdown in main.
gkapfham Sep 10, 2022
07495e2
coms: Improve a comment in gatorgrade function in main.
gkapfham Sep 10, 2022
8ab46d8
refactor: Make the variable GATORGRADE_EMOJI in main module constants.
gkapfham Sep 10, 2022
a1ff3ec
feat: Improve main so that github_message is generated.
gkapfham Sep 10, 2022
fc0a4f3
style: Reformat the source code in versions.
gkapfham Sep 10, 2022
b72c6ee
feat: Add the github module in util with get_github_projects function.
gkapfham Sep 10, 2022
9b15c73
refactor: Use the GATORGRADE_EMOJI_RICH constant in main.
gkapfham Sep 10, 2022
3dda163
fix: Delete not-needed variables for GitHub projects in main.
gkapfham Sep 10, 2022
a9d9a99
refactor: Use the RICH_MARKUP_MODE_DEFAULT constant in main.
gkapfham Sep 10, 2022
18e977e
chore: Increase minimal version of Python to 3.8 in pyproject.toml.
gkapfham Sep 10, 2022
4528f52
chore: Use Python 3.8 and 3.10 on ubuntu-latest and 3.9 on macos-latest
gkapfham Sep 10, 2022
0070a2b
chore: Bump the poetry-version to 1.2 in the main.yml file.
gkapfham Sep 10, 2022
12808aa
chore: Update poetry.lock file to reflect move to Python 3.8 minimum.
gkapfham Sep 10, 2022
02c1231
fix: Revert/increment poetry-version in main.yml to 1.1.14 as 1.2 fails.
gkapfham Sep 10, 2022
726a864
Merge branch 'main' into feat/add-version
gkapfham Sep 10, 2022
bf24b98
chore: Specify Python 3.8 as the minimum version in publish.yml.
gkapfham Sep 10, 2022
7bce6fb
Merge branch 'main' into feat/add-version
gkapfham Sep 19, 2022
7bfa554
coms: Add a comment to versions to explain PROJECTS variable.
gkapfham Sep 19, 2022
5e80c32
coms: Fix an incorrect docstring in the versions module.
gkapfham Sep 19, 2022
dd4de85
coms: Add comments to explain steps in the get_project_versions in ve…
gkapfham Sep 19, 2022
ad8b4d9
refactor: Delete two not-needed functions in the versions module.
gkapfham Sep 19, 2022
ba76bbf
fix: Stop using an epilog in main and add more to version output.
gkapfham Sep 19, 2022
4499728
feat: Improve the output of --version in the main module.
gkapfham Sep 19, 2022
6d7b904
coms: Improve two comments in the main module.
gkapfham Sep 19, 2022
2bb8c01
fix: Delete the GATORGRADE_EMOJI constant in main.
gkapfham Sep 19, 2022
6fc26d7
refactor: Delete a not-needed variable in main.
gkapfham Sep 19, 2022
87d4587
coms: Add comments to explain steps in get_github_projects in github.
gkapfham Sep 19, 2022
e52e20a
coms: Delete a not-needed comment for typer app in main.
gkapfham Sep 19, 2022
5af4b70
coms: Clarify the docstring comment in main.
gkapfham Sep 19, 2022
a5850e2
chore: Bump the semver in the pyproject.toml file.
gkapfham Sep 19, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: Delete two not-needed functions in the versions module.
  • Loading branch information
gkapfham committed Sep 19, 2022
commit ad8b4d96b601ebdd3f8e10ab2b13fc18138ef594
12 changes: 0 additions & 12 deletions gatorgrade/util/versions.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,6 @@ def get_project_version(project: str) -> str:
return project + COLON + SPACE + project_version_str


def get_gatorgrade_version() -> str:
"""Determine and return the information about GatorGrade's version."""
gatorgrade_version_str = get_project_version("gatorgrade")
return gatorgrade_version_str


def get_gatorgrader_version() -> str:
"""Determine and return the information about GatorGrader's version."""
gatorgrader_version_str = get_project_version("gatorgrader")
return gatorgrader_version_str


def get_project_versions(project_list: List[str] = PROJECTS) -> str:
"""Create a version string for all specified projects."""
# create an empty version string that this function
Expand Down