Add gpt4free based providers (#6) (#14)

Simatwa · Simatwa · commit f78f9649b791 · 2024-01-19T03:00:12.000+03:00
diff --git a/.gitignore b/.gitignore
@@ -163,4 +163,5 @@ cython_debug/
 *test.py
 *recons
 README.md
-*.txt
+*.txt
+test_working_models.py
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -186,4 +186,62 @@ Assume role of the LLM and give your response.*
 
 - Combine both of piped and explicitly issued prompt #13
 - Support piping input in Windows. #13
-- Placeholder for piped input `{{stream}}` and copied text `{{copied}}`. 
+- Placeholder for piped input `{{stream}}` and copied text `{{copied}}`. 
+
+## v0.3.1
+
+**What's new?**
+
+<details>
+
+<summary>
+
+41 New models. Thanks to [gpt4free](https://github.com/xtekky/gpt4free).
+
+</summary>
+
+ - AiChatOnline
+ - Aura
+ - Bard
+ - Bing
+ - ChatBase
+ - ChatForAi
+ - Chatgpt4Online
+ - ChatgptAi
+ - ChatgptDemo
+ - ChatgptNext
+ - Chatxyz
+ - DeepInfra
+ - FakeGpt
+ - FreeChatgpt
+ - GPTalk
+ - GeekGpt
+ - GeminiProChat
+ - Gpt6
+ - GptChatly
+ - GptForLove
+ - GptGo
+ - GptTalkRu
+ - Hashnode
+ - HuggingChat
+ - Koala
+ - Liaobots
+ - Llama2
+ - MyShell
+ - OnlineGpt
+ - OpenaiChat
+ - PerplexityAi
+ - Phind
+ - Pi
+ - Poe
+ - Raycast
+ - TalkAi
+ - Theb
+ - ThebApi
+ - You
+ - Yqcloud
+
+</details>
+
+- **Aura** is the default provider
+- Other minor fixes.
diff --git a/docs/README.md b/docs/README.md
@@ -8,7 +8,7 @@
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml"><img src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-test.yml/badge.svg" alt="Python Test"/></a>
 -->
 <a href="https://github.com/Simatwa/python-tgpt/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/static/v1?logo=GPL&color=Blue&message=MIT&label=License"/></a>
-<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=0.3.0&color=green"/></a>
+<a href="https://pypi.org/project/python-tgpt"><img alt="PyPi" src="https://img.shields.io/static/v1?logo=pypi&label=Pypi&message=0.3.1&color=green"/></a>
 <a href="https://github.com/psf/black"><img alt="Black" src="https://img.shields.io/static/v1?logo=Black&label=Code-style&message=Black"/></a>
 <a href="#"><img alt="Passing" src="https://img.shields.io/static/v1?logo=Docs&label=Docs&message=Passing&color=green"/></a>
 <a href="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml"><img alt="Python Package flow" src="https://github.com/Simatwa/python-tgpt/actions/workflows/python-package.yml/badge.svg?branch=master"/></a>
@@ -40,7 +40,7 @@ python-tgpt
 >>> 
 ```
 
-This project enables seamless interaction with free LLMs without requiring an API Key.
+This project enables seamless interaction with over **45 free LLMs** without requiring an API Key.
 
 The name *python-tgpt* draws inspiration from its parent project [tgpt](https://github.com/aandrew-me/tgpt), which operates on [Golang](https://go.dev/). Through this Python adaptation, users can effortlessly engage with a number of free LLMs available as well as OpenAI's Chapytgpt models, fostering a smoother AI interaction experience.
 
@@ -55,7 +55,7 @@ The name *python-tgpt* draws inspiration from its parent project [tgpt](https://
 - 🚀 Ready to use (No API key required)
 - ⛓️ Chained requests via proxy
 - 🤖 Pass [awesome-chapytgpt prompts](https://github.com/f/awesome-chapytgpt-prompts) easily
-- 🧠 Multiple LLM providers
+- 🧠 Multiple LLM providers - **45+**
 
 ## Providers
 
@@ -69,6 +69,57 @@ These are simply the hosts of the LLMs, which include:
 6. [WebChatGPT](https://github.com/Simatwa/WebChatGPT) - **OpenAI** *(Session ID required)*
 7. [Bard](https://github.com/acheong08/bard) - **Google** *(Session ID required)*
 
+<details>
+
+<summary>
+
++ 41 Other models proudly offered by [gpt4free](https://github.com/xtekky/gpt4free).
+
+</summary>
+
+ - AiChatOnline
+ - Aura
+ - Bard
+ - Bing
+ - ChatBase
+ - ChatForAi
+ - Chatgpt4Online
+ - ChatgptAi
+ - ChatgptDemo
+ - ChatgptNext
+ - Chatxyz
+ - DeepInfra
+ - FakeGpt
+ - FreeChatgpt
+ - GPTalk
+ - GeekGpt
+ - GeminiProChat
+ - Gpt6
+ - GptChatly
+ - GptForLove
+ - GptGo
+ - GptTalkRu
+ - Hashnode
+ - HuggingChat
+ - Koala
+ - Liaobots
+ - Llama2
+ - MyShell
+ - OnlineGpt
+ - OpenaiChat
+ - PerplexityAi
+ - Phind
+ - Pi
+ - Poe
+ - Raycast
+ - TalkAi
+ - Theb
+ - ThebApi
+ - You
+ - Yqcloud
+
+</details>
+
 ## Prerequisites
 
 - [x] [Python>=3.9](https://python.org) *(Optional)*
@@ -283,6 +334,25 @@ print(bot.chat("<Your-prompt>"))
 </details>
 
 
+</details>
+
+<details>
+
+<summary>
+
+Gpt4free providers
+
+</summary>
+
+```python
+import pytgpt.gpt4free as gpt4free
+bot = gpt4free.GPT4FREE(provider="Aura")
+print(bot.chat("<Your-prompt>"))
+```
+
+</details>
+
+
 </details>
 
 <details>
@@ -312,7 +382,7 @@ bot = koboldai.KOBOLDAI(is_conversation=False)
 
 Utilize the `--disable-conversation` flag in the console to achieve the same functionality.
 
-> **Warning** : **Bard** and **WebChatGPT** autohandles context due to the obvious reason; the `is_conversation` parameter is not necessary at all hence not required when initializing the respective classes.
+> **Warning** : **Bard** and **WebChatGPT** autohandles context due to the obvious reason; the `is_conversation` parameter is not necessary at all hence not required when initializing the respective classes. Also be informed that majority of providers offered by *gpt4free* requires *Google Chrome* inorder to function.
 
 ### Advanced Usage of Placeholders
 
@@ -337,4 +407,5 @@ For more usage info run `$ pytgpt --help`
 ## Acknowledgements
 
 1. [x] [tgpt](https://github.com/aandrew-me/tgpt)
-2. [x] You
+2. [x] [gpt4free](https://github.com/xtekky/gpt4free)
+3. [x] You
diff --git a/requirements.txt b/requirements.txt
@@ -6,4 +6,5 @@ pyperclip==1.8.2
 appdirs==1.4.4
 webchatgpt==0.2.7
 GoogleBard==1.4.0
-colorama==0.4.6
+colorama==0.4.6
+g4f==0.2.0.3
diff --git a/setup.py b/setup.py
@@ -14,7 +14,7 @@
 
 setup(
     name="python-tgpt",
-    version="0.3.0",
+    version="0.3.1",
     license="MIT",
     author="Smartwa",
     maintainer="Smartwa",
@@ -46,6 +46,7 @@
         "webchatgpt==0.2.7",
         "GoogleBard==1.4.0",
         "colorama==0.4.6",
+        "g4f==0.2.0.3",
     ],
     python_requires=">=3.9",
     keywords=[
diff --git a/src/pytgpt/__init__.py b/src/pytgpt/__init__.py
@@ -1,10 +1,53 @@
 from .utils import appdir
 
-__version__ = "0.3.0"
+__version__ = "0.3.1"
 __author__ = "Smartwa"
 __repo__ = "https://github.com/Simatwa/python-tgpt"
 
-available_providers = ["leo", "openai", "fakeopen", "opengpt", "koboldai", "bard"]
+gpt4free_providers = [
+    "AItianhuSpace",
+    "AiChatOnline",
+    "Aura",
+    "Bard",
+    "Bing",
+    "ChatBase",
+    "ChatForAi",
+    "Chatgpt4Online",
+    "ChatgptAi",
+    "ChatgptDemo",
+    "ChatgptNext",
+    "Chatxyz",
+    "DeepInfra",
+    "FakeGpt",
+    "FreeChatgpt",
+    "GPTalk",
+    "GeekGpt",
+    "GeminiProChat",
+    "Gpt6",
+    "GptChatly",
+    "GptForLove",
+    "GptGo",
+    "GptTalkRu",
+    "Hashnode",
+    "HuggingChat",
+    "Koala",
+    "Liaobots",
+    "Llama2",
+    "MyShell",
+    "OnlineGpt",
+    "OpenaiChat",
+    "PerplexityAi",
+    "Phind",
+    "Pi",
+    "Poe",
+    "Raycast",
+    "TalkAi",
+    "Theb",
+    "ThebApi",
+    "You",
+    "Yqcloud",
+]
+available_providers = ["leo", "openai", "fakeopen", "opengpt", "koboldai", "bard"] + gpt4free_providers
 
 __all__ = [
     "appdir",
diff --git a/src/pytgpt/console.py b/src/pytgpt/console.py
@@ -36,7 +36,7 @@
 
 rich_code_themes = ["monokai", "paraiso-dark", "igor", "vs", "fruity", "xcode"]
 
-default_provider = "leo"
+default_provider = "Aura"
 
 logging.basicConfig(
     format="%(asctime)s - %(levelname)s : %(message)s ",  # [%(module)s,%(lineno)s]", # for debug purposes
@@ -234,6 +234,7 @@ def __init__(
         proxy_path,
         provider,
         quiet=False,
+        chat_completion=False,
         *args,
         **kwargs,
     ):
@@ -314,6 +315,7 @@ def __init__(
 
                 self.bot = OPENGPT(
                     is_conversation=disable_conversation,
+                    max_tokens=max_tokens,
                     timeout=timeout,
                     intro=intro,
                     filepath=filepath,
@@ -352,6 +354,23 @@ def __init__(
                     timeout=timeout,
                 )
 
+            elif provider in pytgpt.gpt4free_providers:
+                from pytgpt.gpt4free import GPT4FREE
+                self.bot = GPT4FREE(
+                    provider=provider,
+                    is_conversation=disable_conversation,
+                    max_tokens=max_tokens,
+                    model=model,
+                    chat_completion=chat_completion,
+                    timeout=timeout,
+                    intro=intro,
+                    filepath=filepath,
+                    update_file=update_file,
+                    proxies=proxies,
+                    history_offset=history_offset,
+                    act=awesome_prompt,
+                )
+
             else:
                 raise NotImplementedError(
                     f"The provider `{provider}` is not yet implemented."
@@ -909,6 +928,12 @@ def tgpt2_():
 @click.option(
     "-nc", "--no-coloring", is_flag=True, help="Disable intro prompt font-coloring"
 )
+@click.option(
+    "-cc",
+    "--chat-completion",
+    is_flag=True,
+    help="Provide native context for gpt4free providers",
+)
 @click.help_option("-h", "--help")
 def interactive(
     model,
@@ -937,6 +962,7 @@ def interactive(
     new,
     with_copied,
     no_coloring,
+    chat_completion,
 ):
     """Chat with AI interactively (Default)"""
     clear_history_file(filepath, new)
@@ -957,6 +983,7 @@ def interactive(
         proxy_path,
         provider,
         quiet,
+        chat_completion,
     )
     busy_bar.spin_index = busy_bar_index
     bot.code_theme = code_theme
diff --git a/src/pytgpt/gpt4free/__init__.py b/src/pytgpt/gpt4free/__init__.py
@@ -0,0 +1,18 @@
+from .main import GPT4FREE
+
+from .main import working_providers
+
+from .main import default_models
+
+from .main import completion_allowed_models
+
+__info__ = (
+    "Interact with various free models bundled by https://github.com/xtekky/gpt4free"
+)
+
+all = [
+    "GPT4FREE",
+    "working_providers",
+    "default_models",
+    "completion_allowed_models",
+]
diff --git a/src/pytgpt/gpt4free/main.py b/src/pytgpt/gpt4free/main.py
diff --git a/src/pytgpt/opengpt/main.py b/src/pytgpt/opengpt/main.py
diff --git a/tests/test_gpt4free.py b/tests/test_gpt4free.py
