ngpt 2.5.0__tar.gz → 2.5.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.5.0
+Version: 2.5.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
@@ -30,7 +30,6 @@ 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-2.5.0 → ngpt-2.5.1}/docs/api/client.md

@@ -49,7 +49,7 @@ client = NGPTClient(
 
 ## Chat Method
 
-The primary method for interacting with the AI model.
+The main method for interacting with the AI model.
 
 ```python
 response = client.chat(
@@ -57,8 +57,10 @@ response = client.chat(
     stream: bool = True,
     temperature: float = 0.7,
     max_tokens: Optional[int] = None,
+    top_p: float = 1.0,
     messages: Optional[List[Dict[str, str]]] = None,
     web_search: bool = False,
+    markdown_format: bool = False,
     **kwargs
 ) -> str
 ```
@@ -69,49 +71,55 @@ response = client.chat(
 |-----------|------|---------|-------------|
 | `prompt` | `str` | Required | The user's message |
 | `stream` | `bool` | `True` | Whether to stream the response |
-| `temperature` | `float` | `0.7` | Controls randomness in the response (0.0-1.0) |
+| `temperature` | `float` | `0.7` | Controls randomness in the response |
 | `max_tokens` | `Optional[int]` | `None` | Maximum number of tokens to generate |
-| `messages` | `Optional[List[Dict[str, str]]]` | `None` | Optional list of message objects for conversation history |
+| `top_p` | `float` | `1.0` | Controls diversity via nucleus sampling |
+| `messages` | `Optional[List[Dict[str, str]]]` | `None` | Optional list of message objects to override default behavior |
 | `web_search` | `bool` | `False` | Whether to enable web search capability |
-| `**kwargs` | | | Additional arguments to pass to the API |
+| `markdown_format` | `bool` | `False` | If True, allows markdown formatting in responses |
+| `**kwargs` | `Any` | `{}` | Additional arguments to pass to the API |
 
 ### Returns
 
-- When `stream=False`: A string containing the complete response
-- When `stream=True`: A generator yielding response chunks that can be iterated over
+If `stream=True`, returns chunks of the response as they are generated.
+If `stream=False`, returns the complete response as a string.
 
 ### Examples
 
 ```python
-# Basic chat with streaming
-for chunk in client.chat("Tell me about quantum computing"):
-    print(chunk, end="", flush=True)
-print()  # Final newline
+# Basic usage
+response = client.chat("Tell me about quantum computing")
+print(response)
 
 # Without streaming
 response = client.chat("Tell me about quantum computing", stream=False)
 print(response)
 
+# With custom temperature (higher = more creative, lower = more deterministic)
+response = client.chat("Write a poem about nature", temperature=0.9)
+print(response)
+
+# With token limit
+response = client.chat("Explain the history of AI", max_tokens=100)
+print(response)
+
 # With conversation history
 messages = [
     {"role": "system", "content": "You are a helpful assistant."},
     {"role": "user", "content": "Hello, who are you?"},
-    {"role": "assistant", "content": "I'm an AI assistant. How can I help you today?"},
-    {"role": "user", "content": "Tell me about yourself"}
+    {"role": "assistant", "content": "I'm an AI assistant created to help answer questions and provide information."},
+    {"role": "user", "content": "Tell me more about yourself"}
 ]
 response = client.chat("", messages=messages)
 print(response)
 
-# With web search
-response = client.chat("What's the latest news about AI?", web_search=True)
+# Enable web search capability (if API supports it)
+response = client.chat("What are the latest developments in quantum computing?", web_search=True)
 print(response)
 
-# With temperature control
-response = client.chat("Write a creative story", temperature=0.9)  # More random
-response = client.chat("Explain how a CPU works", temperature=0.2)  # More focused
-
-# With token limit
-response = client.chat("Summarize this concept", max_tokens=100)
+# Enable markdown formatting for rich text responses
+response = client.chat("Create a table comparing programming languages", markdown_format=True)
+print(response)  # Response will contain markdown formatting like tables, code blocks, etc.
 ```
 
 ## Generate Shell Command
@@ -157,13 +165,17 @@ command = client.generate_shell_command(
 
 ## Generate Code
 
-Generates clean code based on the prompt, without markdown formatting or explanations.
+Generates code based on the prompt.
 
 ```python
 code = client.generate_code(
     prompt: str,
     language: str = "python",
-    web_search: bool = False
+    web_search: bool = False,
+    temperature: float = 0.4,
+    top_p: float = 0.95,
+    max_tokens: Optional[int] = None,
+    markdown_format: bool = False
 ) -> str
 ```
 
@@ -174,15 +186,19 @@ code = client.generate_code(
 | `prompt` | `str` | Required | Description of the code to generate |
 | `language` | `str` | `"python"` | Programming language to generate code in |
 | `web_search` | `bool` | `False` | Whether to enable web search capability |
+| `temperature` | `float` | `0.4` | Controls randomness in the response |
+| `top_p` | `float` | `0.95` | Controls diversity via nucleus sampling |
+| `max_tokens` | `Optional[int]` | `None` | Maximum number of tokens to generate |
+| `markdown_format` | `bool` | `False` | If True, returns code with markdown formatting including syntax highlighting |
 
 ### Returns
 
-A string containing the generated code without any markdown formatting or explanations.
+A string containing the generated code. If `markdown_format` is `False`, returns plain text code. If `markdown_format` is `True`, returns code formatted in markdown with appropriate syntax highlighting.
 
 ### Examples
 
 ```python
-# Generate Python code (default)
+# Generate Python code (default, plain text)
 python_code = client.generate_code("function to calculate fibonacci numbers")
 print(python_code)
 
@@ -193,6 +209,15 @@ js_code = client.generate_code(
 )
 print(js_code)
 
+# Generate code with markdown formatting for documentation or display
+markdown_code = client.generate_code(
+    "class that implements a binary search tree",
+    language="python",
+    markdown_format=True
+)
+# This will output code wrapped in markdown code blocks with syntax highlighting
+print(markdown_code)
+
 # Generate code with web search for latest best practices
 react_code = client.generate_code(
     "create a React component that fetches and displays data from an API",

{ngpt-2.5.0 → ngpt-2.5.1}/docs/usage/cli_usage.md

@@ -151,7 +151,7 @@ Display markdown responses with beautiful formatting and syntax highlighting:
 ngpt --prettify "Explain markdown syntax with examples"
 ```
 
-This renders the AI's response with proper markdown formatting, including:
+This instructs the AI to generate properly formatted markdown responses, which are then rendered with appropriate formatting, including:
 - Syntax highlighting for code blocks
 - Proper rendering of tables
 - Formatted headers, lists, and other markdown elements
@@ -175,6 +175,8 @@ Combine with code generation for syntax-highlighted code:
 ngpt -c --prettify "function to calculate the Fibonacci sequence"
 ```
 
+When using `--prettify` with code generation, the AI will output code in markdown format with proper syntax highlighting based on the language.
+
 See available renderers on your system:
 
 ```bash

{ngpt-2.5.0 → ngpt-2.5.1}/ngpt/cli.py

@@ -553,6 +553,14 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
     
     # Initialize conversation history
     system_prompt = preprompt if preprompt else "You are a helpful assistant."
+    
+    # Add markdown formatting instruction to system prompt if prettify is enabled
+    if prettify:
+        if system_prompt:
+            system_prompt += " You can use markdown formatting in your responses where appropriate."
+        else:
+            system_prompt = "You are a helpful assistant. You can use markdown formatting in your responses where appropriate."
+    
     conversation = []
     system_message = {"role": "system", "content": system_prompt}
     conversation.append(system_message)
@@ -681,7 +689,8 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
                 web_search=web_search,
                 temperature=temperature,
                 top_p=top_p,
-                max_tokens=max_tokens
+                max_tokens=max_tokens,
+                markdown_format=prettify
             )
             
             # Add AI response to conversation history
@@ -1091,13 +1100,12 @@ def main():
                 
             generated_code = client.generate_code(prompt, args.language, web_search=args.web_search,
                                               temperature=args.temperature, top_p=args.top_p,
-                                              max_tokens=args.max_tokens)
+                                              max_tokens=args.max_tokens,
+                                              markdown_format=args.prettify)
             if generated_code:
                 if args.prettify:
-                    # Format code as markdown with proper syntax highlighting
-                    markdown_code = f"```{args.language}\n{generated_code}\n```"
                     print("\nGenerated code:")
-                    prettify_markdown(markdown_code, args.renderer)
+                    prettify_markdown(generated_code, args.renderer)
                 else:
                     print(f"\nGenerated code:\n{generated_code}")
             
@@ -1227,7 +1235,8 @@ def main():
                 
             response = client.chat(prompt, stream=should_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_tokens, messages=messages)
+                               max_tokens=args.max_tokens, messages=messages,
+                               markdown_format=args.prettify)
             
             # Handle non-stream response (either because no_stream was set or prettify forced it)
             if (args.no_stream or args.prettify) and response:
@@ -1265,7 +1274,8 @@ def main():
                 
             response = client.chat(prompt, stream=should_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_tokens, messages=messages)
+                               max_tokens=args.max_tokens, messages=messages,
+                               markdown_format=args.prettify)
             
             # Handle non-stream response (either because no_stream was set or prettify forced it)
             if (args.no_stream or args.prettify) and response:

{ngpt-2.5.0 → ngpt-2.5.1}/ngpt/client.py

@@ -33,6 +33,7 @@ class NGPTClient:
         top_p: float = 1.0,
         messages: Optional[List[Dict[str, str]]] = None,
         web_search: bool = False,
+        markdown_format: bool = False,
         **kwargs
     ) -> str:
         """
@@ -46,6 +47,7 @@ class NGPTClient:
             top_p: Controls diversity via nucleus sampling
             messages: Optional list of message objects to override default behavior
             web_search: Whether to enable web search capability
+            markdown_format: If True, allow markdown-formatted responses, otherwise plain text
             **kwargs: Additional arguments to pass to the API
             
         Returns:
@@ -56,7 +58,11 @@ class NGPTClient:
             return ""
             
         if messages is None:
-            messages = [{"role": "user", "content": prompt}]
+            if markdown_format:
+                system_message = {"role": "system", "content": "You can use markdown formatting in your responses where appropriate."}
+                messages = [system_message, {"role": "user", "content": prompt}]
+            else:
+                messages = [{"role": "user", "content": prompt}]
         
         # Prepare API parameters
         payload = {
@@ -241,7 +247,8 @@ Command:"""
         web_search: bool = False,
         temperature: float = 0.4,
         top_p: float = 0.95,
-        max_tokens: Optional[int] = None
+        max_tokens: Optional[int] = None,
+        markdown_format: bool = False
     ) -> str:
         """
         Generate code based on the prompt.
@@ -253,6 +260,7 @@ Command:"""
             temperature: Controls randomness in the response
             top_p: Controls diversity via nucleus sampling
             max_tokens: Maximum number of tokens to generate
+            markdown_format: If True, request markdown-formatted code, otherwise plain text
             
         Returns:
             The generated code
@@ -262,7 +270,18 @@ Command:"""
             print("Error: API key is not set. Please configure your API key in the config file or provide it with --api-key.")
             return ""
             
-        system_prompt = f"""Your Role: Provide only code as output without any description.
+        if markdown_format:
+            system_prompt = f"""Your Role: Provide only code as output without any description with proper markdown formatting.
+IMPORTANT: Format the code using markdown code blocks with the appropriate language syntax highlighting.
+IMPORTANT: You must use markdown code blocks. with ```{language}
+If there is a lack of details, provide most logical solution. You are not allowed to ask for more details.
+Ignore any potential risk of errors or confusion.
+
+Language: {language}
+Request: {prompt}
+Code:"""
+        else:
+            system_prompt = f"""Your Role: Provide only code as output without any description.
 IMPORTANT: Provide only plain text without Markdown formatting.
 IMPORTANT: Do not include markdown formatting.
 If there is a lack of details, provide most logical solution. You are not allowed to ask for more details.

{ngpt-2.5.0 → ngpt-2.5.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ngpt"
-version = "2.5.0"
+version = "2.5.1"
 description = "A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints."
 authors = [
     {name = "nazDridoy", email = "nazdridoy399@gmail.com"},
@@ -8,7 +8,6 @@ authors = [
 dependencies = [
     "requests>=2.31.0",
     "prompt_toolkit>=3.0.0",
-    "rich>=14.0.0",
 ]
 requires-python = ">=3.8"
 readme = "README.md"
@@ -36,7 +35,9 @@ classifiers = [
 ]
 
 [project.optional-dependencies]
-prettify = ["rich>=10.0.0"]
+prettify = [
+    "rich>=10.0.0",
+]
 
 [project.urls]
 "Homepage" = "https://github.com/nazdridoy/ngpt"

{ngpt-2.5.0 → ngpt-2.5.1}/uv.lock

@@ -134,12 +134,11 @@ wheels = [
 
 [[package]]
 name = "ngpt"
-version = "2.5.0"
+version = "2.5.1"
 source = { editable = "." }
 dependencies = [
     { name = "prompt-toolkit" },
     { name = "requests" },
-    { name = "rich" },
 ]
 
 [package.optional-dependencies]
@@ -151,7 +150,6 @@ prettify = [
 requires-dist = [
     { name = "prompt-toolkit", specifier = ">=3.0.0" },
     { name = "requests", specifier = ">=2.31.0" },
-    { name = "rich", specifier = ">=14.0.0" },
     { name = "rich", marker = "extra == 'prettify'", specifier = ">=10.0.0" },
 ]
 provides-extras = ["prettify"]