ngpt 2.11.4__tar.gz → 2.12.0__tar.gz

{ngpt-2.11.4 → ngpt-2.12.0}/CONTRIBUTING.md

@@ -20,7 +20,7 @@ Thank you for your interest in contributing to NGPT! This document provides guid
 
 - `ngpt/` - Main package directory
   - `__init__.py` - Package initialization
-  - `cli.py` - Top-level CLI script (potentially legacy)
+  - `__main__.py` - Entry point when run as a module
   - `client.py` - Client implementation for API interaction
   - `cli/` - Command-line interface implementation
     - `__init__.py`

{ngpt-2.11.4 → ngpt-2.12.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.11.4
+Version: 2.12.0
 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
@@ -79,6 +79,9 @@ uv tool install ngpt
 # Chat with default settings
 ngpt "Tell me about quantum computing"
 
+# Alternatively, run as a Python module
+python -m ngpt "Tell me about quantum computing"
+
 # Start an interactive chat session with conversation memory
 ngpt -i
 
@@ -97,6 +100,9 @@ ngpt --code --stream-prettify "function to calculate the Fibonacci sequence"
 # Generate and execute shell commands
 ngpt --shell "list all files in the current directory"
 
+# Read from stdin and use the content in your prompt
+echo "What is this text about?" | ngpt --stdin "Analyze the following text: {}"
+
 # Display markdown responses with beautiful formatting
 ngpt --prettify "Explain markdown syntax with examples"
 
@@ -117,6 +123,9 @@ ngpt --interactive --log conversation.log
 
 # Create a temporary log file automatically
 ngpt --log "Tell me about quantum computing"
+
+# Process text from stdin using the {} placeholder
+cat README.md | ngpt --stdin "Summarize this document: {}"
 ```
 
 For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).

{ngpt-2.11.4 → ngpt-2.12.0}/README.md

@@ -44,6 +44,9 @@ uv tool install ngpt
 # Chat with default settings
 ngpt "Tell me about quantum computing"
 
+# Alternatively, run as a Python module
+python -m ngpt "Tell me about quantum computing"
+
 # Start an interactive chat session with conversation memory
 ngpt -i
 
@@ -62,6 +65,9 @@ ngpt --code --stream-prettify "function to calculate the Fibonacci sequence"
 # Generate and execute shell commands
 ngpt --shell "list all files in the current directory"
 
+# Read from stdin and use the content in your prompt
+echo "What is this text about?" | ngpt --stdin "Analyze the following text: {}"
+
 # Display markdown responses with beautiful formatting
 ngpt --prettify "Explain markdown syntax with examples"
 
@@ -82,6 +88,9 @@ ngpt --interactive --log conversation.log
 
 # Create a temporary log file automatically
 ngpt --log "Tell me about quantum computing"
+
+# Process text from stdin using the {} placeholder
+cat README.md | ngpt --stdin "Summarize this document: {}"
 ```
 
 For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).

{ngpt-2.11.4 → ngpt-2.12.0}/docs/CONTRIBUTING.md

@@ -23,7 +23,7 @@ Thank you for your interest in contributing to NGPT! This document provides guid
 
 - `ngpt/` - Main package directory
   - `__init__.py` - Package initialization
-  - `cli.py` - Top-level CLI script (potentially legacy)
+  - `__main__.py` - Entry point when run as a module
   - `client.py` - Client implementation for API interaction
   - `cli/` - Command-line interface implementation
     - `__init__.py`

{ngpt-2.11.4 → ngpt-2.12.0}/docs/installation.md

@@ -148,6 +148,19 @@ ngpt --version
 
 You should see the version number of nGPT displayed.
 
+Alternatively, you can run nGPT as a Python module:
+
+```bash
+python -m ngpt --version
+```
+
+This method is especially useful when:
+- The `ngpt` command is not in your PATH
+- You're working in a virtual environment
+- You want to ensure you're using the correct Python interpreter
+
+All the functionality available through the `ngpt` command is also available through `python -m ngpt`.
+
 ## Updating nGPT
 
 To update to the latest version:

{ngpt-2.11.4 → ngpt-2.12.0}/docs/usage/cli_usage.md

@@ -48,6 +48,7 @@ Below is a comprehensive list of all available command-line options, organized b
 | `-s, --shell` | Generate and execute shell commands appropriate for your operating system |
 | `-c, --code` | Generate clean code without markdown formatting or explanations |
 | `-t, --text` | Open interactive multiline editor for complex prompts with syntax highlighting |
+| `--stdin` | Read from stdin and use content in your prompt with {} placeholder |
 | `--no-stream` | Return the whole response without streaming (useful for scripts) |
 
 ### Configuration Management
@@ -247,14 +248,48 @@ ngpt -s "clean up temporary files"
 
 # Network diagnostics
 ngpt -s "check if port 8080 is open"
+```
+
+### Stdin Mode
+
+Process text from standard input and incorporate it into your prompt using the `{}` placeholder:
+
+```bash
+echo "Who are you?" | ngpt --stdin "answer {}"
+```
+
+The content from stdin replaces the `{}` placeholder in your prompt. This is useful for:
+
+1. Processing files or command output
+2. Integrating nGPT into shell pipelines
+3. Analyzing text from other commands
+
+#### Examples
+
+Analyze command output:
+```bash
+ls -la | ngpt --stdin "Explain what these files do based on their names: {}"
+```
+
+Analyze a log file:
+```bash
+cat error.log | ngpt --stdin "What's causing these errors? {}"
+```
 
-# Process management
-ngpt -s "find processes using too much memory"
+Summarize documentation:
+```bash
+cat README.md | ngpt --stdin "Summarize this documentation: {}"
+```
 
-# Package management
-ngpt -s "install the latest version of numpy"
+Translate text from a file:
+```bash
+cat french_text.txt | ngpt --stdin "Translate this French text to English: {}"
 ```
 
+#### Placeholder Behavior
+
+The `{}` placeholder will be replaced with stdin content. If the placeholder is not found in your prompt, stdin content will be appended to the end of your prompt with a warning.
+
 ### Generating Code
 
 Generate clean code without markdown or explanations:
@@ -744,6 +779,9 @@ If the `ngpt` command is not found after installation:
 
 - Ensure Python's bin directory is in your PATH
 - Try using `python -m ngpt` instead of just `ngpt`
+  - This works because of the package's `__main__.py` module
+  - It's particularly useful in virtual environments or when the command isn't in your PATH
+  - All the same arguments and options work with this method: `python -m ngpt -i --prettify`
 
 ## Tips and Best Practices
 

{ngpt-2.11.4 → ngpt-2.12.0}/ngpt/cli/args.py

@@ -99,7 +99,8 @@ def setup_argument_parser():
                                       help='Generate code')
     mode_exclusive_group.add_argument('-t', '--text', action='store_true', 
                                       help='Enter multi-line text input (submit with Ctrl+D)')
-    # Note: --show-config is handled separately and implicitly acts as a mode
+    mode_exclusive_group.add_argument('--stdin', action='store_true',
+                                      help='Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content')
     
     return parser
 
@@ -122,6 +123,10 @@ def validate_args(args):
     if args.stream_prettify and not has_markdown_renderer('rich'):
         raise ValueError("--stream-prettify requires Rich to be installed. Install with: pip install \"ngpt[full]\" or pip install rich")
     
+    # If stdin mode is used, check if input is available
+    if args.stdin and sys.stdin.isatty():
+        raise ValueError("--stdin was specified but no input is piped. Use echo 'content' | ngpt --stdin 'prompt with {}'")
+    
     return args
 
 def validate_markdown_renderer(args):

{ngpt-2.11.4 → ngpt-2.12.0}/ngpt/cli/main.py

@@ -542,6 +542,13 @@ def main():
             # Text mode (multiline input)
             text_mode(client, args, logger=logger)
         
+        elif args.stdin:
+            # Apply CLI config for stdin mode (similar to chat mode)
+            args = apply_cli_config(args, "all")
+            
+            # Stdin mode (using the chat mode with stdin input)
+            chat_mode(client, args, logger=logger)
+        
         else:
             # Default to chat mode
             # Apply CLI config for default chat mode

{ngpt-2.11.4 → ngpt-2.12.0}/ngpt/cli/modes/chat.py

@@ -10,16 +10,43 @@ def chat_mode(client, args, logger=None):
         args: The parsed command-line arguments
         logger: Optional logger instance
     """
-    # Get the prompt
-    if args.prompt is None:
-        try:
-            print("Enter your prompt: ", end='')
-            prompt = input()
-        except KeyboardInterrupt:
-            print("\nInput cancelled by user. Exiting gracefully.")
-            sys.exit(130)
+    # Handle stdin mode
+    if args.stdin:
+        # Read input from stdin
+        stdin_content = sys.stdin.read().strip()
+        
+        # Get the prompt - either use provided one or ask user
+        if args.prompt is None:
+            try:
+                print("Enter your prompt (use {} as placeholder for stdin): ", end='')
+                prompt = input()
+            except KeyboardInterrupt:
+                print("\nInput cancelled by user. Exiting gracefully.")
+                sys.exit(130)
+        else:
+            prompt = args.prompt
+        
+        # Replace the placeholder in the prompt with stdin content
+        placeholder = "{}"
+        
+        # Check if the placeholder exists in the prompt
+        if placeholder not in prompt:
+            print(f"{COLORS['yellow']}Warning: Placeholder '{placeholder}' not found in prompt. Appending stdin content to the end.{COLORS['reset']}")
+            prompt = f"{prompt} {stdin_content}"
+        else:
+            prompt = prompt.replace(placeholder, stdin_content)
+    # Handle regular chat mode
     else:
-        prompt = args.prompt
+        # Get the prompt
+        if args.prompt is None:
+            try:
+                print("Enter your prompt: ", end='')
+                prompt = input()
+            except KeyboardInterrupt:
+                print("\nInput cancelled by user. Exiting gracefully.")
+                sys.exit(130)
+        else:
+            prompt = args.prompt
     
     # Log the user message if logging is enabled
     if logger:

{ngpt-2.11.4 → ngpt-2.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ngpt"
-version = "2.11.4"
+version = "2.12.0"
 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"},
@@ -41,7 +41,7 @@ classifiers = [
 "Bug Tracker" = "https://github.com/nazdridoy/ngpt/issues"
 
 [project.scripts]
-ngpt = "ngpt.cli:main"
+ngpt = "ngpt.__main__:main"
 
 [build-system]
 requires = ["hatchling"]

{ngpt-2.11.4 → ngpt-2.12.0}/uv.lock

@@ -134,7 +134,7 @@ wheels = [
 
 [[package]]
 name = "ngpt"
-version = "2.11.4"
+version = "2.12.0"
 source = { editable = "." }
 dependencies = [
     { name = "prompt-toolkit" },