Add a new command for generic help

changelog.rst

@@ -1,6 +1,10 @@
 Commit History
 ==============
 
+0.4.2 (08/15/2023)
+------------------
+- Add a new command for generic help
+
 0.4.1 (08/10/2023)
 ------------------
 - Reuse options via callables.py

gitverse/__init__.py

@@ -1 +1 @@
-version = "2.1"
+version = "2.2"

gitverse/commits.py

@@ -161,7 +161,7 @@ def run(branch: str, filename: str, title: str) -> NoReturn:
 @click.option("-t", "--title", help="Title under which the commit notes should be stored")
 def main(*args, reverse: str = None, debug: str = None, version: str = None,
          branch: str = None, filename: str = None, title: str = None) -> None:
-    """Generate a reStructuredText/Markdown file using github commit notes.
+    """Generate a reStructuredText/Markdown file using GitHub commit notes.
 
     Run 'gitverse-commit reverse' to generate gitverse-commit in reverse order.
 

gitverse/help.py

@@ -0,0 +1,11 @@
+import click
+
+
+@click.command()
+def main(*args) -> None:
+    """Generate a reStructuredText/Markdown file using GitHub releases or commit history.
+
+    Run 'gitverse-release --help' to get release notes' specific information.
+
+    Run 'gitverse-commit --help' to get commit history specific information.
+    """

gitverse/releases.py

@@ -179,11 +179,11 @@ def run(filename: str, title: str) -> NoReturn:
 @click.option("-e", "--env", help="Filename/filepath for .env file to load the environment variables")
 def main(*args, reverse: str = None, debug: str = None,
          version: str = None, filename: str = None, title: str = None, env: str = None) -> None:
-    """Generate a reStructuredText/Markdown file using github releases.
+    """Generate a reStructuredText/Markdown file using GitHub releases.
 
-    Run 'gitverse-commit reverse' to generate release notes in reverse order.
+    Run 'gitverse-release reverse' to generate release notes in reverse order.
 
-    Run 'gitverse-commit debug' to enable debug mode.
+    Run 'gitverse-release debug' to enable debug mode.
     """
     if version:
         debugger.info(pkg_version)

pyproject.toml

@@ -42,6 +42,7 @@ dev = ["pre-commit", "xmltodict"]
 [project.scripts]
 gitverse-commit = "gitverse.commits:main"
 gitverse-release = "gitverse.releases:main"
+gitverse = "gitverse.help:main"
 
 [project.urls]
 Homepage = "https://github.com/thevickypedia/gitverse"

release_notes.rst

@@ -1,6 +1,10 @@
 Release Notes
 =============
 
+2.2 (08/15/2023)
+----------------
+- Add a new command for generic help
+
 2.1 (08/10/2023)
 ----------------
 - Performance improvements and more clear logging