ngpt 3.8.1__tar.gz → 3.8.3__tar.gz

{ngpt-3.8.1 → ngpt-3.8.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 3.8.1
+Version: 3.8.3
 Summary: Swiss army knife for LLMs: powerful CLI and interactive chatbot in one package. Seamlessly work with OpenAI, Ollama, Groq, Claude, Gemini, or any OpenAI-compatible API to generate code, craft git commits, rewrite text, and execute shell commands.
 Project-URL: Homepage, https://github.com/nazdridoy/ngpt
 Project-URL: Repository, https://github.com/nazdridoy/ngpt
@@ -493,6 +493,8 @@ In interactive mode:
 - For security, your API key is not displayed when editing configurations
 - When removing a configuration, you'll be asked to confirm before deletion
 
+![ngpt-sh-c-a](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-sh-c-a.png)
+
 For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/).
 
 ### Configuration File
@@ -541,6 +543,146 @@ nGPT determines configuration values in the following order (highest priority fi
 4. Main configuration file `ngpt.conf` or `custom-config-file`
 5. Default values
 
+### Real-World Demonstrations with nGPT
+
+Let's see nGPT in action! Here are some practical ways you can use it every day:
+
+#### Quick Q&A and Coding
+
+```bash
+# Get a quick explanation
+ngpt "Explain the difference between threads and processes in Python"
+
+# Generate code with real-time syntax highlighting
+ngpt --code --stream-prettify "Write a Python function to reverse a linked list"
+```
+
+With the `--code` flag, nGPT gives you clean code without explanations or markdown, just what you need to copy and paste into your project. The `--stream-prettify` option shows real-time syntax highlighting as the code comes in.
+
+#### Shell Command Generation (OS-Aware)
+
+```bash
+# Let nGPT generate the correct command for your OS
+ngpt --shell "list all files in the current directory including hidden ones"
+# On Linux/macOS: ls -la
+# On Windows: dir /a
+```
+
+One of my favorite features! No more Googling obscure command flags, nGPT generates the right command for your operating system. It'll even execute it for you if you approve.
+
+![ngpt-s-c](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-s-c.png)
+
+#### Text Rewriting and Summarization
+
+```bash
+# Pipe text to rewrite it (e.g., improve clarity)
+echo "This is a rough draft of my email." | ngpt -r
+
+# Summarize a file using the pipe placeholder
+cat long-article.txt | ngpt --pipe "Summarize this document concisely: {}"
+```
+
+The text rewriting feature is perfect for quickly improving documentation, emails, or reports. And with pipe placeholders, you can feed in content from files or other commands.
+
+#### Git Commit Message Generation
+
+```bash
+# Stage your changes
+git add .
+
+# Let nGPT generate a conventional commit message based on the diff
+ngpt -g
+
+# Generate git commit message from a diff file
+ngpt -g --diff changes.diff
+```
+
+This is a huge time-saver. nGPT analyzes your git diff and generates a properly formatted conventional commit message that actually describes what you changed. No more staring at the blank commit message prompt!
+
+![ngpt-g](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-g.png)
+
+#### Web Search Integration
+
+```bash
+# Ask questions that require up-to-date information
+ngpt --web-search "What's the latest news about AI regulation?"
+```
+
+The `--web-search` flag lets nGPT consult the web for recent information, making it useful for questions about current events or topics that might have changed since the AI's training data cutoff.
+
+![ngpt-w](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-w.png)
+
+### Real-World Integration Examples
+
+Let's look at how nGPT can fit into your everyday workflow with some practical examples:
+
+#### Developer Workflow
+
+As a developer, I use nGPT throughout my day:
+
+**Morning code review**:
+   ```bash
+   # Get explanations of complex code
+   git show | ngpt --pipe "Explain what this code change does and any potential issues: {}"
+   ```
+
+**Debugging help**:
+   ```bash
+   # Help understand a cryptic error message
+   npm run build 2>&1 | grep Error | ngpt --pipe "What does this error mean and how can I fix it: {}"
+   ```
+
+**Documentation generation**:
+   ```bash
+   # Generate JSDoc comments for functions
+   cat src/utils.js | ngpt --pipe "Write proper JSDoc comments for these functions: {}"
+   ```
+
+**Commit messages**:
+   ```bash
+   # After finishing a feature
+   git add .
+   ngpt -g
+   ```
+
+#### Writer's Assistant
+
+For content creators and writers:
+
+**Overcoming writer's block**:
+   ```bash
+   ngpt "Give me 5 different angles to approach an article about sustainable technology"
+   ```
+
+**Editing assistance**:
+   ```bash
+   cat draft.md | ngpt -r
+   ```
+
+**Research summaries**:
+   ```bash
+   curl -s https://example.com/research-paper.html | ngpt --pipe "Summarize the key findings from this research: {}"
+   ```
+
+#### System Administrator
+
+For sysadmins and DevOps folks:
+
+**Generating complex commands**:
+   ```bash
+   ngpt -s "find all log files larger than 100MB that haven't been modified in the last 30 days"
+   ```
+
+*Creating configuration files**:
+   ```bash
+   ngpt --code "Create a Docker Compose file for a Redis, PostgreSQL, and Node.js application"
+   ```
+
+**Troubleshooting systems**:
+   ```bash
+   dmesg | tail -50 | ngpt --pipe "Explain what might be causing the issues based on these system logs: {}"
+   ```
+
 ## Contributing
 
 We welcome contributions to nGPT! Whether it's bug fixes, feature additions, or documentation improvements, your help is appreciated.

{ngpt-3.8.1 → ngpt-3.8.3}/README.md

@@ -456,6 +456,8 @@ In interactive mode:
 - For security, your API key is not displayed when editing configurations
 - When removing a configuration, you'll be asked to confirm before deletion
 
+![ngpt-sh-c-a](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-sh-c-a.png)
+
 For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/).
 
 ### Configuration File
@@ -504,6 +506,146 @@ nGPT determines configuration values in the following order (highest priority fi
 4. Main configuration file `ngpt.conf` or `custom-config-file`
 5. Default values
 
+### Real-World Demonstrations with nGPT
+
+Let's see nGPT in action! Here are some practical ways you can use it every day:
+
+#### Quick Q&A and Coding
+
+```bash
+# Get a quick explanation
+ngpt "Explain the difference between threads and processes in Python"
+
+# Generate code with real-time syntax highlighting
+ngpt --code --stream-prettify "Write a Python function to reverse a linked list"
+```
+
+With the `--code` flag, nGPT gives you clean code without explanations or markdown, just what you need to copy and paste into your project. The `--stream-prettify` option shows real-time syntax highlighting as the code comes in.
+
+#### Shell Command Generation (OS-Aware)
+
+```bash
+# Let nGPT generate the correct command for your OS
+ngpt --shell "list all files in the current directory including hidden ones"
+# On Linux/macOS: ls -la
+# On Windows: dir /a
+```
+
+One of my favorite features! No more Googling obscure command flags, nGPT generates the right command for your operating system. It'll even execute it for you if you approve.
+
+![ngpt-s-c](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-s-c.png)
+
+#### Text Rewriting and Summarization
+
+```bash
+# Pipe text to rewrite it (e.g., improve clarity)
+echo "This is a rough draft of my email." | ngpt -r
+
+# Summarize a file using the pipe placeholder
+cat long-article.txt | ngpt --pipe "Summarize this document concisely: {}"
+```
+
+The text rewriting feature is perfect for quickly improving documentation, emails, or reports. And with pipe placeholders, you can feed in content from files or other commands.
+
+#### Git Commit Message Generation
+
+```bash
+# Stage your changes
+git add .
+
+# Let nGPT generate a conventional commit message based on the diff
+ngpt -g
+
+# Generate git commit message from a diff file
+ngpt -g --diff changes.diff
+```
+
+This is a huge time-saver. nGPT analyzes your git diff and generates a properly formatted conventional commit message that actually describes what you changed. No more staring at the blank commit message prompt!
+
+![ngpt-g](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-g.png)
+
+#### Web Search Integration
+
+```bash
+# Ask questions that require up-to-date information
+ngpt --web-search "What's the latest news about AI regulation?"
+```
+
+The `--web-search` flag lets nGPT consult the web for recent information, making it useful for questions about current events or topics that might have changed since the AI's training data cutoff.
+
+![ngpt-w](https://raw.githubusercontent.com/nazdridoy/ngpt/main/previews/ngpt-w.png)
+
+### Real-World Integration Examples
+
+Let's look at how nGPT can fit into your everyday workflow with some practical examples:
+
+#### Developer Workflow
+
+As a developer, I use nGPT throughout my day:
+
+**Morning code review**:
+   ```bash
+   # Get explanations of complex code
+   git show | ngpt --pipe "Explain what this code change does and any potential issues: {}"
+   ```
+
+**Debugging help**:
+   ```bash
+   # Help understand a cryptic error message
+   npm run build 2>&1 | grep Error | ngpt --pipe "What does this error mean and how can I fix it: {}"
+   ```
+
+**Documentation generation**:
+   ```bash
+   # Generate JSDoc comments for functions
+   cat src/utils.js | ngpt --pipe "Write proper JSDoc comments for these functions: {}"
+   ```
+
+**Commit messages**:
+   ```bash
+   # After finishing a feature
+   git add .
+   ngpt -g
+   ```
+
+#### Writer's Assistant
+
+For content creators and writers:
+
+**Overcoming writer's block**:
+   ```bash
+   ngpt "Give me 5 different angles to approach an article about sustainable technology"
+   ```
+
+**Editing assistance**:
+   ```bash
+   cat draft.md | ngpt -r
+   ```
+
+**Research summaries**:
+   ```bash
+   curl -s https://example.com/research-paper.html | ngpt --pipe "Summarize the key findings from this research: {}"
+   ```
+
+#### System Administrator
+
+For sysadmins and DevOps folks:
+
+**Generating complex commands**:
+   ```bash
+   ngpt -s "find all log files larger than 100MB that haven't been modified in the last 30 days"
+   ```
+
+*Creating configuration files**:
+   ```bash
+   ngpt --code "Create a Docker Compose file for a Redis, PostgreSQL, and Node.js application"
+   ```
+
+**Troubleshooting systems**:
+   ```bash
+   dmesg | tail -50 | ngpt --pipe "Explain what might be causing the issues based on these system logs: {}"
+   ```
+
 ## Contributing
 
 We welcome contributions to nGPT! Whether it's bug fixes, feature additions, or documentation improvements, your help is appreciated.

{ngpt-3.8.1 → ngpt-3.8.3}/ngpt/cli/modes/chat.py

@@ -1,5 +1,5 @@
 from ..formatters import COLORS
-from ..renderers import prettify_markdown, prettify_streaming_markdown
+from ..renderers import prettify_markdown, prettify_streaming_markdown, TERMINAL_RENDER_LOCK
 from ..ui import spinner
 from ...utils import enhance_prompt_with_web_search, process_piped_input
 import sys
@@ -53,9 +53,10 @@ def chat_mode(client, args, logger=None):
                 stop_spinner.set()
                 spinner_thread.join()
                 # Clear the spinner line completely
-                sys.stdout.write("\r" + " " * 100 + "\r")
-                sys.stdout.flush()
-                print("Enhanced input with web search results.")
+                with TERMINAL_RENDER_LOCK:
+                    sys.stdout.write("\r" + " " * 100 + "\r")
+                    sys.stdout.flush()
+                    print("Enhanced input with web search results.")
             except Exception as e:
                 # Stop the spinner before re-raising
                 stop_spinner.set()
@@ -129,11 +130,14 @@ def chat_mode(client, args, logger=None):
         # On first content, stop the spinner 
         if not first_content_received and stop_spinner_func:
             first_content_received = True
-            # Stop the spinner
-            stop_spinner_func()
-            # Ensure spinner message is cleared with an extra blank line
-            sys.stdout.write("\r" + " " * 100 + "\r")
-            sys.stdout.flush()
+            
+            # Use lock to prevent terminal rendering conflicts
+            with TERMINAL_RENDER_LOCK:
+                # Stop the spinner
+                stop_spinner_func()
+                # Ensure spinner message is cleared with an extra blank line
+                sys.stdout.write("\r" + " " * 100 + "\r")
+                sys.stdout.flush()
         
         # Call the original callback to update the display
         if original_callback:
@@ -165,7 +169,8 @@ def chat_mode(client, args, logger=None):
         
     # Handle non-stream response or regular prettify
     if (args.no_stream or args.prettify) and response:
-        if args.prettify:
-            prettify_markdown(response, args.renderer)
-        else:
-            print(response) 
+        with TERMINAL_RENDER_LOCK:
+            if args.prettify:
+                prettify_markdown(response, args.renderer)
+            else:
+                print(response) 

{ngpt-3.8.1 → ngpt-3.8.3}/ngpt/cli/modes/code.py

@@ -1,5 +1,5 @@
 from ..formatters import COLORS
-from ..renderers import prettify_markdown, prettify_streaming_markdown, has_markdown_renderer, show_available_renderers
+from ..renderers import prettify_markdown, prettify_streaming_markdown, has_markdown_renderer, show_available_renderers, TERMINAL_RENDER_LOCK
 from ..ui import spinner, copy_to_clipboard
 from ...utils import enhance_prompt_with_web_search, process_piped_input
 import sys
@@ -126,9 +126,10 @@ def code_mode(client, args, logger=None):
                 stop_spinner.set()
                 spinner_thread.join()
                 # Clear the spinner line completely
-                sys.stdout.write("\r" + " " * 100 + "\r")
-                sys.stdout.flush()
-                print("Enhanced input with web search results.")
+                with TERMINAL_RENDER_LOCK:
+                    sys.stdout.write("\r" + " " * 100 + "\r")
+                    sys.stdout.flush()
+                    print("Enhanced input with web search results.")
             except Exception as e:
                 # Stop the spinner before re-raising
                 stop_spinner.set()
@@ -211,11 +212,14 @@ def code_mode(client, args, logger=None):
         # On first content, stop the spinner 
         if not first_content_received and stop_spinner_func:
             first_content_received = True
-            # Stop the spinner
-            stop_spinner_func()
-            # Ensure spinner message is cleared with an extra blank line
-            sys.stdout.write("\r" + " " * 100 + "\r")
-            sys.stdout.flush()
+            
+            # Use lock to prevent terminal rendering conflicts
+            with TERMINAL_RENDER_LOCK:
+                # Stop the spinner
+                stop_spinner_func()
+                # Ensure spinner message is cleared with an extra blank line
+                sys.stdout.write("\r" + " " * 100 + "\r")
+                sys.stdout.flush()
         
         # Call the original callback to update the display
         if original_callback:
@@ -297,12 +301,13 @@ def code_mode(client, args, logger=None):
         
     # Print non-streamed output if needed
     if generated_code and not should_stream:
-        if use_regular_prettify:
-            print("\nGenerated code:")
-            prettify_markdown(generated_code, args.renderer)
-        else:
-            # Should only happen if --no-stream was used without prettify
-            print(f"\nGenerated code:\n{generated_code}") 
+        with TERMINAL_RENDER_LOCK:
+            if use_regular_prettify:
+                print("\nGenerated code:")
+                prettify_markdown(generated_code, args.renderer)
+            else:
+                # Should only happen if --no-stream was used without prettify
+                print(f"\nGenerated code:\n{generated_code}")
             
     # Offer to copy to clipboard
     if generated_code and not args.no_stream:

{ngpt-3.8.1 → ngpt-3.8.3}/ngpt/cli/modes/interactive.py

@@ -5,7 +5,7 @@ import threading
 import sys
 import time
 from ..formatters import COLORS
-from ..renderers import prettify_markdown, prettify_streaming_markdown
+from ..renderers import prettify_markdown, prettify_streaming_markdown, TERMINAL_RENDER_LOCK
 from ..ui import spinner
 from ...utils import enhance_prompt_with_web_search
 
@@ -78,8 +78,9 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
     def print_separator():
         # Make sure there's exactly one newline before and after
         # Use sys.stdout.write for direct control, avoiding any extra newlines
-        sys.stdout.write(f"\n{separator}\n")
-        sys.stdout.flush()
+        with TERMINAL_RENDER_LOCK:
+            sys.stdout.write(f"\n{separator}\n")
+            sys.stdout.flush()
     
     # Initialize conversation history
     system_prompt = preprompt if preprompt else "You are a helpful assistant."
@@ -111,35 +112,37 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
     
     # Function to display conversation history
     def display_history():
-        if len(conversation) <= 1:  # Only system message
-            print(f"\n{COLORS['yellow']}No conversation history yet.{COLORS['reset']}")
-            return
-            
-        print(f"\n{COLORS['cyan']}{COLORS['bold']}Conversation History:{COLORS['reset']}")
-        print(separator)
-        
-        # Skip system message
-        message_count = 0
-        for i, msg in enumerate(conversation):
-            if msg["role"] == "system":
-                continue
+        with TERMINAL_RENDER_LOCK:
+            if len(conversation) <= 1:  # Only system message
+                print(f"\n{COLORS['yellow']}No conversation history yet.{COLORS['reset']}")
+                return
                 
-            if msg["role"] == "user":
-                message_count += 1
-                print(f"\n{user_header()}")
-                print(f"{COLORS['cyan']}│ [{message_count}] {COLORS['reset']}{msg['content']}")
-            elif msg["role"] == "assistant":
-                print(f"\n{ngpt_header()}")
-                print(f"{COLORS['green']}│ {COLORS['reset']}{msg['content']}")
-        
-        print(f"\n{separator}")  # Consistent separator at the end
+            print(f"\n{COLORS['cyan']}{COLORS['bold']}Conversation History:{COLORS['reset']}")
+            print(separator)
+            
+            # Skip system message
+            message_count = 0
+            for i, msg in enumerate(conversation):
+                if msg["role"] == "system":
+                    continue
+                    
+                if msg["role"] == "user":
+                    message_count += 1
+                    print(f"\n{user_header()}")
+                    print(f"{COLORS['cyan']}│ [{message_count}] {COLORS['reset']}{msg['content']}")
+                elif msg["role"] == "assistant":
+                    print(f"\n{ngpt_header()}")
+                    print(f"{COLORS['green']}│ {COLORS['reset']}{msg['content']}")
+            
+            print(f"\n{separator}")  # Consistent separator at the end
     
     # Function to clear conversation history
     def clear_history():
         nonlocal conversation
         conversation = [{"role": "system", "content": system_prompt}]
-        print(f"\n{COLORS['yellow']}Conversation history cleared.{COLORS['reset']}")
-        print(separator)  # Add separator for consistency
+        with TERMINAL_RENDER_LOCK:
+            print(f"\n{COLORS['yellow']}Conversation history cleared.{COLORS['reset']}")
+            print(separator)  # Add separator for consistency
     
     try:
         while True:
@@ -249,10 +252,11 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
 
             # Print the header if needed
             if should_print_header:
-                if not no_stream and not stream_prettify:
-                    print(f"\n{ngpt_header()}: {COLORS['reset']}", end="", flush=True)
-                elif not stream_prettify:
-                    print(f"\n{ngpt_header()}: {COLORS['reset']}", flush=True)
+                with TERMINAL_RENDER_LOCK:
+                    if not no_stream and not stream_prettify:
+                        print(f"\n{ngpt_header()}: {COLORS['reset']}", end="", flush=True)
+                    elif not stream_prettify:
+                        print(f"\n{ngpt_header()}: {COLORS['reset']}", flush=True)
             
             # Determine streaming behavior
             if prettify and not no_stream and not stream_prettify:
@@ -294,18 +298,20 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
                         if not first_content_received:
                             first_content_received = True
                             
-                            # Stop the spinner if it's running
-                            if stop_spinner_func:
-                                stop_spinner_func()
+                            # Use lock to prevent terminal rendering conflicts
+                            with TERMINAL_RENDER_LOCK:
+                                # Stop the spinner if it's running
+                                if stop_spinner_func:
+                                    stop_spinner_func()
+                                    
+                                # Clear the spinner line completely without leaving extra newlines
+                                # Use direct terminal control to ensure consistency
+                                sys.stdout.write("\r" + " " * shutil.get_terminal_size().columns + "\r")
+                                sys.stdout.flush()
                                 
-                            # Clear the spinner line completely without leaving extra newlines
-                            # Use direct terminal control to ensure consistency
-                            sys.stdout.write("\r" + " " * shutil.get_terminal_size().columns + "\r")
-                            sys.stdout.flush()
-                            
-                            # Now start the live display
-                            if live_display:
-                                live_display.start()
+                                # Now start the live display
+                                if live_display:
+                                    live_display.start()
                         
                         # Call the original callback to update content
                         if original_callback:
@@ -351,11 +357,12 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
                 
                 # Print response if not streamed (either due to no_stream or prettify)
                 if no_stream or prettify:
-                    if prettify:
-                        # For pretty formatting with rich, don't print any header text as the rich renderer already includes it
-                        prettify_markdown(response, renderer)
-                    else:
-                        print(response)
+                    with TERMINAL_RENDER_LOCK:
+                        if prettify:
+                            # For pretty formatting with rich, don't print any header text as the rich renderer already includes it
+                            prettify_markdown(response, renderer)
+                        else:
+                            print(response)
                 
                 # Log AI response if logging is enabled
                 if logger:

{ngpt-3.8.1 → ngpt-3.8.3}/ngpt/cli/modes/rewrite.py

@@ -2,7 +2,7 @@ import sys
 import threading
 import time
 from ..formatters import COLORS
-from ..renderers import prettify_markdown, prettify_streaming_markdown
+from ..renderers import prettify_markdown, prettify_streaming_markdown, TERMINAL_RENDER_LOCK
 from ..ui import get_multiline_input, spinner, copy_to_clipboard
 from ...utils import enhance_prompt_with_web_search, process_piped_input
 
@@ -127,9 +127,10 @@ def rewrite_mode(client, args, logger=None):
                 stop_spinner.set()
                 spinner_thread.join()
                 # Clear the spinner line completely
-                sys.stdout.write("\r" + " " * 100 + "\r")
-                sys.stdout.flush()
-                print("Enhanced input with web search results.")
+                with TERMINAL_RENDER_LOCK:
+                    sys.stdout.write("\r" + " " * 100 + "\r")
+                    sys.stdout.flush()
+                    print("Enhanced input with web search results.")
             except Exception as e:
                 # Stop the spinner before re-raising
                 stop_spinner.set()
@@ -197,11 +198,14 @@ def rewrite_mode(client, args, logger=None):
         # On first content, stop the spinner 
         if not first_content_received and stop_spinner_func:
             first_content_received = True
-            # Stop the spinner
-            stop_spinner_func()
-            # Ensure spinner message is cleared with an extra blank line
-            sys.stdout.write("\r" + " " * 100 + "\r\n")
-            sys.stdout.flush()
+            
+            # Use lock to prevent terminal rendering conflicts
+            with TERMINAL_RENDER_LOCK:
+                # Stop the spinner
+                stop_spinner_func()
+                # Ensure spinner message is cleared with an extra blank line
+                sys.stdout.write("\r" + " " * 100 + "\r\n")
+                sys.stdout.flush()
         
         # Call the original callback to update the display
         if original_callback:
@@ -241,10 +245,11 @@ def rewrite_mode(client, args, logger=None):
         
     # Handle non-stream response or regular prettify
     if (args.no_stream or args.prettify) and response:
-        if args.prettify:
-            prettify_markdown(response, args.renderer)
-        else:
-            print(response)
+        with TERMINAL_RENDER_LOCK:
+            if args.prettify:
+                prettify_markdown(response, args.renderer)
+            else:
+                print(response)
             
     # Offer to copy to clipboard if not in a redirected output
     if not args.no_stream and response: