ngpt 3.4.5__tar.gz → 3.5.1__tar.gz

{ngpt-3.4.5 → ngpt-3.5.1}/CONTRIBUTING.md

@@ -28,15 +28,15 @@ Thank you for your interest in contributing to NGPT! This document provides guid
     - `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
       - `__init__.py` - Modes initialization
       - `chat.py` - Chat mode functionality
       - `code.py` - Code generation mode
       - `gitcommsg.py` - Git commit message generation
+      - `interactive.py` - Interactive mode implementation
+      - `rewrite.py` - Text rewriting mode
       - `shell.py` - Shell command generation
       - `text.py` - Text generation mode
-      - `rewrite.py` - Text rewriting mode
     - `renderers.py` - Output rendering logic (e.g., markdown)
     - `ui.py` - User interface elements (e.g., prompts, spinners)
   - `utils/` - Utility modules

{ngpt-3.4.5 → ngpt-3.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 3.4.5
+Version: 3.5.1
 Summary: Swiss army knife for LLMs: powerful CLI and interactive chatbot in one package. Seamlessly work with OpenAI, Ollama, Groq, Claude, Gemini, or any OpenAI-compatible API to generate code, craft git commits, rewrite text, and execute shell commands.
 Project-URL: Homepage, https://github.com/nazdridoy/ngpt
 Project-URL: Repository, https://github.com/nazdridoy/ngpt
@@ -28,12 +28,11 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
-Requires-Dist: duckduckgo-search>=3.0.0
+Requires-Dist: beautifulsoup4>=4.12.0
 Requires-Dist: prompt-toolkit>=3.0.0
 Requires-Dist: pyperclip>=1.8.0
 Requires-Dist: requests>=2.31.0
 Requires-Dist: rich>=10.0.0
-Requires-Dist: trafilatura>=1.6.0
 Description-Content-Type: text/markdown
 
 # nGPT
@@ -62,10 +61,10 @@ Description-Content-Type: text/markdown
 
 - ✅ **Versatile**: Powerful and easy-to-use CLI tool for various AI tasks
 - 🪶 **Lightweight**: Minimal dependencies with everything you need included
-- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, Gemini, and any compatible endpoint
+- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, Gemini, and any OpenAI-compatible endpoint
 - 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
 - 📊 **Streaming Responses**: Real-time output for better user experience
-- 🔍 **Web Search**: Enhance any model with contextual information from the web
+- 🔍 **Web Search**: Enhance any model with contextual information from the web, using advanced content extraction to identify the most relevant information from web pages
 - 📥 **Stdin Processing**: Process piped content by using `{}` placeholder in prompts
 - 🎨 **Markdown Rendering**: Beautiful formatting of markdown and code with syntax highlighting
 - ⚡ **Real-time Markdown**: Stream responses with live updating syntax highlighting and formatting
@@ -85,37 +84,47 @@ See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview/) for more
 
 
 ## Table of Contents
-- [Quick Start](#quick-start)
 - [Features](#features)
-- [Documentation](#documentation)
 - [Installation](#installation)
+- [Quick Start](#quick-start)
 - [Usage](#usage)
+  - [Command Line Options](#command-line-options)
   - [Documentation](https://nazdridoy.github.io/ngpt/)
-  - [CLI Tool](#as-a-cli-tool)
+- [Documentation](#documentation)
 - [Configuration](#configuration)
-  - [Command Line Options](#command-line-options)
+  - [API Key Setup](#api-key-setup)
+  - [OpenAI API Key](#openai-api-key)
+  - [Google Gemini API Key](#google-gemini-api-key)
   - [CLI Configuration](#cli-configuration)
   - [Interactive Configuration](#interactive-configuration)
   - [Configuration File](#configuration-file)
   - [Configuration Priority](#configuration-priority)
-  - [API Key Setup](#api-key-setup)
-  - [OpenAI API Key](#openai-api-key)
-  - [Google Gemini API Key](#google-gemini-api-key)
 - [Contributing](#contributing)
 - [License](#license)
 
-## Quick Start
+## Installation
 
 ```bash
-# Install with pip
+# Installation with pip
 pip install ngpt
 
-# Or install with uv (faster)
+# Or install with uv (faster installation)
 uv pip install ngpt
 
-# Or install globally as a CLI tool (recommended)
+# Or install globally as a CLI tool (recommended for command-line usage)
 uv tool install ngpt
 
+# Arch Linux: install from AUR
+paru -S ngpt
+```
+
+Requires Python 3.8 or newer.
+
+For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation/).
+
+## Quick Start
+
+```bash
 # Chat with default settings
 ngpt "Tell me about quantum computing"
 
@@ -200,58 +209,6 @@ ngpt --provider Groq "Explain quantum computing"
 # Compare outputs from different providers
 ngpt --provider OpenAI "Explain quantum physics" > openai_response.txt
 ngpt --provider Ollama "Explain quantum physics" > ollama_response.txt
-```
-
-For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
-
-## Documentation
-
-Comprehensive documentation, including usage guides and examples, is available at:
-
-**[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
-
-Key documentation sections:
-- [Installation Guide](https://nazdridoy.github.io/ngpt/installation/)
-- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/)
-- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/)
-- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic/)
-
-## Installation
-
-```bash
-# Installation with pip
-pip install ngpt
-
-# Or install with uv (faster installation)
-uv pip install ngpt
-
-# Or install globally as a CLI tool (recommended for command-line usage)
-uv tool install ngpt
-
-# Arch Linux: install from AUR
-paru -S ngpt
-```
-
-Requires Python 3.8 or newer.
-
-For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation/).
-
-## Usage
-
-### As a CLI Tool
-
-```bash
-# Basic chat (default mode)
-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 all API configurations
 ngpt --show-config --all
@@ -277,47 +234,16 @@ ngpt -s "list all files in current directory"
 # On Windows generates: dir
 # On Linux/macOS generates: ls -la
 
-# Generate clean code (using -c or --code flag)
-# Returns only code without markdown formatting or explanations
+# Generate code (using -c or --code flag)
 ngpt -c "create a python function that calculates fibonacci numbers"
 
 # Use multiline text editor for complex prompts (using -t or --text flag)
-# Opens an interactive editor with syntax highlighting and intuitive controls
 ngpt -t
 ```
 
-For more CLI examples and detailed usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
-
-## Configuration
-
-### API Key Setup
-
-#### OpenAI API Key
-1. Create an account at [OpenAI](https://platform.openai.com/)
-2. Navigate to API keys: https://platform.openai.com/api-keys
-3. Click "Create new secret key" and copy your API key
-4. Configure nGPT with your key:
-   ```bash
-   ngpt --config
-   # Enter provider: OpenAI
-   # Enter API key: your-openai-api-key
-   # Enter base URL: https://api.openai.com/v1/
-   # Enter model: gpt-3.5-turbo (or other model)
-   ```
+For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
 
-#### Google Gemini API Key
-1. Create or use an existing Google account
-2. Go to [Google AI Studio](https://aistudio.google.com/)
-3. Navigate to API keys in the left sidebar (or visit https://aistudio.google.com/app/apikey)
-4. Create an API key and copy it
-5. Configure nGPT with your key:
-   ```bash
-   ngpt --config
-   # Enter provider: Gemini
-   # Enter API key: your-gemini-api-key
-   # Enter base URL: https://generativelanguage.googleapis.com/v1beta/openai
-   # Enter model: gemini-2.0-flash
-   ```
+## Usage
 
 ### Command Line Options
 
@@ -326,8 +252,8 @@ For more CLI examples and detailed usage information, see the [CLI Usage Guide](
 usage: ngpt [-h] [-v] [--language LANGUAGE] [--config [CONFIG]] [--config-index CONFIG_INDEX] [--provider PROVIDER]
             [--remove] [--show-config] [--all] [--list-models] [--list-renderers] [--cli-config [COMMAND ...]]
             [--api-key API_KEY] [--base-url BASE_URL] [--model MODEL] [--web-search] [--temperature TEMPERATURE]
-            [--top_p TOP_P] [--max_tokens MAX_TOKENS] [--log [FILE]] [--preprompt PREPROMPT] [--no-stream] [--prettify]
-            [--stream-prettify] [--renderer {auto,rich,glow}] [--rec-chunk] [--diff [FILE]] [--chunk-size CHUNK_SIZE]
+            [--top_p TOP_P] [--max_tokens MAX_TOKENS] [--log [FILE]] [--preprompt PREPROMPT] [--no-stream | --prettify |
+            --stream-prettify] [--renderer {auto,rich,glow}] [--rec-chunk] [--diff [FILE]] [--chunk-size CHUNK_SIZE]
             [--analyses-chunk-size ANALYSES_CHUNK_SIZE] [--max-msg-lines MAX_MSG_LINES]
             [--max-recursion-depth MAX_RECURSION_DEPTH] [-i | -s | -c | -t | -p | -r | -g]
             [prompt]
@@ -346,12 +272,10 @@ options::
 
 Configuration Options::
 
---config [CONFIG]                   Path to a custom config file or, if no value provided, enter interactive
-                                    configuration mode to create a new config
+--config [CONFIG]                   Path to a custom config file or, if no value provided, enter interactive configuration mode to create a new config
 --config-index CONFIG_INDEX         Index of the configuration to use or edit (default: 0)
 --provider PROVIDER                 Provider name to identify the configuration to use
---remove                            Remove the configuration at the specified index (requires --config and
-                                    --config-index or --provider)
+--remove                            Remove the configuration at the specified index (requires --config and --config-index or --provider)
 --show-config                       Show the current configuration(s) and exit
 --all                               Show details for all configurations (requires --show-config)
 --list-models                       List all available models for the current configuration and exit
@@ -363,30 +287,28 @@ Global Options::
 --api-key API_KEY                   API key for the service
 --base-url BASE_URL                 Base URL for the API
 --model MODEL                       Model to use
---web-search                        Enable web search capability (Note: Your API endpoint must support this
-                                    feature)
+--web-search                        Enable web search capability using DuckDuckGo to enhance prompts with relevant information
 --temperature TEMPERATURE           Set temperature (controls randomness, default: 0.7)
 --top_p TOP_P                       Set top_p (controls diversity, default: 1.0)
 --max_tokens MAX_TOKENS             Set max response length in tokens
---log [FILE]                        Set filepath to log conversation to, or create a temporary log file if no path
-                                    provided
+--log [FILE]                        Set filepath to log conversation to, or create a temporary log file if no path provided
 --preprompt PREPROMPT               Set custom system prompt to control AI behavior
---no-stream                         Return the whole response without streaming
---prettify                          Render markdown responses and code with syntax highlighting and formatting
---stream-prettify                   Enable streaming with markdown rendering (automatically uses Rich renderer)
---renderer {auto,rich,glow}         Select which markdown renderer to use with --prettify (auto, rich, or glow)
+--renderer {auto,rich,glow}         Select which markdown renderer to use with --prettify or --stream-prettify (auto, rich, or glow)
+
+Output Display Options (mutually exclusive)::
+
+--no-stream                         Return the whole response without streaming or formatting
+--prettify                          Render complete response with markdown and code formatting (non-streaming)
+--stream-prettify                   Stream response with real-time markdown rendering (default)
 
 Git Commit Message Options::
 
 --rec-chunk                         Process large diffs in chunks with recursive analysis if needed
---diff [FILE]                       Use diff from specified file instead of staged changes. If used without a path,
-                                    uses the path from CLI config.
+--diff [FILE]                       Use diff from specified file instead of staged changes. If used without a path, uses the path from CLI config.
 --chunk-size CHUNK_SIZE             Number of lines per chunk when chunking is enabled (default: 200)
---analyses-chunk-size ANALYSES_CHUNK_SIZE
-                                    Number of lines per chunk when recursively chunking analyses (default: 200)
+--analyses-chunk-size ANALYSES_CHUNK_SIZE Number of lines per chunk when recursively chunking analyses (default: 200)
 --max-msg-lines MAX_MSG_LINES       Maximum number of lines in commit message before condensing (default: 20)
---max-recursion-depth MAX_RECURSION_DEPTH
-                                    Maximum recursion depth for commit message condensing (default: 3)
+--max-recursion-depth MAX_RECURSION_DEPTH Maximum recursion depth for commit message condensing (default: 3)
 
 Modes (mutually exclusive)::
 
@@ -394,15 +316,62 @@ Modes (mutually exclusive)::
 -s, --shell                         Generate and execute shell commands
 -c, --code                          Generate code
 -t, --text                          Enter multi-line text input (submit with Ctrl+D)
--p, --pipe                          Read from stdin and use content with prompt. Use {} in prompt as placeholder
-                                    for stdin content
+-p, --pipe                          Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content
 -r, --rewrite                       Rewrite text from stdin to be more natural while preserving tone and meaning
 -g, --gitcommsg                     Generate AI-powered git commit messages from staged changes or diff file
 ```
 
 > **Note**: For better visualization of conventional commit messages on GitHub, you can use the [GitHub Commit Labels](https://greasyfork.org/en/scripts/526153-github-commit-labels) userscript, which adds colorful labels to your commits.
 
-For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
+For a complete reference of all available options, detailed CLI examples and usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
+
+
+## Documentation
+
+Comprehensive documentation, including usage guides and examples, is available at:
+
+**[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
+
+Key documentation sections:
+- [Installation Guide](https://nazdridoy.github.io/ngpt/installation/)
+- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/)
+- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/)
+- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic/)
+- [Git Commit Message Guide](https://nazdridoy.github.io/ngpt/usage/gitcommsg/)
+
+
+## Configuration
+
+### API Key Setup
+
+#### OpenAI API Key
+1. Create an account at [OpenAI](https://platform.openai.com/)
+2. Navigate to API keys: https://platform.openai.com/api-keys
+3. Click "Create new secret key" and copy your API key
+4. Configure nGPT with your key:
+   ```bash
+   ngpt --config
+   # Enter provider: OpenAI
+   # Enter API key: your-openai-api-key
+   # Enter base URL: https://api.openai.com/v1/
+   # Enter model: gpt-3.5-turbo (or other model)
+   ```
+
+#### Google Gemini API Key
+1. Create or use an existing Google account
+2. Go to [Google AI Studio](https://aistudio.google.com/)
+3. Navigate to API keys in the left sidebar (or visit https://aistudio.google.com/app/apikey)
+4. Create an API key and copy it
+5. Configure nGPT with your key:
+   ```bash
+   ngpt --config
+   # Enter provider: Gemini
+   # Enter API key: your-gemini-api-key
+   # Enter base URL: https://generativelanguage.googleapis.com/v1beta/openai
+   # Enter model: gemini-2.0-flash
+   ```
+
+For more detailed information, refer to the [API Key Setup documentation](https://nazdridoy.github.io/ngpt/configuration/#api-key-setup).
 
 ### CLI Configuration
 

ngpt-3.5.1/PKGBUILD

@@ -0,0 +1,26 @@
+# Maintainer: nazdridoy <nazdridoy399@gmail.com>
+pkgname=ngpt
+pkgver=0.0.0  # Automatically updated by CI on release
+pkgrel=1
+pkgdesc="Swiss army knife for LLMs: powerful CLI and interactive chatbot in one package. Seamlessly work with OpenAI, Ollama, Groq, Claude, Gemini, or any OpenAI-compatible API to generate code, craft git commits, rewrite text, and execute shell commands."
+arch=('any')
+url="https://github.com/nazdridoy/ngpt"
+license=('MIT')
+depends=('python' 'python-requests>=2.31.0' 'python-rich>=10.0.0' 'python-prompt_toolkit>=3.0.0' 'python-pyperclip>=1.8.0' 'python-beautifulsoup4>=4.12.0')
+makedepends=('python-build' 'python-installer' 'python-wheel' 'python-hatchling')
+options=(!debug)
+source=("${pkgname}-${pkgver}.tar.gz::https://github.com/nazdridoy/${pkgname}/archive/v${pkgver}.tar.gz")
+sha256sums=('SKIP')  # Automatically updated by CI on release
+
+build() {
+  cd "$pkgname-$pkgver"
+  python -m build --wheel --no-isolation
+}
+
+package() {
+  cd "$pkgname-$pkgver"
+  python -m installer --destdir="$pkgdir" dist/*.whl
+  
+  install -Dm644 LICENSE "$pkgdir/usr/share/licenses/$pkgname/LICENSE"
+  install -Dm644 README.md "$pkgdir/usr/share/doc/$pkgname/README.md"
+}