ngpt 2.3.4__tar.gz → 2.5.0__tar.gz

{ngpt-2.3.4 → ngpt-2.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.3.4
+Version: 2.5.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
@@ -30,6 +30,9 @@ Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 Requires-Dist: prompt-toolkit>=3.0.0
 Requires-Dist: requests>=2.31.0
+Requires-Dist: rich>=14.0.0
+Provides-Extra: prettify
+Requires-Dist: rich>=10.0.0; extra == 'prettify'
 Description-Content-Type: text/markdown
 
 # nGPT
@@ -76,9 +79,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 +111,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,8 +280,12 @@ 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) |
 | `--remove` | Remove the configuration at the specified index (requires --config and --config-index) |
 | `--show-config` | Show configuration details and exit |
 | `--all` | Used with `--show-config` to display all configurations |
@@ -291,8 +308,17 @@ ngpt --config
 # Edit an existing configuration at index 1
 ngpt --config --config-index 1
 
+# Edit an existing configuration by provider name
+ngpt --config --provider Gemini
+
 # Remove a configuration at index 2
 ngpt --config --remove --config-index 2
+
+# Remove a configuration by provider name
+ngpt --config --remove --provider Gemini
+
+# Use a specific configuration by provider name
+ngpt --provider OpenAI "Tell me about quantum computing"
 ```
 
 In interactive mode:

{ngpt-2.3.4 → ngpt-2.5.0}/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,8 +243,12 @@ 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) |
 | `--remove` | Remove the configuration at the specified index (requires --config and --config-index) |
 | `--show-config` | Show configuration details and exit |
 | `--all` | Used with `--show-config` to display all configurations |
@@ -257,8 +271,17 @@ ngpt --config
 # Edit an existing configuration at index 1
 ngpt --config --config-index 1
 
+# Edit an existing configuration by provider name
+ngpt --config --provider Gemini
+
 # Remove a configuration at index 2
 ngpt --config --remove --config-index 2
+
+# Remove a configuration by provider name
+ngpt --config --remove --provider Gemini
+
+# Use a specific configuration by provider name
+ngpt --provider OpenAI "Tell me about quantum computing"
 ```
 
 In interactive mode:

{ngpt-2.3.4 → ngpt-2.5.0}/docs/api/config.md

@@ -122,7 +122,7 @@ custom_configs = load_configs("/path/to/custom/config.json")
 
 ### load_config()
 
-Loads a specific configuration by index and applies environment variables.
+Loads a specific configuration by index or provider name and applies environment variables.
 
 ```python
 from ngpt.config import load_config
@@ -130,7 +130,8 @@ from typing import Dict, Any
 
 config: Dict[str, Any] = load_config(
     custom_path: Optional[str] = None,
-    config_index: int = 0
+    config_index: int = 0,
+    provider: Optional[str] = None
 )
 ```
 
@@ -140,6 +141,7 @@ config: Dict[str, Any] = load_config(
 |-----------|------|---------|-------------|
 | `custom_path` | `Optional[str]` | `None` | Optional custom path to the configuration file |
 | `config_index` | `int` | `0` | Index of the configuration to load (0-based) |
+| `provider` | `Optional[str]` | `None` | Provider name to identify the configuration to use (alternative to config_index) |
 
 #### Returns
 
@@ -160,6 +162,11 @@ config_1 = load_config(config_index=1)
 print(f"Using provider: {config_1.get('provider', 'Unknown')}")
 print(f"Using model: {config_1.get('model', 'Unknown')}")
 
+# Load a specific configuration by provider name
+gemini_config = load_config(provider="Gemini")
+print(f"Using provider: {gemini_config.get('provider', 'Unknown')}")
+print(f"Using model: {gemini_config.get('model', 'Unknown')}")
+
 # Load from a custom path
 custom_config = load_config(custom_path="/path/to/custom/config.json")
 ```
@@ -277,6 +284,57 @@ else:
     print("Failed to remove configuration")
 ```
 
+### is_provider_unique()
+
+Checks if a provider name is unique among configurations.
+
+```python
+from ngpt.config import is_provider_unique
+from typing import List, Dict, Any, Optional
+
+is_unique: bool = is_provider_unique(
+    configs: List[Dict[str, Any]],
+    provider: str,
+    exclude_index: Optional[int] = None
+)
+```
+
+#### Parameters
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `configs` | `List[Dict[str, Any]]` | Required | List of configuration dictionaries |
+| `provider` | `str` | Required | Provider name to check for uniqueness |
+| `exclude_index` | `Optional[int]` | `None` | Optional index to exclude from the check (useful when updating an existing config) |
+
+#### Returns
+
+`True` if the provider name is unique among all configurations, `False` otherwise.
+
+#### Examples
+
+```python
+from ngpt.config import load_configs, is_provider_unique
+
+# Load all configurations
+configs = load_configs()
+
+# Check if a provider name is unique
+provider_name = "New Provider"
+if is_provider_unique(configs, provider_name):
+    print(f"'{provider_name}' is a unique provider name")
+else:
+    print(f"'{provider_name}' is already used by another configuration")
+
+# Check if provider name is unique when updating an existing config
+existing_idx = 1
+update_provider = "Updated Provider"
+if is_provider_unique(configs, update_provider, exclude_index=existing_idx):
+    print(f"'{update_provider}' is unique and can be used to update config at index {existing_idx}")
+else:
+    print(f"'{update_provider}' is already used by another configuration")
+```
+
 ## Complete Examples
 
 ### Managing Multiple Configurations

{ngpt-2.3.4 → ngpt-2.5.0}/docs/configuration.md

@@ -87,8 +87,14 @@ ngpt --config
 # Edit an existing configuration at index 1
 ngpt --config --config-index 1
 
+# Edit an existing configuration by provider name
+ngpt --config --provider Gemini
+
 # Remove a configuration at index 2
 ngpt --config --remove --config-index 2
+
+# Remove a configuration by provider name
+ngpt --config --remove --provider Gemini
 ```
 
 The interactive configuration will prompt you for values and guide you through the process.
@@ -104,6 +110,9 @@ ngpt --api-key "your-key" --base-url "https://api.example.com/v1/" --model "cust
 # Select a specific configuration by index
 ngpt --config-index 2 "Your prompt here"
 
+# Select a specific configuration by provider name
+ngpt --provider Gemini "Your prompt here"
+
 # Control response generation parameters
 ngpt --temperature 0.8 --top_p 0.95 --max_tokens 300 "Write a creative story"
 
@@ -158,6 +167,11 @@ ngpt --config-index 1 "Tell me about quantum computing"
 
 # Use local Ollama (config at index 2)
 ngpt --config-index 2 "Tell me about quantum computing"
+
+# Or use provider names instead of indices (more intuitive)
+ngpt --provider OpenAI "Tell me about quantum computing"
+ngpt --provider Groq "Tell me about quantum computing"
+ngpt --provider Ollama-Local "Tell me about quantum computing"
 ```
 
 ### Programmatically Loading Configurations
@@ -167,12 +181,12 @@ In your Python code, you can load and use different configurations:
 ```python
 from ngpt import NGPTClient, load_config
 
-# Load OpenAI configuration
+# Load OpenAI configuration by index
 openai_config = load_config(config_index=0)
 openai_client = NGPTClient(**openai_config)
 
-# Load Groq configuration
-groq_config = load_config(config_index=1)
+# Load Groq configuration by provider name
+groq_config = load_config(provider="Groq")
 groq_client = NGPTClient(**groq_config)
 
 # Use the clients

{ngpt-2.3.4 → ngpt-2.5.0}/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.3.4 → ngpt-2.5.0}/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.3.4 → ngpt-2.5.0}/docs/usage/cli_usage.md

@@ -48,6 +48,11 @@ 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) |
 
 ## Feature Details
 
@@ -138,6 +143,44 @@ 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 renders the AI's response with proper markdown 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"
+```
+
+See available renderers on your system:
+
+```bash
+ngpt --list-renderers
+```
+
 ### Using Web Search
 
 Enable web search capability (if your API endpoint supports it):
@@ -172,6 +215,12 @@ Select a specific configuration by index:
 ngpt --config-index 1 "Your prompt here"
 ```
 
+Select a specific configuration by provider name:
+
+```bash
+ngpt --provider Gemini "Your prompt here"
+```
+
 Specify API credentials directly:
 
 ```bash
@@ -186,18 +235,30 @@ Add a new configuration interactively:
 ngpt --config
 ```
 
-Edit an existing configuration:
+Edit an existing configuration by index:
 
 ```bash
 ngpt --config --config-index 1
 ```
 
-Remove a configuration:
+Edit an existing configuration by provider name:
+
+```bash
+ngpt --config --provider Gemini
+```
+
+Remove a configuration by index:
 
 ```bash
 ngpt --config --remove --config-index 2
 ```
 
+Remove a configuration by provider name:
+
+```bash
+ngpt --config --remove --provider Gemini
+```
+
 ### Model Management
 
 List all available models for the current configuration:
@@ -228,8 +289,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