ngpt 2.4.0__tar.gz → 2.5.1__tar.gz

{ngpt-2.4.0 → ngpt-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.4.0
+Version: 2.5.1
 Summary: A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints.
 Project-URL: Homepage, https://github.com/nazdridoy/ngpt
 Project-URL: Repository, https://github.com/nazdridoy/ngpt
@@ -30,6 +30,8 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Requires-Dist: prompt-toolkit>=3.0.0
 Requires-Dist: requests>=2.31.0
+Provides-Extra: prettify
+Requires-Dist: rich>=10.0.0; extra == 'prettify'
 Description-Content-Type: text/markdown
 
 # nGPT
@@ -76,9 +78,18 @@ ngpt -n "Tell me about quantum computing"
 # Generate code
 ngpt --code "function to calculate the Fibonacci sequence"
 
+# Generate code with syntax highlighting
+ngpt --code --prettify "function to calculate the Fibonacci sequence"
+
 # Generate and execute shell commands
 ngpt --shell "list all files in the current directory"
 
+# Display markdown responses with beautiful formatting
+ngpt --prettify "Explain markdown syntax with examples"
+
+# Use a specific markdown renderer
+ngpt --prettify --renderer=rich "Create a markdown table"
+
 # Use multiline editor for complex prompts
 ngpt --text
 
@@ -99,6 +110,7 @@ For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdri
 - 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
 - 📊 **Streaming Responses**: Real-time output for better user experience
 - 🔍 **Web Search**: Integrated with compatible API endpoints
+- 🎨 **Markdown Rendering**: Beautiful formatting of markdown and code with syntax highlighting
 - ⚙️ **Multiple Configurations**: Cross-platform config system supporting different profiles
 - 💻 **Shell Command Generation**: OS-aware command execution
 - 🧩 **Clean Code Generation**: Output code without markdown or explanations
@@ -267,6 +279,9 @@ You can configure the client using the following options:
 | `--max_tokens` | Set maximum response length in tokens |
 | `--preprompt` | Set custom system prompt to control AI behavior |
 | `--log` | Set filepath to log conversation to (for interactive modes) |
+| `--prettify` | Render markdown responses and code with syntax highlighting |
+| `--renderer` | Select which markdown renderer to use with --prettify (auto, rich, or glow) |
+| `--list-renderers` | Show available markdown renderers for use with --prettify |
 | `--config` | Path to a custom configuration file or, when used without a value, enters interactive configuration mode |
 | `--config-index` | Index of the configuration to use (default: 0) |
 | `--provider` | Provider name to identify the configuration to use (alternative to --config-index) |

{ngpt-2.4.0 → ngpt-2.5.1}/README.md

@@ -42,9 +42,18 @@ ngpt -n "Tell me about quantum computing"
 # Generate code
 ngpt --code "function to calculate the Fibonacci sequence"
 
+# Generate code with syntax highlighting
+ngpt --code --prettify "function to calculate the Fibonacci sequence"
+
 # Generate and execute shell commands
 ngpt --shell "list all files in the current directory"
 
+# Display markdown responses with beautiful formatting
+ngpt --prettify "Explain markdown syntax with examples"
+
+# Use a specific markdown renderer
+ngpt --prettify --renderer=rich "Create a markdown table"
+
 # Use multiline editor for complex prompts
 ngpt --text
 
@@ -65,6 +74,7 @@ For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdri
 - 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
 - 📊 **Streaming Responses**: Real-time output for better user experience
 - 🔍 **Web Search**: Integrated with compatible API endpoints
+- 🎨 **Markdown Rendering**: Beautiful formatting of markdown and code with syntax highlighting
 - ⚙️ **Multiple Configurations**: Cross-platform config system supporting different profiles
 - 💻 **Shell Command Generation**: OS-aware command execution
 - 🧩 **Clean Code Generation**: Output code without markdown or explanations
@@ -233,6 +243,9 @@ You can configure the client using the following options:
 | `--max_tokens` | Set maximum response length in tokens |
 | `--preprompt` | Set custom system prompt to control AI behavior |
 | `--log` | Set filepath to log conversation to (for interactive modes) |
+| `--prettify` | Render markdown responses and code with syntax highlighting |
+| `--renderer` | Select which markdown renderer to use with --prettify (auto, rich, or glow) |
+| `--list-renderers` | Show available markdown renderers for use with --prettify |
 | `--config` | Path to a custom configuration file or, when used without a value, enters interactive configuration mode |
 | `--config-index` | Index of the configuration to use (default: 0) |
 | `--provider` | Provider name to identify the configuration to use (alternative to --config-index) |

{ngpt-2.4.0 → ngpt-2.5.1}/docs/api/client.md

@@ -49,7 +49,7 @@ client = NGPTClient(
 
 ## Chat Method
 
-The primary method for interacting with the AI model.
+The main method for interacting with the AI model.
 
 ```python
 response = client.chat(
@@ -57,8 +57,10 @@ response = client.chat(
     stream: bool = True,
     temperature: float = 0.7,
     max_tokens: Optional[int] = None,
+    top_p: float = 1.0,
     messages: Optional[List[Dict[str, str]]] = None,
     web_search: bool = False,
+    markdown_format: bool = False,
     **kwargs
 ) -> str
 ```
@@ -69,49 +71,55 @@ response = client.chat(
 |-----------|------|---------|-------------|
 | `prompt` | `str` | Required | The user's message |
 | `stream` | `bool` | `True` | Whether to stream the response |
-| `temperature` | `float` | `0.7` | Controls randomness in the response (0.0-1.0) |
+| `temperature` | `float` | `0.7` | Controls randomness in the response |
 | `max_tokens` | `Optional[int]` | `None` | Maximum number of tokens to generate |
-| `messages` | `Optional[List[Dict[str, str]]]` | `None` | Optional list of message objects for conversation history |
+| `top_p` | `float` | `1.0` | Controls diversity via nucleus sampling |
+| `messages` | `Optional[List[Dict[str, str]]]` | `None` | Optional list of message objects to override default behavior |
 | `web_search` | `bool` | `False` | Whether to enable web search capability |
-| `**kwargs` | | | Additional arguments to pass to the API |
+| `markdown_format` | `bool` | `False` | If True, allows markdown formatting in responses |
+| `**kwargs` | `Any` | `{}` | Additional arguments to pass to the API |
 
 ### Returns
 
-- When `stream=False`: A string containing the complete response
-- When `stream=True`: A generator yielding response chunks that can be iterated over
+If `stream=True`, returns chunks of the response as they are generated.
+If `stream=False`, returns the complete response as a string.
 
 ### Examples
 
 ```python
-# Basic chat with streaming
-for chunk in client.chat("Tell me about quantum computing"):
-    print(chunk, end="", flush=True)
-print()  # Final newline
+# Basic usage
+response = client.chat("Tell me about quantum computing")
+print(response)
 
 # Without streaming
 response = client.chat("Tell me about quantum computing", stream=False)
 print(response)
 
+# With custom temperature (higher = more creative, lower = more deterministic)
+response = client.chat("Write a poem about nature", temperature=0.9)
+print(response)
+
+# With token limit
+response = client.chat("Explain the history of AI", max_tokens=100)
+print(response)
+
 # With conversation history
 messages = [
     {"role": "system", "content": "You are a helpful assistant."},
     {"role": "user", "content": "Hello, who are you?"},
-    {"role": "assistant", "content": "I'm an AI assistant. How can I help you today?"},
-    {"role": "user", "content": "Tell me about yourself"}
+    {"role": "assistant", "content": "I'm an AI assistant created to help answer questions and provide information."},
+    {"role": "user", "content": "Tell me more about yourself"}
 ]
 response = client.chat("", messages=messages)
 print(response)
 
-# With web search
-response = client.chat("What's the latest news about AI?", web_search=True)
+# Enable web search capability (if API supports it)
+response = client.chat("What are the latest developments in quantum computing?", web_search=True)
 print(response)
 
-# With temperature control
-response = client.chat("Write a creative story", temperature=0.9)  # More random
-response = client.chat("Explain how a CPU works", temperature=0.2)  # More focused
-
-# With token limit
-response = client.chat("Summarize this concept", max_tokens=100)
+# Enable markdown formatting for rich text responses
+response = client.chat("Create a table comparing programming languages", markdown_format=True)
+print(response)  # Response will contain markdown formatting like tables, code blocks, etc.
 ```
 
 ## Generate Shell Command
@@ -157,13 +165,17 @@ command = client.generate_shell_command(
 
 ## Generate Code
 
-Generates clean code based on the prompt, without markdown formatting or explanations.
+Generates code based on the prompt.
 
 ```python
 code = client.generate_code(
     prompt: str,
     language: str = "python",
-    web_search: bool = False
+    web_search: bool = False,
+    temperature: float = 0.4,
+    top_p: float = 0.95,
+    max_tokens: Optional[int] = None,
+    markdown_format: bool = False
 ) -> str
 ```
 
@@ -174,15 +186,19 @@ code = client.generate_code(
 | `prompt` | `str` | Required | Description of the code to generate |
 | `language` | `str` | `"python"` | Programming language to generate code in |
 | `web_search` | `bool` | `False` | Whether to enable web search capability |
+| `temperature` | `float` | `0.4` | Controls randomness in the response |
+| `top_p` | `float` | `0.95` | Controls diversity via nucleus sampling |
+| `max_tokens` | `Optional[int]` | `None` | Maximum number of tokens to generate |
+| `markdown_format` | `bool` | `False` | If True, returns code with markdown formatting including syntax highlighting |
 
 ### Returns
 
-A string containing the generated code without any markdown formatting or explanations.
+A string containing the generated code. If `markdown_format` is `False`, returns plain text code. If `markdown_format` is `True`, returns code formatted in markdown with appropriate syntax highlighting.
 
 ### Examples
 
 ```python
-# Generate Python code (default)
+# Generate Python code (default, plain text)
 python_code = client.generate_code("function to calculate fibonacci numbers")
 print(python_code)
 
@@ -193,6 +209,15 @@ js_code = client.generate_code(
 )
 print(js_code)
 
+# Generate code with markdown formatting for documentation or display
+markdown_code = client.generate_code(
+    "class that implements a binary search tree",
+    language="python",
+    markdown_format=True
+)
+# This will output code wrapped in markdown code blocks with syntax highlighting
+print(markdown_code)
+
 # Generate code with web search for latest best practices
 react_code = client.generate_code(
     "create a React component that fetches and displays data from an API",

{ngpt-2.4.0 → ngpt-2.5.1}/docs/installation.md

@@ -8,6 +8,10 @@ There are several ways to install nGPT depending on your needs and environment.
 - `requests` library (automatically installed as a dependency)
 - `prompt_toolkit` library (automatically installed as a dependency)
 
+## Optional Dependencies
+
+- `rich` library - For enhanced markdown rendering with syntax highlighting
+
 ## Installing from PyPI (Recommended)
 
 The simplest way to install nGPT is through the Python Package Index (PyPI):
@@ -18,6 +22,18 @@ pip install ngpt
 
 This will install the latest stable release of nGPT and all its dependencies.
 
+For markdown rendering capabilities, install with the prettify extra:
+
+```bash
+pip install ngpt[prettify]
+```
+
+Alternatively, you can install the optional dependency separately:
+
+```bash
+pip install rich
+```
+
 ## Installing in a Virtual Environment
 
 It's often good practice to install Python packages in a virtual environment to avoid conflicts:

{ngpt-2.4.0 → ngpt-2.5.1}/docs/overview.md

@@ -18,6 +18,8 @@ nGPT is a lightweight Python library and command-line interface (CLI) tool desig
 
 - **Web Search Integration**: Works with compatible API endpoints that support web search capabilities.
 
+- **Markdown Rendering**: Beautiful formatting of markdown responses and syntax highlighting for code.
+
 - **Multiple Configuration Support**: Maintain different API configurations for various services or models.
 
 - **Shell Command Generation**: Generate OS-aware commands that work on your specific platform.

{ngpt-2.4.0 → ngpt-2.5.1}/docs/usage/cli_usage.md

@@ -48,6 +48,9 @@ Here are the most commonly used options:
 | `--temperature` | Set temperature (controls randomness, default: 0.7) |
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--max_tokens` | Set maximum response length in tokens |
+| `--prettify` | Render markdown responses and code with syntax highlighting |
+| `--renderer` | Select which markdown renderer to use (auto, rich, or glow) |
+| `--list-renderers` | Show available markdown renderers on your system |
 | `--config-index` | Index of the configuration to use (default: 0) |
 | `--provider` | Provider name to identify the configuration to use (alternative to --config-index) |
 
@@ -140,6 +143,46 @@ This opens an editor where you can:
 - Press Ctrl+D or F10 to submit the text
 - Press Esc to cancel
 
+### Markdown Rendering
+
+Display markdown responses with beautiful formatting and syntax highlighting:
+
+```bash
+ngpt --prettify "Explain markdown syntax with examples"
+```
+
+This instructs the AI to generate properly formatted markdown responses, which are then rendered with appropriate formatting, including:
+- Syntax highlighting for code blocks
+- Proper rendering of tables
+- Formatted headers, lists, and other markdown elements
+
+You can specify which markdown renderer to use:
+
+```bash
+# Use Rich (Python library) renderer
+ngpt --prettify --renderer=rich "Create a markdown table comparing programming languages"
+
+# Use Glow (terminal-based) renderer
+ngpt --prettify --renderer=glow "Write documentation with code examples"
+
+# Use automatic selection (default is Rich if available)
+ngpt --prettify --renderer=auto "Explain blockchain with code examples"
+```
+
+Combine with code generation for syntax-highlighted code:
+
+```bash
+ngpt -c --prettify "function to calculate the Fibonacci sequence"
+```
+
+When using `--prettify` with code generation, the AI will output code in markdown format with proper syntax highlighting based on the language.
+
+See available renderers on your system:
+
+```bash
+ngpt --list-renderers
+```
+
 ### Using Web Search
 
 Enable web search capability (if your API endpoint supports it):
@@ -248,8 +291,14 @@ ngpt --model gpt-4o-mini -n "Explain quantum entanglement"
 # Interactive session with custom prompt and logging
 ngpt -i --preprompt "You are a data science tutor" --log datasci_tutoring.txt
 
-# Constrain output format with a custom system prompt
-ngpt --preprompt "Your responses should be concise and include code examples." "How to parse JSON in JavaScript?"
+# Generate code with syntax highlighting
+ngpt -c --prettify "create a sorting algorithm"
+
+# Render markdown with web search for up-to-date information
+ngpt --prettify --web-search "Create a markdown table of recent SpaceX launches"
+
+# Interactive session with markdown rendering
+ngpt -i --prettify --renderer=rich
 ```
 
 ### Using a Custom Configuration File

{ngpt-2.4.0 → ngpt-2.5.1}/ngpt/cli.py

@@ -5,6 +5,23 @@ from .client import NGPTClient
 from .config import load_config, get_config_path, load_configs, add_config_entry, remove_config_entry
 from . import __version__
 
+# Try to import markdown rendering libraries
+try:
+    import rich
+    from rich.markdown import Markdown
+    from rich.console import Console
+    HAS_RICH = True
+except ImportError:
+    HAS_RICH = False
+
+# Try to import the glow command if available
+def has_glow_installed():
+    """Check if glow is installed in the system."""
+    import shutil
+    return shutil.which("glow") is not None
+
+HAS_GLOW = has_glow_installed()
+
 # ANSI color codes for terminal output
 COLORS = {
     "reset": "\033[0m",
@@ -68,6 +85,162 @@ if not HAS_COLOR:
     for key in COLORS:
         COLORS[key] = ""
 
+def has_markdown_renderer(renderer='auto'):
+    """Check if the specified markdown renderer is available.
+    
+    Args:
+        renderer (str): Which renderer to check: 'auto', 'rich', or 'glow'
+    
+    Returns:
+        bool: True if the renderer is available, False otherwise
+    """
+    if renderer == 'auto':
+        return HAS_RICH or HAS_GLOW
+    elif renderer == 'rich':
+        return HAS_RICH
+    elif renderer == 'glow':
+        return HAS_GLOW
+    else:
+        return False
+
+def show_available_renderers():
+    """Show which markdown renderers are available and their status."""
+    print(f"\n{COLORS['cyan']}{COLORS['bold']}Available Markdown Renderers:{COLORS['reset']}")
+    
+    if HAS_GLOW:
+        print(f"  {COLORS['green']}✓ Glow{COLORS['reset']} - Terminal-based Markdown renderer")
+    else:
+        print(f"  {COLORS['yellow']}✗ Glow{COLORS['reset']} - Not installed (https://github.com/charmbracelet/glow)")
+        
+    if HAS_RICH:
+        print(f"  {COLORS['green']}✓ Rich{COLORS['reset']} - Python library for terminal formatting (Recommended)")
+    else:
+        print(f"  {COLORS['yellow']}✗ Rich{COLORS['reset']} - Not installed (pip install rich)")
+        
+    if not HAS_GLOW and not HAS_RICH:
+        print(f"\n{COLORS['yellow']}To enable prettified markdown output, install one of the above renderers.{COLORS['reset']}")
+    else:
+        renderers = []
+        if HAS_RICH:
+            renderers.append("rich")
+        if HAS_GLOW:
+            renderers.append("glow")
+        print(f"\n{COLORS['green']}Usage examples:{COLORS['reset']}")
+        print(f"  ngpt --prettify \"Your prompt here\"                {COLORS['gray']}# Beautify markdown responses{COLORS['reset']}")
+        print(f"  ngpt -c --prettify \"Write a sort function\"        {COLORS['gray']}# Syntax highlight generated code{COLORS['reset']}")
+        if renderers:
+            renderer = renderers[0]
+            print(f"  ngpt --prettify --renderer={renderer} \"Your prompt\"  {COLORS['gray']}# Specify renderer{COLORS['reset']}")
+    
+    print("")
+
+def warn_if_no_markdown_renderer(renderer='auto'):
+    """Warn the user if the specified markdown renderer is not available.
+    
+    Args:
+        renderer (str): Which renderer to check: 'auto', 'rich', or 'glow'
+    
+    Returns:
+        bool: True if the renderer is available, False otherwise
+    """
+    if has_markdown_renderer(renderer):
+        return True
+    
+    if renderer == 'auto':
+        print(f"{COLORS['yellow']}Warning: No markdown rendering library available.{COLORS['reset']}")
+        print(f"{COLORS['yellow']}Install 'rich' package with: pip install rich{COLORS['reset']}")
+        print(f"{COLORS['yellow']}Or install 'glow' from https://github.com/charmbracelet/glow{COLORS['reset']}")
+    elif renderer == 'rich':
+        print(f"{COLORS['yellow']}Warning: Rich is not available.{COLORS['reset']}")
+        print(f"{COLORS['yellow']}Install with: pip install rich{COLORS['reset']}")
+    elif renderer == 'glow':
+        print(f"{COLORS['yellow']}Warning: Glow is not available.{COLORS['reset']}")
+        print(f"{COLORS['yellow']}Install from https://github.com/charmbracelet/glow{COLORS['reset']}")
+    else:
+        print(f"{COLORS['yellow']}Error: Invalid renderer '{renderer}'. Use 'auto', 'rich', or 'glow'.{COLORS['reset']}")
+    
+    return False
+
+def prettify_markdown(text, renderer='auto'):
+    """Render markdown text with beautiful formatting using either Rich or Glow.
+    
+    The function handles both general markdown and code blocks with syntax highlighting.
+    For code generation mode, it automatically wraps the code in markdown code blocks.
+    
+    Args:
+        text (str): Markdown text to render
+        renderer (str): Which renderer to use: 'auto', 'rich', or 'glow'
+        
+    Returns:
+        bool: True if rendering was successful, False otherwise
+    """
+    # For 'auto', prefer rich if available, otherwise use glow
+    if renderer == 'auto':
+        if HAS_RICH:
+            return prettify_markdown(text, 'rich')
+        elif HAS_GLOW:
+            return prettify_markdown(text, 'glow')
+        else:
+            return False
+    
+    # Use glow for rendering
+    elif renderer == 'glow':
+        if not HAS_GLOW:
+            print(f"{COLORS['yellow']}Warning: Glow is not available. Install from https://github.com/charmbracelet/glow{COLORS['reset']}")
+            # Fall back to rich if available
+            if HAS_RICH:
+                print(f"{COLORS['yellow']}Falling back to Rich renderer.{COLORS['reset']}")
+                return prettify_markdown(text, 'rich')
+            return False
+            
+        # Use glow
+        import tempfile
+        import subprocess
+        
+        with tempfile.NamedTemporaryFile(mode='w', suffix='.md', delete=False) as temp:
+            temp_filename = temp.name
+            temp.write(text)
+            
+        try:
+            # Execute glow on the temporary file
+            subprocess.run(["glow", temp_filename], check=True)
+            os.unlink(temp_filename)
+            return True
+        except Exception as e:
+            print(f"{COLORS['yellow']}Error using glow: {str(e)}{COLORS['reset']}")
+            os.unlink(temp_filename)
+            
+            # Fall back to rich if available
+            if HAS_RICH:
+                print(f"{COLORS['yellow']}Falling back to Rich renderer.{COLORS['reset']}")
+                return prettify_markdown(text, 'rich')
+            return False
+    
+    # Use rich for rendering
+    elif renderer == 'rich':
+        if not HAS_RICH:
+            print(f"{COLORS['yellow']}Warning: Rich is not available. Install with: pip install rich{COLORS['reset']}")
+            # Fall back to glow if available
+            if HAS_GLOW:
+                print(f"{COLORS['yellow']}Falling back to Glow renderer.{COLORS['reset']}")
+                return prettify_markdown(text, 'glow')
+            return False
+            
+        # Use rich
+        try:
+            console = Console()
+            md = Markdown(text)
+            console.print(md)
+            return True
+        except Exception as e:
+            print(f"{COLORS['yellow']}Error using rich for markdown: {str(e)}{COLORS['reset']}")
+            return False
+    
+    # Invalid renderer specified
+    else:
+        print(f"{COLORS['yellow']}Error: Invalid renderer '{renderer}'. Use 'auto', 'rich', or 'glow'.{COLORS['reset']}")
+        return False
+
 # Custom help formatter with color support
 class ColoredHelpFormatter(argparse.HelpFormatter):
     """Help formatter that properly handles ANSI color codes without breaking alignment."""
@@ -332,7 +505,7 @@ def check_config(config):
     
     return True
 
-def interactive_chat_session(client, web_search=False, no_stream=False, temperature=0.7, top_p=1.0, max_tokens=None, log_file=None, preprompt=None):
+def interactive_chat_session(client, web_search=False, no_stream=False, temperature=0.7, top_p=1.0, max_tokens=None, log_file=None, preprompt=None, prettify=False, renderer='auto'):
     """Run an interactive chat session with conversation history."""
     # Get terminal width for better formatting
     try:
@@ -380,6 +553,14 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
     
     # Initialize conversation history
     system_prompt = preprompt if preprompt else "You are a helpful assistant."
+    
+    # Add markdown formatting instruction to system prompt if prettify is enabled
+    if prettify:
+        if system_prompt:
+            system_prompt += " You can use markdown formatting in your responses where appropriate."
+        else:
+            system_prompt = "You are a helpful assistant. You can use markdown formatting in your responses where appropriate."
+    
     conversation = []
     system_message = {"role": "system", "content": system_prompt}
     conversation.append(system_message)
@@ -492,15 +673,24 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
             else:
                 print(f"\n{ngpt_header()}: {COLORS['reset']}", flush=True)
             
+            # If prettify is enabled, we need to disable streaming to collect the full response
+            should_stream = not no_stream and not prettify
+            
+            # If prettify is enabled with streaming, inform the user
+            if prettify and not no_stream:
+                print(f"\n{COLORS['yellow']}Note: Streaming disabled to enable markdown rendering.{COLORS['reset']}")
+                print(f"\n{ngpt_header()}: {COLORS['reset']}", flush=True)
+            
             # Get AI response with conversation history
             response = client.chat(
                 prompt=user_input,
                 messages=conversation,
-                stream=not no_stream,
+                stream=should_stream,
                 web_search=web_search,
                 temperature=temperature,
                 top_p=top_p,
-                max_tokens=max_tokens
+                max_tokens=max_tokens,
+                markdown_format=prettify
             )
             
             # Add AI response to conversation history
@@ -508,9 +698,12 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
                 assistant_message = {"role": "assistant", "content": response}
                 conversation.append(assistant_message)
                 
-                # Print response if not streamed
-                if no_stream:
-                    print(response)
+                # Print response if not streamed (either due to no_stream or prettify)
+                if no_stream or prettify:
+                    if prettify:
+                        prettify_markdown(response, renderer)
+                    else:
+                        print(response)
                 
                 # Log assistant response if logging is enabled
                 if log_handle:
@@ -567,6 +760,7 @@ def main():
     config_group.add_argument('--show-config', action='store_true', help='Show the current configuration(s) and exit')
     config_group.add_argument('--all', action='store_true', help='Show details for all configurations (requires --show-config)')
     config_group.add_argument('--list-models', action='store_true', help='List all available models for the current configuration and exit')
+    config_group.add_argument('--list-renderers', action='store_true', help='Show available markdown renderers for use with --prettify')
     
     # Global options
     global_group = parser.add_argument_group('Global Options')
@@ -587,6 +781,10 @@ def main():
                       help='Set filepath to log conversation to (For interactive modes)')
     global_group.add_argument('--preprompt', 
                       help='Set custom system prompt to control AI behavior')
+    global_group.add_argument('--prettify', action='store_const', const='auto',
+                      help='Render markdown responses and code with syntax highlighting and formatting')
+    global_group.add_argument('--renderer', choices=['auto', 'rich', 'glow'], default='auto',
+                      help='Select which markdown renderer to use with --prettify (auto, rich, or glow)')
     
     # Mode flags (mutually exclusive)
     mode_group = parser.add_argument_group('Modes (mutually exclusive)')
@@ -609,6 +807,11 @@ def main():
     if args.all and not args.show_config:
         parser.error("--all can only be used with --show-config")
     
+    # Handle --renderers flag to show available markdown renderers
+    if args.list_renderers:
+        show_available_renderers()
+        return
+    
     # Check for mutual exclusivity between --config-index and --provider
     if args.config_index != 0 and args.provider:
         parser.error("--config-index and --provider cannot be used together")
@@ -808,6 +1011,17 @@ def main():
     if not args.show_config and not args.list_models and not check_config(active_config):
         return
     
+    # Check if --prettify is used but no markdown renderer is available
+    # This will warn the user immediately if they request prettify but don't have the tools
+    has_renderer = True
+    if args.prettify:
+        has_renderer = warn_if_no_markdown_renderer(args.renderer)
+        if not has_renderer:
+            # Set a flag to disable prettify since we already warned the user
+            print(f"{COLORS['yellow']}Continuing without markdown rendering.{COLORS['reset']}")
+            show_available_renderers()
+            args.prettify = False
+        
     # Initialize client using the potentially overridden active_config
     client = NGPTClient(**active_config)
     
@@ -834,7 +1048,7 @@ def main():
             # Interactive chat mode
             interactive_chat_session(client, web_search=args.web_search, no_stream=args.no_stream,
                                    temperature=args.temperature, top_p=args.top_p, 
-                                   max_tokens=args.max_tokens, log_file=args.log, preprompt=args.preprompt)
+                                   max_tokens=args.max_tokens, log_file=args.log, preprompt=args.preprompt, prettify=args.prettify, renderer=args.renderer)
         elif args.shell:
             if args.prompt is None:
                 try:
@@ -886,9 +1100,14 @@ def main():
                 
             generated_code = client.generate_code(prompt, args.language, web_search=args.web_search,
                                               temperature=args.temperature, top_p=args.top_p,
-                                              max_tokens=args.max_tokens)
+                                              max_tokens=args.max_tokens,
+                                              markdown_format=args.prettify)
             if generated_code:
-                print(f"\nGenerated code:\n{generated_code}")
+                if args.prettify:
+                    print("\nGenerated code:")
+                    prettify_markdown(generated_code, args.renderer)
+                else:
+                    print(f"\nGenerated code:\n{generated_code}")
             
         elif args.text:
             if args.prompt is not None:
@@ -1006,12 +1225,25 @@ def main():
                     {"role": "system", "content": args.preprompt},
                     {"role": "user", "content": prompt}
                 ]
+            
+            # If prettify is enabled, we need to disable streaming to collect the full response
+            should_stream = not args.no_stream and not args.prettify
+            
+            # If prettify is enabled with streaming, inform the user
+            if args.prettify and not args.no_stream:
+                print(f"{COLORS['yellow']}Note: Streaming disabled to enable markdown rendering.{COLORS['reset']}")
                 
-            response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
+            response = client.chat(prompt, stream=should_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_tokens, messages=messages)
-            if args.no_stream and response:
-                print(response)
+                               max_tokens=args.max_tokens, messages=messages,
+                               markdown_format=args.prettify)
+            
+            # Handle non-stream response (either because no_stream was set or prettify forced it)
+            if (args.no_stream or args.prettify) and response:
+                if args.prettify:
+                    prettify_markdown(response, args.renderer)
+                else:
+                    print(response)
             
         else:
             # Default to chat mode
@@ -1032,12 +1264,25 @@ def main():
                     {"role": "system", "content": args.preprompt},
                     {"role": "user", "content": prompt}
                 ]
+            
+            # If prettify is enabled, we need to disable streaming to collect the full response
+            should_stream = not args.no_stream and not args.prettify
+            
+            # If prettify is enabled with streaming, inform the user
+            if args.prettify and not args.no_stream:
+                print(f"{COLORS['yellow']}Note: Streaming disabled to enable markdown rendering.{COLORS['reset']}")
                 
-            response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
+            response = client.chat(prompt, stream=should_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_tokens, messages=messages)
-            if args.no_stream and response:
-                print(response)
+                               max_tokens=args.max_tokens, messages=messages,
+                               markdown_format=args.prettify)
+            
+            # Handle non-stream response (either because no_stream was set or prettify forced it)
+            if (args.no_stream or args.prettify) and response:
+                if args.prettify:
+                    prettify_markdown(response, args.renderer)
+                else:
+                    print(response)
     
     except KeyboardInterrupt:
         print("\nOperation cancelled by user. Exiting gracefully.")

{ngpt-2.4.0 → ngpt-2.5.1}/ngpt/client.py

@@ -33,6 +33,7 @@ class NGPTClient:
         top_p: float = 1.0,
         messages: Optional[List[Dict[str, str]]] = None,
         web_search: bool = False,
+        markdown_format: bool = False,
         **kwargs
     ) -> str:
         """
@@ -46,6 +47,7 @@ class NGPTClient:
             top_p: Controls diversity via nucleus sampling
             messages: Optional list of message objects to override default behavior
             web_search: Whether to enable web search capability
+            markdown_format: If True, allow markdown-formatted responses, otherwise plain text
             **kwargs: Additional arguments to pass to the API
             
         Returns:
@@ -56,7 +58,11 @@ class NGPTClient:
             return ""
             
         if messages is None:
-            messages = [{"role": "user", "content": prompt}]
+            if markdown_format:
+                system_message = {"role": "system", "content": "You can use markdown formatting in your responses where appropriate."}
+                messages = [system_message, {"role": "user", "content": prompt}]
+            else:
+                messages = [{"role": "user", "content": prompt}]
         
         # Prepare API parameters
         payload = {
@@ -241,7 +247,8 @@ Command:"""
         web_search: bool = False,
         temperature: float = 0.4,
         top_p: float = 0.95,
-        max_tokens: Optional[int] = None
+        max_tokens: Optional[int] = None,
+        markdown_format: bool = False
     ) -> str:
         """
         Generate code based on the prompt.
@@ -253,6 +260,7 @@ Command:"""
             temperature: Controls randomness in the response
             top_p: Controls diversity via nucleus sampling
             max_tokens: Maximum number of tokens to generate
+            markdown_format: If True, request markdown-formatted code, otherwise plain text
             
         Returns:
             The generated code
@@ -262,7 +270,18 @@ Command:"""
             print("Error: API key is not set. Please configure your API key in the config file or provide it with --api-key.")
             return ""
             
-        system_prompt = f"""Your Role: Provide only code as output without any description.
+        if markdown_format:
+            system_prompt = f"""Your Role: Provide only code as output without any description with proper markdown formatting.
+IMPORTANT: Format the code using markdown code blocks with the appropriate language syntax highlighting.
+IMPORTANT: You must use markdown code blocks. with ```{language}
+If there is a lack of details, provide most logical solution. You are not allowed to ask for more details.
+Ignore any potential risk of errors or confusion.
+
+Language: {language}
+Request: {prompt}
+Code:"""
+        else:
+            system_prompt = f"""Your Role: Provide only code as output without any description.
 IMPORTANT: Provide only plain text without Markdown formatting.
 IMPORTANT: Do not include markdown formatting.
 If there is a lack of details, provide most logical solution. You are not allowed to ask for more details.

{ngpt-2.4.0 → ngpt-2.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ngpt"
-version = "2.4.0"
+version = "2.5.1"
 description = "A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints."
 authors = [
     {name = "nazDridoy", email = "nazdridoy399@gmail.com"},
@@ -34,6 +34,11 @@ classifiers = [
     "Intended Audience :: System Administrators",
 ]
 
+[project.optional-dependencies]
+prettify = [
+    "rich>=10.0.0",
+]
+
 [project.urls]
 "Homepage" = "https://github.com/nazdridoy/ngpt"
 "Repository" = "https://github.com/nazdridoy/ngpt"

{ngpt-2.4.0 → ngpt-2.5.1}/uv.lock

@@ -111,20 +111,48 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442 },
 ]
 
+[[package]]
+name = "markdown-it-py"
+version = "3.0.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "mdurl" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/38/71/3b932df36c1a044d397a1f92d1cf91ee0a503d91e470cbd670aa66b07ed0/markdown-it-py-3.0.0.tar.gz", hash = "sha256:e3f60a94fa066dc52ec76661e37c851cb232d92f9886b15cb560aaada2df8feb", size = 74596 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/42/d7/1ec15b46af6af88f19b8e5ffea08fa375d433c998b8a7639e76935c14f1f/markdown_it_py-3.0.0-py3-none-any.whl", hash = "sha256:355216845c60bd96232cd8d8c40e8f9765cc86f46880e43a8fd22dc1a1a8cab1", size = 87528 },
+]
+
+[[package]]
+name = "mdurl"
+version = "0.1.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/d6/54/cfe61301667036ec958cb99bd3efefba235e65cdeb9c84d24a8293ba1d90/mdurl-0.1.2.tar.gz", hash = "sha256:bb413d29f5eea38f31dd4754dd7377d4465116fb207585f97bf925588687c1ba", size = 8729 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/b3/38/89ba8ad64ae25be8de66a6d463314cf1eb366222074cfda9ee839c56a4b4/mdurl-0.1.2-py3-none-any.whl", hash = "sha256:84008a41e51615a49fc9966191ff91509e3c40b939176e643fd50a5c2196b8f8", size = 9979 },
+]
+
 [[package]]
 name = "ngpt"
-version = "2.4.0"
+version = "2.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "prompt-toolkit" },
     { name = "requests" },
 ]
 
+[package.optional-dependencies]
+prettify = [
+    { name = "rich" },
+]
+
 [package.metadata]
 requires-dist = [
     { name = "prompt-toolkit", specifier = ">=3.0.0" },
     { name = "requests", specifier = ">=2.31.0" },
+    { name = "rich", marker = "extra == 'prettify'", specifier = ">=10.0.0" },
 ]
+provides-extras = ["prettify"]
 
 [[package]]
 name = "prompt-toolkit"
@@ -138,6 +166,15 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/ce/4f/5249960887b1fbe561d9ff265496d170b55a735b76724f10ef19f9e40716/prompt_toolkit-3.0.51-py3-none-any.whl", hash = "sha256:52742911fde84e2d423e2f9a4cf1de7d7ac4e51958f648d9540e0fb8db077b07", size = 387810 },
 ]
 
+[[package]]
+name = "pygments"
+version = "2.19.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/7c/2d/c3338d48ea6cc0feb8446d8e6937e1408088a72a39937982cc6111d17f84/pygments-2.19.1.tar.gz", hash = "sha256:61c16d2a8576dc0649d9f39e089b5f02bcd27fba10d8fb4dcc28173f7a45151f", size = 4968581 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/8a/0b/9fcc47d19c48b59121088dd6da2488a49d5f72dacf8262e2790a1d2c7d15/pygments-2.19.1-py3-none-any.whl", hash = "sha256:9ea1544ad55cecf4b8242fab6dd35a93bbce657034b0611ee383099054ab6d8c", size = 1225293 },
+]
+
 [[package]]
 name = "requests"
 version = "2.32.3"
@@ -154,6 +191,29 @@ wheels = [
     { url = "https://files.pythonhosted.org/packages/f9/9b/335f9764261e915ed497fcdeb11df5dfd6f7bf257d4a6a2a686d80da4d54/requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6", size = 64928 },
 ]
 
+[[package]]
+name = "rich"
+version = "14.0.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+    { name = "markdown-it-py" },
+    { name = "pygments" },
+    { name = "typing-extensions", marker = "python_full_version < '3.11'" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/a1/53/830aa4c3066a8ab0ae9a9955976fb770fe9c6102117c8ec4ab3ea62d89e8/rich-14.0.0.tar.gz", hash = "sha256:82f1bc23a6a21ebca4ae0c45af9bdbc492ed20231dcb63f297d6d1021a9d5725", size = 224078 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/0d/9b/63f4c7ebc259242c89b3acafdb37b41d1185c07ff0011164674e9076b491/rich-14.0.0-py3-none-any.whl", hash = "sha256:1c9491e1951aac09caffd42f448ee3d04e58923ffe14993f6e83068dc395d7e0", size = 243229 },
+]
+
+[[package]]
+name = "typing-extensions"
+version = "4.13.2"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/f6/37/23083fcd6e35492953e8d2aaaa68b860eb422b34627b13f2ce3eb6106061/typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef", size = 106967 }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/8b/54/b1ae86c0973cc6f0210b53d508ca3641fb6d0c56823f288d108bc7ab3cc8/typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c", size = 45806 },
+]
+
 [[package]]
 name = "urllib3"
 version = "2.2.3"