ngpt 2.1.0__tar.gz → 2.3.0__tar.gz

{ngpt-2.1.0 → ngpt-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.1.0
+Version: 2.3.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
@@ -81,8 +81,16 @@ ngpt --shell "list all files in the current directory"
 
 # Use multiline editor for complex prompts
 ngpt --text
+
+# Use custom system prompt
+ngpt --preprompt "You are a Linux expert" "How do I find large files?"
+
+# Log your conversation to a file
+ngpt --interactive --log conversation.log
 ```
 
+For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ## Features
 
 - ✅ **Dual Mode**: Use as a CLI tool or import as a Python library
@@ -95,6 +103,10 @@ ngpt --text
 - 💻 **Shell Command Generation**: OS-aware command execution
 - 🧩 **Clean Code Generation**: Output code without markdown or explanations
 - 📝 **Rich Multiline Editor**: Interactive multiline text input with syntax highlighting and intuitive controls
+- 🎭 **System Prompts**: Customize model behavior with custom system prompts
+- 📃 **Conversation Logging**: Save your conversations to text files for later reference
+
+See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview.html) for more details.
 
 ## Documentation
 
@@ -102,6 +114,13 @@ Comprehensive documentation, including API reference, usage guides, and examples
 
 **[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
 
+Key documentation sections:
+- [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html)
+- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html)
+- [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html)
+- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html)
+- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic.html)
+
 ## Installation
 
 ```bash
@@ -110,6 +129,8 @@ pip install ngpt
 
 Requires Python 3.8 or newer.
 
+For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html).
+
 ## Usage
 
 ### As a CLI Tool
@@ -121,6 +142,12 @@ ngpt "Hello, how are you?"
 # Interactive chat session with conversation history
 ngpt -i
 
+# Log conversation to a file
+ngpt --interactive --log conversation.log
+
+# Use custom system prompt to guide AI behavior
+ngpt --preprompt "You are a Python programming tutor" "Explain decorators"
+
 # Show version information
 ngpt -v
 
@@ -157,6 +184,8 @@ ngpt -c "create a python function that calculates fibonacci numbers"
 ngpt -t
 ```
 
+For more CLI examples and detailed usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### As a Library
 
 ```python
@@ -189,6 +218,8 @@ command = client.generate_shell_command("list all files")
 code = client.generate_code("create a python function that calculates fibonacci numbers")
 ```
 
+For more library examples and advanced usage, see the [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html).
+
 #### Advanced Library Usage
 
 ```python
@@ -215,6 +246,8 @@ code = client.generate_code("function that converts Celsius to Fahrenheit")
 print(code)
 ```
 
+For advanced usage patterns and integrations, check out the [Advanced Examples](https://nazdridoy.github.io/ngpt/examples/advanced.html).
+
 ## Configuration
 
 ### Command Line Options
@@ -232,6 +265,8 @@ You can configure the client using the following options:
 | `--temperature` | Set temperature (controls randomness, default: 0.7) |
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--max_length` | 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) |
 | `--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) |
 | `--remove` | Remove the configuration at the specified index (requires --config and --config-index) |
@@ -243,6 +278,8 @@ You can configure the client using the following options:
 | `-t, --text` | Open interactive multiline editor for complex prompts |
 | `-v, --version` | Show version information |
 
+For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### Interactive Configuration
 
 The `--config` option without arguments enters interactive configuration mode, allowing you to add or edit configurations:
@@ -264,6 +301,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
 
+For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration File
 
 nGPT uses a configuration file stored in the standard user config directory for your operating system:
@@ -298,6 +337,8 @@ The configuration file uses a JSON list format, allowing you to store multiple c
 ]
 ```
 
+For details on the configuration file format and structure, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration Priority
 
 nGPT determines configuration values in the following order (highest priority first):

{ngpt-2.1.0 → ngpt-2.3.0}/README.md

@@ -47,8 +47,16 @@ ngpt --shell "list all files in the current directory"
 
 # Use multiline editor for complex prompts
 ngpt --text
+
+# Use custom system prompt
+ngpt --preprompt "You are a Linux expert" "How do I find large files?"
+
+# Log your conversation to a file
+ngpt --interactive --log conversation.log
 ```
 
+For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ## Features
 
 - ✅ **Dual Mode**: Use as a CLI tool or import as a Python library
@@ -61,6 +69,10 @@ ngpt --text
 - 💻 **Shell Command Generation**: OS-aware command execution
 - 🧩 **Clean Code Generation**: Output code without markdown or explanations
 - 📝 **Rich Multiline Editor**: Interactive multiline text input with syntax highlighting and intuitive controls
+- 🎭 **System Prompts**: Customize model behavior with custom system prompts
+- 📃 **Conversation Logging**: Save your conversations to text files for later reference
+
+See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview.html) for more details.
 
 ## Documentation
 
@@ -68,6 +80,13 @@ Comprehensive documentation, including API reference, usage guides, and examples
 
 **[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
 
+Key documentation sections:
+- [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html)
+- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html)
+- [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html)
+- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html)
+- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic.html)
+
 ## Installation
 
 ```bash
@@ -76,6 +95,8 @@ pip install ngpt
 
 Requires Python 3.8 or newer.
 
+For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html).
+
 ## Usage
 
 ### As a CLI Tool
@@ -87,6 +108,12 @@ ngpt "Hello, how are you?"
 # Interactive chat session with conversation history
 ngpt -i
 
+# Log conversation to a file
+ngpt --interactive --log conversation.log
+
+# Use custom system prompt to guide AI behavior
+ngpt --preprompt "You are a Python programming tutor" "Explain decorators"
+
 # Show version information
 ngpt -v
 
@@ -123,6 +150,8 @@ ngpt -c "create a python function that calculates fibonacci numbers"
 ngpt -t
 ```
 
+For more CLI examples and detailed usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### As a Library
 
 ```python
@@ -155,6 +184,8 @@ command = client.generate_shell_command("list all files")
 code = client.generate_code("create a python function that calculates fibonacci numbers")
 ```
 
+For more library examples and advanced usage, see the [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html).
+
 #### Advanced Library Usage
 
 ```python
@@ -181,6 +212,8 @@ code = client.generate_code("function that converts Celsius to Fahrenheit")
 print(code)
 ```
 
+For advanced usage patterns and integrations, check out the [Advanced Examples](https://nazdridoy.github.io/ngpt/examples/advanced.html).
+
 ## Configuration
 
 ### Command Line Options
@@ -198,6 +231,8 @@ You can configure the client using the following options:
 | `--temperature` | Set temperature (controls randomness, default: 0.7) |
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--max_length` | 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) |
 | `--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) |
 | `--remove` | Remove the configuration at the specified index (requires --config and --config-index) |
@@ -209,6 +244,8 @@ You can configure the client using the following options:
 | `-t, --text` | Open interactive multiline editor for complex prompts |
 | `-v, --version` | Show version information |
 
+For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### Interactive Configuration
 
 The `--config` option without arguments enters interactive configuration mode, allowing you to add or edit configurations:
@@ -230,6 +267,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
 
+For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration File
 
 nGPT uses a configuration file stored in the standard user config directory for your operating system:
@@ -264,6 +303,8 @@ The configuration file uses a JSON list format, allowing you to store multiple c
 ]
 ```
 
+For details on the configuration file format and structure, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration Priority
 
 nGPT determines configuration values in the following order (highest priority first):

{ngpt-2.1.0 → ngpt-2.3.0}/docs/configuration.md

@@ -106,6 +106,12 @@ ngpt --config-index 2 "Your prompt here"
 
 # Control response generation parameters
 ngpt --temperature 0.8 --top_p 0.95 --max_length 300 "Write a creative story"
+
+# Set a custom system prompt (preprompt)
+ngpt --preprompt "You are a Linux command line expert. Focus on efficient solutions." "How do I find the largest files in a directory?"
+
+# Save conversation to a log file (for interactive modes)
+ngpt --interactive --log conversation.log
 ```
 
 ## Environment Variables

{ngpt-2.1.0 → ngpt-2.3.0}/docs/examples/advanced.md

@@ -61,6 +61,52 @@ response = client.chat("", messages=messages)
 print(response)
 ```
 
+Using preprompts in the CLI:
+
+```bash
+# Make the model respond as a specific expert
+ngpt --preprompt "You are a Linux command line expert. Focus on efficient solutions." \
+     "How do I find the largest files in a directory?"
+
+# Set content and formatting constraints
+ngpt --preprompt "Your responses should be concise and include code examples." \
+     "How to parse JSON in JavaScript?"
+
+# Create a specialized tutor for interactive sessions
+ngpt --interactive --preprompt "You are a Python programming tutor. Explain concepts clearly and provide helpful examples."
+```
+
+### Conversation Logging
+
+Save your conversation history to a file for reference:
+
+```bash
+# Basic interactive session with logging
+ngpt --interactive --log python_tutoring.log
+
+# Combine logging with custom system prompt
+ngpt --interactive \
+     --preprompt "You are a data science expert helping analyze experimental results." \
+     --log data_analysis_session.log
+
+# Log a focused session on a specific topic
+ngpt --interactive \
+     --preprompt "You are helping plan the architecture for a microservices application." \
+     --log architecture_planning.log
+```
+
+The log file contains the complete conversation transcript, including:
+- Session metadata (timestamp, command used)
+- All user messages
+- All AI responses
+- System prompts when custom preprompts are used
+
+This is particularly useful for:
+- Documenting important planning discussions
+- Saving educational sessions for later review
+- Keeping records of complex problem-solving processes
+- Sharing conversations with team members
+
 ## Advanced Conversation Management
 
 ### Managing Conversation History

{ngpt-2.1.0 → ngpt-2.3.0}/docs/usage/cli_usage.md

@@ -42,6 +42,8 @@ Here are the most commonly used options:
 | `-c, --code` | Generate clean code without markdown formatting |
 | `-t, --text` | Open interactive multiline editor for complex prompts |
 | `-v, --version` | Show version information |
+| `--preprompt` | Set custom system prompt to control AI behavior |
+| `--log` | Set filepath to log conversation to (for interactive modes) |
 | `--web-search` | Enable web search capability (if supported by your API) |
 | `--temperature` | Set temperature (controls randomness, default: 0.7) |
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
@@ -73,6 +75,36 @@ This opens a continuous chat session where the AI remembers previous exchanges.
 - Use arrow keys to navigate message history
 - Press Ctrl+C to exit the session
 
+You can log your conversation to a file for later reference:
+
+```bash
+ngpt -i --log conversation.log
+```
+
+This saves the entire conversation, including both user inputs and AI responses, to the specified file.
+
+### Custom System Prompts
+
+Use custom system prompts to guide the AI's behavior and responses:
+
+```bash
+ngpt --preprompt "You are a Linux command line expert. Focus on efficient solutions." "How do I find the largest files in a directory?"
+```
+
+This replaces the default "You are a helpful assistant" system prompt with your custom instruction.
+
+You can also use custom prompts in interactive mode:
+
+```bash
+ngpt -i --preprompt "You are a Python programming tutor. Explain concepts clearly and provide helpful examples."
+```
+
+Custom prompts can be used to:
+- Set the AI's persona or role
+- Provide background information or context
+- Specify output format preferences
+- Set constraints or guidelines
+
 ### Generating Shell Commands
 
 Generate and execute shell commands appropriate for your operating system:
@@ -192,6 +224,12 @@ ngpt -c --web-search "function to get current weather using an API"
 
 # Use a specific model and no streaming
 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?"
 ```
 
 ### Using a Custom Configuration File
@@ -268,6 +306,9 @@ ngpt "Explain quantum computing for beginners"
 
 # Get current information (with web search)
 ngpt --web-search "What are the latest advancements in AI?"
+
+# Learn with a specialized tutor using custom prompt
+ngpt --preprompt "You are an expert physicist explaining concepts to a beginner. Use analogies and simple language." "Explain quantum entanglement"
 ```
 
 ### Productivity
@@ -279,6 +320,9 @@ ngpt -s "find large files over 100MB and list them by size"
 # Create a structured document
 ngpt -t
 # (Enter multiline text for generating a complex document)
+
+# Log an important session for reference
+ngpt -i --log project_planning.log --preprompt "You are a project management expert helping plan a software project"
 ```
 
 ## Troubleshooting

{ngpt-2.1.0 → ngpt-2.3.0}/ngpt/cli.py

@@ -85,7 +85,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_length=None):
+def interactive_chat_session(client, web_search=False, no_stream=False, temperature=0.7, top_p=1.0, max_length=None, log_file=None, preprompt=None):
     """Run an interactive chat session with conversation history."""
     # Define ANSI color codes for terminal output
     COLORS = {
@@ -127,16 +127,35 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
     
     print(f"\n{separator}\n")
     
+    # Initialize log file if provided
+    log_handle = None
+    if log_file:
+        try:
+            import datetime
+            timestamp = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
+            log_handle = open(log_file, 'a', encoding='utf-8')
+            log_handle.write(f"\n--- nGPT Session Log: {sys.argv} ---\n")
+            log_handle.write(f"Started at: {timestamp}\n\n")
+            print(f"{COLORS['green']}Logging conversation to: {log_file}{COLORS['reset']}")
+        except Exception as e:
+            print(f"{COLORS['yellow']}Warning: Could not open log file: {str(e)}{COLORS['reset']}")
+            log_handle = None
+    
     # Custom separator - use the same length for consistency
     def print_separator():
         print(f"\n{separator}\n")
     
     # Initialize conversation history
-    system_prompt = "You are a helpful assistant."
+    system_prompt = preprompt if preprompt else "You are a helpful assistant."
     conversation = []
     system_message = {"role": "system", "content": system_prompt}
     conversation.append(system_message)
     
+    # Log system prompt if logging is enabled
+    if log_handle and preprompt:
+        log_handle.write(f"System: {system_prompt}\n\n")
+        log_handle.flush()
+    
     # Initialize prompt_toolkit history
     prompt_history = InMemoryHistory() if HAS_PROMPT_TOOLKIT else None
     
@@ -228,6 +247,11 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
             user_message = {"role": "user", "content": user_input}
             conversation.append(user_message)
             
+            # Log user message if logging is enabled
+            if log_handle:
+                log_handle.write(f"User: {user_input}\n")
+                log_handle.flush()
+            
             # Print assistant indicator with formatting
             if not no_stream:
                 print(f"\n{ngpt_header()}: {COLORS['reset']}", end="", flush=True)
@@ -253,6 +277,11 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
                 # Print response if not streamed
                 if no_stream:
                     print(response)
+                
+                # Log assistant response if logging is enabled
+                if log_handle:
+                    log_handle.write(f"Assistant: {response}\n\n")
+                    log_handle.flush()
             
             # Print separator between exchanges
             print_separator()
@@ -264,9 +293,14 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
         # Print traceback for debugging if it's a serious error
         import traceback
         traceback.print_exc()
+    finally:
+        # Close log file if it was opened
+        if log_handle:
+            log_handle.write(f"\n--- End of Session ---\n")
+            log_handle.close()
 
 def main():
-    parser = argparse.ArgumentParser(description="nGPT - A CLI tool for interacting with custom OpenAI API endpoints")
+    parser = argparse.ArgumentParser(description="nGPT - A CLI tool for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints")
     
     # Version flag
     parser.add_argument('-v', '--version', action='version', version=f'nGPT {__version__}', help='Show version information and exit')
@@ -295,6 +329,10 @@ def main():
                       help='Set top_p (controls diversity, default: 1.0)')
     global_group.add_argument('--max_length', type=int, 
                       help='Set max response length in tokens')
+    global_group.add_argument('--log', metavar='FILE',
+                      help='Set filepath to log conversation to (For interactive modes)')
+    global_group.add_argument('--preprompt', 
+                      help='Set preprompt')
     
     # Mode flags (mutually exclusive)
     mode_group = parser.add_argument_group('Modes (mutually exclusive)')
@@ -455,7 +493,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_length=args.max_length)
+                                   max_length=args.max_length, log_file=args.log, preprompt=args.preprompt)
         elif args.shell:
             if args.prompt is None:
                 try:
@@ -512,7 +550,6 @@ def main():
                 print(f"\nGenerated code:\n{generated_code}")
             
         elif args.text:
-            # Multi-line text input mode
             if args.prompt is not None:
                 prompt = args.prompt
             else:
@@ -620,9 +657,18 @@ def main():
                     sys.exit(130)
             
             print("\nSubmission successful. Waiting for response...")
+            
+            # Create messages array with preprompt if available
+            messages = None
+            if args.preprompt:
+                messages = [
+                    {"role": "system", "content": args.preprompt},
+                    {"role": "user", "content": prompt}
+                ]
+                
             response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_length)
+                               max_tokens=args.max_length, messages=messages)
             if args.no_stream and response:
                 print(response)
             
@@ -637,9 +683,18 @@ def main():
                     sys.exit(130)
             else:
                 prompt = args.prompt
+                
+            # Create messages array with preprompt if available
+            messages = None
+            if args.preprompt:
+                messages = [
+                    {"role": "system", "content": args.preprompt},
+                    {"role": "user", "content": prompt}
+                ]
+                
             response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_length)
+                               max_tokens=args.max_length, messages=messages)
             if args.no_stream and response:
                 print(response)
     

{ngpt-2.1.0 → ngpt-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ngpt"
-version = "2.1.0"
+version = "2.3.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"},

{ngpt-2.1.0 → ngpt-2.3.0}/uv.lock

@@ -113,7 +113,7 @@ wheels = [
 
 [[package]]
 name = "ngpt"
-version = "2.1.0"
+version = "2.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "prompt-toolkit" },