- Tabulate help info - h

- Increase version count prior to release - v0.2.3

Author: Simatwa

docs/CHANGELOG.md

@@ -2,11 +2,12 @@
 
 **What's new?**
 
-- Initial release. 
+- Initial release.
 
 ## v0.0.2
 
 **What's new?**
+
 - Enhanced response generation
 - Prompt optimizers added - *[code, shell_command]*
 - Prompt optimizers added - *Console*
@@ -15,30 +16,35 @@
 ## v0.0.3
 
 **What's new?**
+
 - Busy bar index bug **fixed** - *(Console)*
 - Other minor fixed.
 
 ## v0.0.4
 
 **What's new?**
+
 - Minor fixes 
 
 ## v0.0.5
 
 **What's new?**
+
 - Multiple variables renamed.
 - First release under `python-tgpt`
 
 ## v0.0.6
 
 **What's new?**
+
 - `generate` is the default command. Thanks to @sameedzahoor
 - Control response framing `--quiet`
 - `generate` based prompt optimizaion - `--code` & `--shell`
 
 ## v0.0.7
 
 **What's new?**
+
 - Chat conversationally - *(Experimental)*
 - Maintain chat history *.txt*
 - Load chat history from file
@@ -47,6 +53,7 @@
 ## v0.0.8
 
 **What's new?**
+
 - Reading piped input as prompt - *(Console)*. Thanks to @sameedzahoor
 - Reset conversation - *(Console)*
 - View conversation history - *(Console)*
@@ -55,43 +62,62 @@
 ## v0.0.9
 
 **What's new?**
+
 - Chatting conversationally - **Stable**
 
 ## v0.1.0
 
 **What's new?**
+
 - Chatting conversationally - **Default Mode**
 
 ## v0.1.1
 
 **What's new?**
+
 - Bug fixed - *file not found error*
 
 ## v0.1.2
 
 **What's new?**
+
 - Check version - `--version`
 - Minor fixes.
 
 ## v0.1.3
 
 **What's new?**
+
 - Invalid response - **fixed**
 
 ## v0.1.4
+
 **What's new?**
+
 - Incomplete response - **fixed**
 
 ## v0.2.0
+
 **What's new?**
-- Multiple LLM providers
 
+- Multiple LLM providers
 
 ## v0.2.1
+
 **What's new?**
+
 - Fakeopen rendering issue fixed - [#7](https://github.com/Simatwa/python-tgpt/issues/7)
 
 ## v0.2.2
+
 **What's new?**
+
 - Package renamed to **pytgpt** - [#7](https://github.com/Simatwa/python-tgpt/issues/7)
-- Visible vertical overflow - [#7](https://github.com/Simatwa/python-tgpt/issues/7)
+- Visible vertical overflow - [#7](https://github.com/Simatwa/python-tgpt/issues/7)
+
+## v0.2.3
+
+**What's new?**
+
+- Tabulated help info - `h`
+- Control response vertical overflow behaviour.

docs/README.md

@@ -8,7 +8,7 @@
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml"><img src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml/badge.svg" alt="Python Test"/></a>
 -->
 <a href="https://github.com/Simatwa/python-tgpt/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/static/v1?logo=GPL&color=Blue&message=MIT&label=License"/></a>
-<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=0.2.2&color=green"/></a>
+<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=0.2.3&color=green"/></a>
 <a href="https://github.com/psf/black"><img alt="Black" src="https://img.shields.io/static/v1?logo=Black&label=Code-style&message=Black"/></a>
 <a href="#"><img alt="Passing" src="https://img.shields.io/static/v1?logo=Docs&label=Docs&message=Passing&color=green"/></a>
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml"><img src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml/badge.svg"/></a>

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name="python-tgpt",
-    version="0.2.2",
+    version="0.2.3",
     license="MIT",
     author="Smartwa",
     maintainer="Smartwa",

src/pytgpt/__init__.py

@@ -1,6 +1,6 @@
 from .utils import appdir
 
-__version__ = "0.2.2"
+__version__ = "0.2.3"
 __author__ = "Smartwa"
 __repo__ = "https://github.com/Simatwa/python-tgpt"
 

src/pytgpt/console.py

@@ -19,6 +19,7 @@
 from rich.markdown import Markdown
 from rich.console import Console
 from rich.live import Live
+from rich.table import Table
 from rich.prompt import Prompt
 from typing import Iterator
 from pytgpt.utils import Optimizers
@@ -185,7 +186,7 @@ def main(*args, **kwargs):
 
 
 class Main(cmd.Cmd):
-    intro = f"Welcome to AI Chat in terminal. Type 'help' or '?' for usage info \n Submit any bug at {pytgpt.__repo__}/issues/new"
+    intro = f"Welcome to AI Chat in terminal. Type 'help' or 'h' for usage info \n Submit any bug at {pytgpt.__repo__}/issues/new"
     prompt = f"╭─[{getpass.getuser().capitalize()}@TGPT](v{pytgpt.__version__})\n╰─>"
 
     def __init__(
@@ -368,11 +369,52 @@ def output_bond(
                 json.dump(text, fh, indent=4)
             click.secho(f"Successfuly saved to `{save_to}`", fg="green")
 
+    def do_h(self, line):
+        """Show help info in tabular form"""
+        table = Table(
+            title="Help info",
+            show_lines=True,
+        )
+        table.add_column("No.", style="white", justify="center")
+        table.add_column("Command", style="yellow", justify="left")
+        table.add_column("Function", style="cyan")
+        command_methods = [
+            getattr(self, method)
+            for method in dir(self)
+            if callable(getattr(self, method)) and method.startswith("do_")
+        ]
+        command_methods.append(self.default)
+        command_methods.reverse()
+        for no, method in enumerate(command_methods):
+            table.add_row(
+                str(no + 1),
+                method.__name__[3:] if not method == self.default else method.__name__,
+                method.__doc__,
+            )
+        Console().print(table)
+
     @busy_bar.run("Settings saved")
     def do_settings(self, line):
         """Configre settings"""
+        self.prettify = click.confirm(
+            "\nPrettify markdown response", default=self.prettify
+        )
+        busy_bar.spin_index = click.prompt(
+            "Spin bar index [0:/, 1:■█■■■, 2:⣻]",
+            default=busy_bar.spin_index,
+            type=click.IntRange(0, 2),
+        )
+        self.color = click.prompt("Response stdout font color", default=self.color)
+        self.code_theme = Prompt.ask(
+            "Enter code_theme", choices=rich_code_themes, default=self.code_theme
+        )
+        self.vertical_overflow = Prompt.ask(
+            "\nVertical overflow behaviour",
+            choices=["ellipsis", "visible", "crop"],
+            default=self.vertical_overflow,
+        )
         self.bot.max_tokens_to_sample = click.prompt(
-            "Maximum tokens to sample",
+            "\nMaximum tokens to sample",
             type=click.INT,
             default=self.bot.max_tokens_to_sample,
         )
@@ -392,18 +434,6 @@ def do_settings(self, line):
         self.bot.model = click.prompt(
             "Model name", type=click.STRING, default=self.bot.model
         )
-        self.code_theme = Prompt.ask(
-            "Enter code_theme", choices=rich_code_themes, default=self.code_theme
-        )
-        self.prettify = click.confirm(
-            "\nPrettify markdown response", default=self.prettify
-        )
-        busy_bar.spin_index = click.prompt(
-            "Spin bar index [0:/, 1:■█■■■, 2:⣻]",
-            default=busy_bar.spin_index,
-            type=click.IntRange(0, 2),
-        )
-        self.color = click.prompt("Response stdout font color", default=self.color)
 
     @busy_bar.run(help="System error")
     def do_copy_this(self, line):