ngpt 2.10.0__tar.gz → 2.11.1__tar.gz

{ngpt-2.10.0 → ngpt-2.11.1}/CONTRIBUTING.md

@@ -20,9 +20,23 @@ Thank you for your interest in contributing to NGPT! This document provides guid
 
 - `ngpt/` - Main package directory
   - `__init__.py` - Package initialization
-  - `cli.py` - Command-line interface implementation
-  - `config.py` - Configuration management
-  - `client.py` - Client implementation
+  - `cli.py` - Top-level CLI script (potentially legacy)
+  - `client.py` - Client implementation for API interaction
+  - `cli/` - Command-line interface implementation
+    - `__init__.py`
+    - `main.py` - Main CLI application logic
+    - `args.py` - Argument parsing setup
+    - `config_manager.py` - CLI configuration handling
+    - `formatters.py` - Output formatting logic
+    - `interactive.py` - Interactive mode implementation
+    - `modes/` - Different operational modes (e.g., chat, run)
+    - `renderers.py` - Output rendering logic (e.g., markdown)
+    - `ui.py` - User interface elements (e.g., prompts, spinners)
+  - `utils/` - Utility modules
+    - `__init__.py`
+    - `config.py` - API endpoint and general configuration management
+    - `cli_config.py` - CLI-specific option configuration management
+    - `log.py` - Logging setup and utilities
 - `.github/` - GitHub workflows and templates
 - `pyproject.toml` - Project configuration and dependencies
 
@@ -87,4 +101,4 @@ For questions about the project that aren't bugs or feature requests, please use
 
 ## License
 
-By contributing to this project, you agree that your contributions will be licensed under the same [LICENSE](LICENSE) as the project.
+By contributing to this project, you agree that your contributions will be licensed under the same [LICENSE](LICENSE) as the project.

{ngpt-2.10.0 → ngpt-2.11.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.10.0
+Version: 2.11.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
@@ -114,6 +114,9 @@ ngpt --preprompt "You are a Linux expert" "How do I find large files?"
 
 # Log your conversation to a file
 ngpt --interactive --log conversation.log
+
+# Create a temporary log file automatically
+ngpt --log "Tell me about quantum computing"
 ```
 
 For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
@@ -228,7 +231,8 @@ For more CLI examples and detailed usage information, see the [CLI Usage Guide](
 ### As a Library
 
 ```python
-from ngpt import NGPTClient, load_config
+from ngpt import NGPTClient
+from ngpt.utils.config import load_config
 
 # Load the first configuration (index 0) from config file
 config = load_config(config_index=0)
@@ -292,7 +296,8 @@ For advanced usage patterns and integrations, check out the [Advanced Examples](
 nGPT can also be used as a framework to build your own AI-powered command-line tools. You can leverage nGPT's pre-built CLI components to quickly develop sophisticated CLI applications.
 
 ```python
-from ngpt import NGPTClient, load_config
+from ngpt import NGPTClient
+from ngpt.utils.config import load_config
 from ngpt.cli.interactive import interactive_chat_session
 from ngpt.cli.renderers import prettify_markdown
 from ngpt.cli.args import setup_argument_parser
@@ -349,7 +354,7 @@ You can configure the client using the following options:
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--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) |
+| `--log` | Enable logging: use `--log` to create a temporary log file, or `--log PATH` for a specific location |
 | `--prettify` | Render markdown responses and code with syntax highlighting |
 | `--stream-prettify` | Enable real-time markdown rendering with syntax highlighting while streaming |
 | `--renderer` | Select which markdown renderer to use with --prettify (auto, rich, or glow) |

{ngpt-2.10.0 → ngpt-2.11.1}/README.md

@@ -79,6 +79,9 @@ ngpt --preprompt "You are a Linux expert" "How do I find large files?"
 
 # Log your conversation to a file
 ngpt --interactive --log conversation.log
+
+# Create a temporary log file automatically
+ngpt --log "Tell me about quantum computing"
 ```
 
 For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
@@ -193,7 +196,8 @@ For more CLI examples and detailed usage information, see the [CLI Usage Guide](
 ### As a Library
 
 ```python
-from ngpt import NGPTClient, load_config
+from ngpt import NGPTClient
+from ngpt.utils.config import load_config
 
 # Load the first configuration (index 0) from config file
 config = load_config(config_index=0)
@@ -257,7 +261,8 @@ For advanced usage patterns and integrations, check out the [Advanced Examples](
 nGPT can also be used as a framework to build your own AI-powered command-line tools. You can leverage nGPT's pre-built CLI components to quickly develop sophisticated CLI applications.
 
 ```python
-from ngpt import NGPTClient, load_config
+from ngpt import NGPTClient
+from ngpt.utils.config import load_config
 from ngpt.cli.interactive import interactive_chat_session
 from ngpt.cli.renderers import prettify_markdown
 from ngpt.cli.args import setup_argument_parser
@@ -314,7 +319,7 @@ You can configure the client using the following options:
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--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) |
+| `--log` | Enable logging: use `--log` to create a temporary log file, or `--log PATH` for a specific location |
 | `--prettify` | Render markdown responses and code with syntax highlighting |
 | `--stream-prettify` | Enable real-time markdown rendering with syntax highlighting while streaming |
 | `--renderer` | Select which markdown renderer to use with --prettify (auto, rich, or glow) |

{ngpt-2.10.0 → ngpt-2.11.1}/docs/CONTRIBUTING.md

@@ -23,9 +23,23 @@ Thank you for your interest in contributing to NGPT! This document provides guid
 
 - `ngpt/` - Main package directory
   - `__init__.py` - Package initialization
-  - `cli.py` - Command-line interface implementation
-  - `config.py` - Configuration management
-  - `client.py` - Client implementation
+  - `cli.py` - Top-level CLI script (potentially legacy)
+  - `client.py` - Client implementation for API interaction
+  - `cli/` - Command-line interface implementation
+    - `__init__.py`
+    - `main.py` - Main CLI application logic
+    - `args.py` - Argument parsing setup
+    - `config_manager.py` - CLI configuration handling
+    - `formatters.py` - Output formatting logic
+    - `interactive.py` - Interactive mode implementation
+    - `modes/` - Different operational modes (e.g., chat, run)
+    - `renderers.py` - Output rendering logic (e.g., markdown)
+    - `ui.py` - User interface elements (e.g., prompts, spinners)
+  - `utils/` - Utility modules
+    - `__init__.py`
+    - `config.py` - API endpoint and general configuration management
+    - `cli_config.py` - CLI-specific option configuration management
+    - `log.py` - Logging setup and utilities
 - `.github/` - GitHub workflows and templates
 - `pyproject.toml` - Project configuration and dependencies
 

ngpt-2.11.1/docs/api/README.md

@@ -0,0 +1,85 @@
+# API Reference
+
+This section provides detailed documentation for the nGPT API, including all classes, methods, functions, and parameters.
+
+## Overview
+
+nGPT's API consists of several main components:
+
+1. **NGPTClient**: The main client class used to interact with AI providers
+2. **Configuration Utilities**: Functions for managing configuration files and settings
+3. **CLI Components**: Modular CLI utilities that can be reused in custom applications
+4. **CLI Configuration Utilities**: Functions for managing CLI-specific configurations
+
+## Table of Contents
+
+- [NGPTClient](client.md) - Primary client for interacting with LLM APIs
+  - [Initialization](client.md#initialization)
+  - [Chat Method](client.md#chat-method)
+  - [Generate Shell Command](client.md#generate-shell-command)
+  - [Generate Code](client.md#generate-code)
+  - [List Models](client.md#list-models)
+
+- [Configuration](config.md) - Functions for managing configurations
+  - [Loading Configurations](config.md#loading-configurations)
+  - [Creating Configurations](config.md#creating-configurations)
+  - [Editing Configurations](config.md#editing-configurations)
+  - [Removing Configurations](config.md#removing-configurations)
+  - [Configuration Paths](config.md#configuration-paths)
+
+- [CLI Components](cli.md) - CLI functionality
+  - [Module Structure](cli.md#module-structure)
+  - [Interactive Chat Module](cli.md#interactive-chat-module)
+  - [Formatters Module](cli.md#formatters-module)
+  - [Renderers Module](cli.md#renderers-module)
+  - [CLI Configuration Utilities](cli.md#cli-configuration-utilities)
+  - [Operation Modes](cli.md#operation-modes)
+
+- [CLI Configuration](cli_config.md) - Persistent CLI settings
+  - [Loading Configuration](cli_config.md#load_cli_config)
+  - [Setting Options](cli_config.md#set_cli_config_option)
+  - [Getting Options](cli_config.md#get_cli_config_option)
+  - [Removing Options](cli_config.md#unset_cli_config_option)
+  - [Applying Configuration](cli_config.md#apply_cli_config)
+  - [Available Options](cli_config.md#available-cli-configuration-options)
+
+## Quick Reference
+
+```python
+# Import core components
+from ngpt import NGPTClient, load_config
+
+# Import configuration utilities
+from ngpt.utils.config import (
+    load_configs,
+    get_config_path,
+    get_config_dir,
+    add_config_entry,
+    remove_config_entry
+)
+
+# Import CLI configuration utilities
+from ngpt.utils.cli_config import (
+    load_cli_config,
+    set_cli_config_option,
+    get_cli_config_option,
+    unset_cli_config_option,
+    apply_cli_config
+)
+
+# Import CLI module components
+from ngpt.cli.interactive import interactive_chat_session
+from ngpt.cli.formatters import prettify_markdown, ColoredHelpFormatter, COLORS
+from ngpt.cli.renderers import prettify_streaming_markdown, has_markdown_renderer
+
+# Import operation modes
+from ngpt.cli.modes.chat import chat_mode
+from ngpt.cli.modes.code import code_mode
+from ngpt.cli.modes.shell import shell_mode
+from ngpt.cli.modes.text import text_mode
+
+# Import version information
+from ngpt import __version__
+```
+
+For complete documentation on using these components, see the linked reference pages.