ngpt 1.1.2__py3-none-any.whl → 1.1.3__py3-none-any.whl

ngpt/cli.py

@@ -35,11 +35,10 @@ def show_config_help():
     print("  3. Or set environment variables:")
     print("     - OPENAI_API_KEY")
     print("     - OPENAI_BASE_URL")
-    print("     - OPENAI_PROVIDER")
     print("     - OPENAI_MODEL")
     
     print("  4. Or provide command line arguments:")
-    print("     ngpt --api-key your-key --base-url https://api.example.com \"Your prompt\"")
+    print("     ngpt --api-key your-key --base-url https://api.example.com --model your-model \"Your prompt\"")
     
     print("  5. Use --config-index to specify which configuration to use:")
     print("     ngpt --config-index 1 \"Your prompt\"")

{ngpt-1.1.2.dist-info → ngpt-1.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 1.1.2
+Version: 1.1.3
 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
@@ -33,19 +33,51 @@ Description-Content-Type: text/markdown
 
 # nGPT
 
+[![PyPI version](https://img.shields.io/pypi/v/ngpt.svg)](https://pypi.org/project/ngpt/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Python Versions](https://img.shields.io/pypi/pyversions/ngpt.svg)](https://pypi.org/project/ngpt/)
+
 A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints.
 
+## Table of Contents
+- [Quick Start](#quick-start)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+  - [CLI Tool](#as-a-cli-tool)
+  - [Python Library](#as-a-library)
+- [Configuration](#configuration)
+  - [Command Line Options](#command-line-options)
+  - [Configuration File](#configuration-file)
+  - [Configuration Priority](#configuration-priority)
+- [License](#license)
+
+## Quick Start
+
+```bash
+# Install
+pip install ngpt
+
+# Chat with default settings
+ngpt "Tell me about quantum computing"
+
+# Generate code
+ngpt --code "function to calculate the Fibonacci sequence"
+
+# Generate and execute shell commands
+ngpt --shell "list all files in the current directory"
+```
+
 ## Features
 
-- Dual mode: Use as a CLI tool or import as a library
-- Minimal dependencies
-- Customizable API endpoints and providers
-- Streaming responses
-- Web search capability (supported by compatible API endpoints)
-- Cross-platform configuration system
-- Experimental features:
-  - Shell command generation and execution (OS-aware)
-  - Code generation with clean output
+- ✅ **Dual Mode**: Use as a CLI tool or import as a Python library
+- 🪶 **Lightweight**: Minimal dependencies (just `requests`)
+- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, and any compatible endpoint
+- 📊 **Streaming Responses**: Real-time output for better user experience
+- 🔍 **Web Search**: Integrated with compatible API endpoints
+- ⚙️ **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
 
 ## Installation
 
@@ -53,6 +85,8 @@ A lightweight Python CLI and library for interacting with OpenAI-compatible APIs
 pip install ngpt
 ```
 
+Requires Python 3.8 or newer.
+
 ## Usage
 
 ### As a CLI Tool
@@ -71,15 +105,19 @@ ngpt --show-config
 ngpt --show-config --all
 
 # With custom options
-ngpt --api-key your-key --base-url http://your-endpoint "Hello"
+ngpt --api-key your-key --base-url http://your-endpoint --model your-model "Hello"
 
 # Enable web search (if your API endpoint supports it)
 ngpt --web-search "What's the latest news about AI?"
 
 # Generate and execute shell commands (using -s or --shell flag)
+# OS-aware: generates appropriate commands for Windows, macOS, or Linux
 ngpt -s "list all files in current directory"
+# On Windows generates: dir
+# On Linux/macOS generates: ls -la
 
-# Generate code (using -c or --code flag)
+# Generate clean code (using -c or --code flag)
+# Returns only code without markdown formatting or explanations
 ngpt -c "create a python function that calculates fibonacci numbers"
 ```
 
@@ -115,20 +153,51 @@ command = client.generate_shell_command("list all files")
 code = client.generate_code("create a python function that calculates fibonacci numbers")
 ```
 
+#### Advanced Library Usage
+
+```python
+# Stream responses
+for chunk in client.chat("Write a poem about Python", stream=True):
+    print(chunk, end="", flush=True)
+
+# Customize system prompt
+response = client.chat(
+    "Explain quantum computing",
+    system_prompt="You are a quantum physics professor. Explain complex concepts simply."
+)
+
+# OS-aware shell commands
+# Automatically generates appropriate commands for the current OS
+command = client.generate_shell_command("find large files")
+import subprocess
+result = subprocess.run(command, shell=True, capture_output=True, text=True)
+print(result.stdout)
+
+# Clean code generation
+# Returns only code without markdown or explanations
+code = client.generate_code("function that converts Celsius to Fahrenheit")
+print(code)
+```
+
 ## Configuration
 
 ### Command Line Options
 
 You can configure the client using the following options:
 
-- `--api-key`: API key for the service
-- `--base-url`: Base URL for the API
-- `--model`: Model to use
-- `--web-search`: Enable web search capability (Note: Your API endpoint must support this feature)
-- `--config`: Path to a custom configuration file
-- `--config-index`: Index of the configuration to use from the config file (default: 0)
-- `--show-config`: Show configuration details and exit.
-- `--all`: Used with `--show-config` to display details for all configurations.
+| Option | Description |
+|--------|-------------|
+| `--api-key` | API key for the service |
+| `--base-url` | Base URL for the API |
+| `--model` | Model to use |
+| `--web-search` | Enable web search capability |
+| `--config` | Path to a custom configuration file |
+| `--config-index` | Index of the configuration to use (default: 0) |
+| `--show-config` | Show configuration details and exit |
+| `--all` | Used with `--show-config` to display all configurations |
+| `-s, --shell` | Generate and execute shell commands |
+| `-c, --code` | Generate clean code output |
+| `-v, --version` | Show version information |
 
 ### Configuration File
 
@@ -173,20 +242,6 @@ nGPT determines configuration values in the following order (highest priority fi
 3. Configuration file (selected by `--config-index`, defaults to index 0)
 4. Default values
 
-## Special Features
-
-### OS-Aware Shell Commands
-
-Shell command generation is OS-aware, providing appropriate commands for your operating system (Windows, macOS, or Linux) and shell type (bash, powershell, etc.).
-
-### Clean Code Generation
-
-Code generation uses an improved prompt that ensures only clean code is returned, without markdown formatting or unnecessary explanations.
-
-## Implementation Notes
-
-This library uses direct HTTP requests instead of the OpenAI client library, allowing it to work with custom API endpoints that support additional parameters like `provider` and `web_search`. All parameters are sent directly in the request body, similar to the format shown in the curl example.
-
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

ngpt-1.1.3.dist-info/RECORD

@@ -0,0 +1,9 @@
+ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
+ngpt/cli.py,sha256=_nu7eY76_y4KQ59cKC91VijVvzSASAaSJI1FFfJ9l04,10655
+ngpt/client.py,sha256=j7UCX_nkFRQJ_15ynxdu0Tj3HxxsI7Ll4__HdTbD7zE,10400
+ngpt/config.py,sha256=JWCEp1aMq96i8owi4z_poKigaA_s2UTfzY0fjBM5MoQ,5295
+ngpt-1.1.3.dist-info/METADATA,sha256=QTx1AssxeYEUlGOUpDdvssIVlvh2Xl8tqp9-a4wXwWs,8002
+ngpt-1.1.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-1.1.3.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
+ngpt-1.1.3.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-1.1.3.dist-info/RECORD,,

ngpt-1.1.2.dist-info/RECORD

@@ -1,9 +0,0 @@
-ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
-ngpt/cli.py,sha256=LIXr3NWgdsrddbcYmOxRsWYbNeKNILJZWnIkO7iCSzc,10672
-ngpt/client.py,sha256=j7UCX_nkFRQJ_15ynxdu0Tj3HxxsI7Ll4__HdTbD7zE,10400
-ngpt/config.py,sha256=JWCEp1aMq96i8owi4z_poKigaA_s2UTfzY0fjBM5MoQ,5295
-ngpt-1.1.2.dist-info/METADATA,sha256=GBuRNy3W9JGtdH4NMHriYVOQ2KClYlczYIjmyGcK0xM,6299
-ngpt-1.1.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-1.1.2.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
-ngpt-1.1.2.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-1.1.2.dist-info/RECORD,,