ngpt 2.16.0__py3-none-any.whl → 2.16.2__py3-none-any.whl

ngpt/cli/modes/rewrite.py

@@ -17,6 +17,15 @@ PRESERVATION RULES (HIGHEST PRIORITY):
 4. Respect the style of expression when intentional
 5. Retain technical terminology, jargon, and domain-specific language
 6. Keep all facts, data points, quotes, and references exactly as provided
+7. Preserve all @ mentions (like @username) exactly as written
+
+FORMAT PRESERVATION:
+1. Maintain all paragraph breaks and section structures
+2. Preserve formatting of lists, bullet points, and numbering
+3. Keep code blocks (```) exactly as they appear with no changes to code
+4. Respect all markdown formatting (bold, italic, headers, etc.)
+5. Preserve URLs, email addresses, file paths, variables, and @ mentions exactly
+6. Maintain the structure of tables and other special formats
 
 IMPROVEMENT FOCUS:
 1. Fix grammar, spelling, and punctuation errors
@@ -28,14 +37,6 @@ IMPROVEMENT FOCUS:
 7. Convert passive voice to active when appropriate
 8. Remove redundancies, filler words, and unnecessary repetition
 
-FORMAT PRESERVATION:
-1. Maintain all paragraph breaks and section structures
-2. Preserve formatting of lists, bullet points, and numbering
-3. Keep code blocks (```) exactly as they appear with no changes to code
-4. Respect all markdown formatting (bold, italic, headers, etc.)
-5. Preserve URLs, email addresses, file paths, and variables exactly
-6. Maintain the structure of tables and other special formats
-
 CONTENT-SPECIFIC GUIDANCE:
 - For technical content: Prioritize precision and clarity over stylistic changes
 - For casual text: Maintain conversational flow and personality
@@ -50,6 +51,7 @@ STRICTLY AVOID:
 5. Explaining what you changed (just provide the improved text)
 6. Altering the meaning of any sentence, even slightly
 7. Changing domain-specific terminology or jargon to general terms
+8. Modifying or removing @ mentions, hashtags, or issue references (like #123)
 
 OUTPUT INSTRUCTION:
 Provide ONLY the rewritten text with no explanations, comments, or meta-text.

{ngpt-2.16.0.dist-info → ngpt-2.16.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.16.0
+Version: 2.16.2
 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
@@ -41,7 +41,7 @@ Description-Content-Type: text/markdown
 [![Python Versions](https://img.shields.io/pypi/pyversions/ngpt.svg)](https://pypi.org/project/ngpt/)
 [![Documentation](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://nazdridoy.github.io/ngpt/)
 
-A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints.
+A versatile Python LLM client that functions as a CLI utility, library, and development framework. Supports multiple providers (OpenAI, Ollama, Groq, Claude) with features including interactive chat, code generation, shell command execution, git commit messages generation, and markdown rendering.
 
 ![2025-04-23_16-18-01](https://github.com/user-attachments/assets/b8e58926-5165-4352-b48b-9f4a982da86e)
 
@@ -62,6 +62,9 @@ A lightweight Python CLI and library for interacting with OpenAI-compatible APIs
   - [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)
 
@@ -397,6 +400,35 @@ For detailed information about building CLI tools with nGPT, see the [CLI Framew
 
 ## 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
+   ```
+
 ### Command Line Options
 
 You can configure nGPT using the following options:

{ngpt-2.16.0.dist-info → ngpt-2.16.2.dist-info}/RECORD

@@ -13,15 +13,15 @@ ngpt/cli/modes/__init__.py,sha256=R3aO662RIzWEOvr3moTrEI8Tpg0zDDyMGGh1-OxiRgM,28
 ngpt/cli/modes/chat.py,sha256=4a5EgM_5A1zCSrLrjgQMDnBwIHd1Rnu5_BjSKSm7p24,4255
 ngpt/cli/modes/code.py,sha256=RjOAj7BDO5vLUdIPkUfPtyIkI_W6qEHsZvYh-sIdVaM,4293
 ngpt/cli/modes/gitcommsg.py,sha256=Bhgg9UArrfRUwosgVlNLUB7i1B8j-1ngpkmCm5iZBkM,46786
-ngpt/cli/modes/rewrite.py,sha256=Zb0PFvWRKXs4xJCF3GEdYc-LSmy6qRszz8-QJuldHc0,8595
+ngpt/cli/modes/rewrite.py,sha256=Z-jSGodMoOJps0jL3sLaJaFXCxk4XKYQkrVb7wwxm20,8749
 ngpt/cli/modes/shell.py,sha256=lF9f7w-0bl_FdZl-WJnZuV736BKrWQtrwoKr3ejPXFE,2682
 ngpt/cli/modes/text.py,sha256=ncYnfLFMdTPuHiOvAaHNiOWhox6GF6S-2fTwMIrAz-g,3140
 ngpt/utils/__init__.py,sha256=E46suk2-QgYBI0Qrs6WXOajOUOebF3ETAFY7ah8DTWs,942
 ngpt/utils/cli_config.py,sha256=tQxR3a2iXyc5TfRBPQHSUXPInO2dv_zTPGn04eWfmoo,11285
 ngpt/utils/config.py,sha256=WYOk_b1eiYjo6hpV3pfXr2RjqhOnmKqwZwKid1T41I4,10363
 ngpt/utils/log.py,sha256=f1jg2iFo35PAmsarH8FVL_62plq4VXH0Mu2QiP6RJGw,15934
-ngpt-2.16.0.dist-info/METADATA,sha256=T5OEQ8AtdLDyct1rLRKElBBUCZgehw1iesLMhZrcnKA,23523
-ngpt-2.16.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-2.16.0.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
-ngpt-2.16.0.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-2.16.0.dist-info/RECORD,,
+ngpt-2.16.2.dist-info/METADATA,sha256=L4dWfiuOySmzoJcmePrb7CGLU1f73SGNg0y3dzSBZo4,24767
+ngpt-2.16.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-2.16.2.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
+ngpt-2.16.2.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-2.16.2.dist-info/RECORD,,