ngpt 2.4.0__py3-none-any.whl → 2.5.1__py3-none-any.whl

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/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.dist-info → ngpt-2.5.1.dist-info}/METADATA

@@ -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.5.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
+ngpt/cli.py,sha256=IiBVelrzhrRDu75B5wbf5GlCbBqgQXMh7tJ3Nk_WDsQ,60095
+ngpt/client.py,sha256=QyPw93oJrMnStOzRqK6AldVqHATH1QgdbJ3vfkFjUsQ,14152
+ngpt/config.py,sha256=WYOk_b1eiYjo6hpV3pfXr2RjqhOnmKqwZwKid1T41I4,10363
+ngpt-2.5.1.dist-info/METADATA,sha256=wdJY5g_7LG2hvj5U3I_uY9Zho02lrqfolgj0G2Gjr0A,14657
+ngpt-2.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-2.5.1.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
+ngpt-2.5.1.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-2.5.1.dist-info/RECORD,,

ngpt-2.4.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
-ngpt/cli.py,sha256=iIlsdKGnSUbdnzKRL6Vmk067KXDEtIZmLqRm8ZKH7XE,49101
-ngpt/client.py,sha256=lJfyLONeBU7YqMVJJys6zPay7gcJTq108_rJ4wvOtok,13067
-ngpt/config.py,sha256=WYOk_b1eiYjo6hpV3pfXr2RjqhOnmKqwZwKid1T41I4,10363
-ngpt-2.4.0.dist-info/METADATA,sha256=Zcfa9uWB3PwwGgFz4fIhmu9XfLu_ZzQxIq7HF8CH-ew,13910
-ngpt-2.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-2.4.0.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
-ngpt-2.4.0.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-2.4.0.dist-info/RECORD,,