# VividNode(pyqt-openai)
<div align="center">
<img src="https://github.com/user-attachments/assets/ab169535-8af0-40c7-848d-59a7e5e4b304"/>
<b>A cross-platform AI desktop chatbot application for LLM such as GPT, Claude, Gemini, Llama chatbot interaction and image generation, offering customizable features, local chat history, and enhanced performance—no browser required!<br><br>
Basically for free, powered by GPT4Free and LiteLLM.</b>
<hr>
[![](https://dcbadge.vercel.app/api/server/cHekprskVE)](https://discord.gg/cHekprskVE)
[![PyPI - Version](https://img.shields.io/pypi/v/pyqt-openai?logo=pypi&logoColor=white)](https://pypi.org/project/pyqt-openai/) [![Downloads](https://static.pepy.tech/badge/pyqt-openai)](https://pepy.tech/project/pyqt-openai) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyqt-openai?logo=python&logoColor=gold)](https://pypi.org/project/pyqt-openai/) ![commit](https://img.shields.io/github/commit-activity/w/yjg30737/pyqt-openai)
</div>
![image](https://github.com/user-attachments/assets/9f5f2ca0-b191-4655-b671-ae0834e1a0b1)
<hr>
## What is VividNode? 🤔
**VividNode** is a cross-platform desktop application that allows you to interact directly with LLM(GPT, Claude, Gemini, Llama) chatbots and generate images without needing a browser. Built with PySide6, VividNode (formerly known as pyqt-openai) supports Windows, Mac, and Linux, and securely stores your chat history locally in a database.
### Key Features:
- **Chat Interface**: Enjoy a seamless chat experience with a customizable interface, fast thread and message search, and advanced conversation settings. You can also import/export chat histories and use prompt management tools for efficient prompt engineering.
- **Image Generation**: Generate images using OpenAI’s DALL-E 3 or models from Replicate or GPT4Free, directly within your chat sessions. The app supports endless image generation, randomly generated prompt, automatic saving, and integrated image management.
- **Focus and Accessibility Modes**: Utilize Focus Mode, “Always on Top” Mode, transparency adjustments, and background notifications to keep the chat accessible and responsive without overwhelming system resources.
- **Customization and Shortcuts**: VividNode offers extensive customization options, including language settings, memory management, and a comprehensive list of keyboard shortcuts for faster operations.
- **Support for interactive chatting (STT & TTS)**: It features a recording function using OpenAI's STT capabilities and allows responses to be heard in various voices through OpenAI Whisper or the TTS functionality of the Edge browser (using edge-tts, which is free).
With VividNode, you can experience a more powerful and resource-efficient alternative to browser-based GPT interfaces, making it easier to manage both text and image-based interactions.
<hr>
## Sidenote 🗒️
Although this is named 'pyqt-openai', the model does not use only OpenAI-related models, and the GUI is created using PySide6, not PyQt. 'pyqt-openai' was the package name decided initially, and we are still using it as changing the package name now would likely result in a huge disaster.
## How to Install
### Standard Way
1. git clone ~
2. cd pyqt-openai
3. pip install -r requirements.txt --upgrade
4. cd pyqt_openai
5. python main.py
### With Makefile
1. make venv
2. make run
### Wanna download this without doing stuffs like above? You can download installer or zip file <a href="https://github.com/yjg30737/pyqt-openai/releases">here.</a>
## How to Use 🧐
**<a href="https://medium.com/@yjg30737/what-is-vividnode-how-to-use-it-4d8a9269a3c0">QuickStart</a>**
## Test Scenario
This is the [default test scenario page](https://github.com/yjg30737/pyqt-openai/wiki/Test-Scenario). If you want to test it out and be sure nothing is wrong, try it :)
## Troubleshooting
### Common Issues
#### Issues Related to PyAudio
- This issue is often due to the absence of PortAudio. Make sure to install PortAudio before you install PyAudio.
#### Issues Related to PySide6 During Installation
- As of October 14, 2024, PySide6 supports Python versions above 3.9 and below 3.13. If support for Python 3.13 is added in the future, you can remove this note.
#### Handling Error Messages Related to Software Updates (Windows)
- If you encounter the following error message when trying to update VividNode via the auto-update feature: **PermissionError: [Errno 13] Permission denied**, To resolve this issue, run VividNode as an administrator.
- Also, if VividNode keeps asking "Wanna update?" even though you've updated it already, just install this again and everything will be fine.
#### Runtime error
![image](https://github.com/user-attachments/assets/f53b44bb-1572-48ce-a9a0-a5da2b338d09)
- If you see the error above, run the application again. It is likely to be shown in old version(below v1.5.0) so update to the latest version.
#### Incomplete or Inaccurate Translations
- If you come across incomplete or unnatural translations, please update the **pyqt_openai/lang/translations.json** file.
If the solutions listed here don’t resolve your issue, please report it by [opening an issue](https://github.com/yjg30737/pyqt-openai/issues).
## Help Needed 🆘
**Managing this project alone has become quite challenging so i'm reaching out for support.**
If you have experience with coding, documentation, design, or even providing constructive feedback, I would greatly appreciate your involvement. Your contribution could make a significant difference.
Your contribution, even just a fix a simple typo in readme or simple refactoring can be very helpful. Of course there are a lot of official TODOs i need helping hand as well. So [see here](https://github.com/yjg30737/pyqt-openai/blob/main/CONTRIBUTING.md) if you are willing to contribute.
You can contact me 24/7 by sending me an email to **yjg30737@gmail.com** or join [**Discord server**](https://discord.gg/cHekprskVE) to talk in real time
## Contributors
* **Me (WizMiner)** 😊
* Creator of VividNode 🐐
## Disclaimer
Please do not distribute this commercially without my permission, by claiming it as your own creation.
Raw data
{
"_id": null,
"home_page": null,
"name": "pyqt-openai",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": null,
"keywords": "openai, pyqt, pyqt5, pyqt6, pyside6, desktop, app, chatbot, gpt, replicate, gemini, claude, llama, llm, gpt4free, litellm",
"author": null,
"author_email": "Jung Gyu Yoon <yjg30737@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/a4/8f/78adf2e7ad08bf56b66b0dad9bc5a07ca7e061a6297e00a5543be1474cb6/pyqt_openai-1.8.1.tar.gz",
"platform": null,
"description": "# VividNode(pyqt-openai)\r\n<div align=\"center\">\r\n <img src=\"https://github.com/user-attachments/assets/ab169535-8af0-40c7-848d-59a7e5e4b304\"/>\r\n\r\n <b>A cross-platform AI desktop chatbot application for LLM such as GPT, Claude, Gemini, Llama chatbot interaction and image generation, offering customizable features, local chat history, and enhanced performance\u2014no browser required!<br><br>\r\n Basically for free, powered by GPT4Free and LiteLLM.</b>\r\n\r\n<hr>\r\n\r\n [![](https://dcbadge.vercel.app/api/server/cHekprskVE)](https://discord.gg/cHekprskVE)\r\n \r\n [![PyPI - Version](https://img.shields.io/pypi/v/pyqt-openai?logo=pypi&logoColor=white)](https://pypi.org/project/pyqt-openai/) [![Downloads](https://static.pepy.tech/badge/pyqt-openai)](https://pepy.tech/project/pyqt-openai) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyqt-openai?logo=python&logoColor=gold)](https://pypi.org/project/pyqt-openai/) ![commit](https://img.shields.io/github/commit-activity/w/yjg30737/pyqt-openai)\r\n</div>\r\n\r\n![image](https://github.com/user-attachments/assets/9f5f2ca0-b191-4655-b671-ae0834e1a0b1)\r\n\r\n<hr>\r\n\r\n## What is VividNode? \ud83e\udd14\r\n\r\n**VividNode** is a cross-platform desktop application that allows you to interact directly with LLM(GPT, Claude, Gemini, Llama) chatbots and generate images without needing a browser. Built with PySide6, VividNode (formerly known as pyqt-openai) supports Windows, Mac, and Linux, and securely stores your chat history locally in a database.\r\n\r\n### Key Features:\r\n- **Chat Interface**: Enjoy a seamless chat experience with a customizable interface, fast thread and message search, and advanced conversation settings. You can also import/export chat histories and use prompt management tools for efficient prompt engineering.\r\n- **Image Generation**: Generate images using OpenAI\u2019s DALL-E 3 or models from Replicate or GPT4Free, directly within your chat sessions. The app supports endless image generation, randomly generated prompt, automatic saving, and integrated image management.\r\n- **Focus and Accessibility Modes**: Utilize Focus Mode, \u201cAlways on Top\u201d Mode, transparency adjustments, and background notifications to keep the chat accessible and responsive without overwhelming system resources.\r\n- **Customization and Shortcuts**: VividNode offers extensive customization options, including language settings, memory management, and a comprehensive list of keyboard shortcuts for faster operations.\r\n- **Support for interactive chatting (STT & TTS)**: It features a recording function using OpenAI's STT capabilities and allows responses to be heard in various voices through OpenAI Whisper or the TTS functionality of the Edge browser (using edge-tts, which is free).\r\n\r\nWith VividNode, you can experience a more powerful and resource-efficient alternative to browser-based GPT interfaces, making it easier to manage both text and image-based interactions.\r\n\r\n<hr>\r\n\r\n## Sidenote \ud83d\uddd2\ufe0f\r\nAlthough this is named 'pyqt-openai', the model does not use only OpenAI-related models, and the GUI is created using PySide6, not PyQt. 'pyqt-openai' was the package name decided initially, and we are still using it as changing the package name now would likely result in a huge disaster.\r\n\r\n## How to Install\r\n### Standard Way\r\n1. git clone ~\r\n2. cd pyqt-openai\r\n3. pip install -r requirements.txt --upgrade\r\n4. cd pyqt_openai\r\n5. python main.py\r\n### With Makefile\r\n1. make venv\r\n2. make run\r\n\r\n### Wanna download this without doing stuffs like above? You can download installer or zip file <a href=\"https://github.com/yjg30737/pyqt-openai/releases\">here.</a>\r\n\r\n## How to Use \ud83e\uddd0\r\n**<a href=\"https://medium.com/@yjg30737/what-is-vividnode-how-to-use-it-4d8a9269a3c0\">QuickStart</a>**\r\n\r\n## Test Scenario\r\nThis is the [default test scenario page](https://github.com/yjg30737/pyqt-openai/wiki/Test-Scenario). If you want to test it out and be sure nothing is wrong, try it :)\r\n\r\n## Troubleshooting\r\n### Common Issues\r\n#### Issues Related to PyAudio\r\n- This issue is often due to the absence of PortAudio. Make sure to install PortAudio before you install PyAudio.\r\n#### Issues Related to PySide6 During Installation \r\n- As of October 14, 2024, PySide6 supports Python versions above 3.9 and below 3.13. If support for Python 3.13 is added in the future, you can remove this note.\r\n#### Handling Error Messages Related to Software Updates (Windows)\r\n- If you encounter the following error message when trying to update VividNode via the auto-update feature: **PermissionError: [Errno 13] Permission denied**, To resolve this issue, run VividNode as an administrator.\r\n- Also, if VividNode keeps asking \"Wanna update?\" even though you've updated it already, just install this again and everything will be fine.\r\n#### Runtime error\r\n![image](https://github.com/user-attachments/assets/f53b44bb-1572-48ce-a9a0-a5da2b338d09)\r\n- If you see the error above, run the application again. It is likely to be shown in old version(below v1.5.0) so update to the latest version.\r\n \r\n#### Incomplete or Inaccurate Translations\r\n- If you come across incomplete or unnatural translations, please update the **pyqt_openai/lang/translations.json** file.\r\n\r\nIf the solutions listed here don\u2019t resolve your issue, please report it by [opening an issue](https://github.com/yjg30737/pyqt-openai/issues).\r\n\r\n## Help Needed \ud83c\udd98\r\n\r\n**Managing this project alone has become quite challenging so i'm reaching out for support.**\r\nIf you have experience with coding, documentation, design, or even providing constructive feedback, I would greatly appreciate your involvement. Your contribution could make a significant difference.\r\n\r\nYour contribution, even just a fix a simple typo in readme or simple refactoring can be very helpful. Of course there are a lot of official TODOs i need helping hand as well. So [see here](https://github.com/yjg30737/pyqt-openai/blob/main/CONTRIBUTING.md) if you are willing to contribute.\r\n\r\nYou can contact me 24/7 by sending me an email to **yjg30737@gmail.com** or join [**Discord server**](https://discord.gg/cHekprskVE) to talk in real time\r\n\r\n## Contributors\r\n* **Me (WizMiner)** \ud83d\ude0a\r\n * Creator of VividNode \ud83d\udc10\r\n\r\n## Disclaimer\r\nPlease do not distribute this commercially without my permission, by claiming it as your own creation.\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python multipurpose chatbot that user can use GPT, other AI models altogether (Release Name: VividNode)",
"version": "1.8.1",
"project_urls": {
"homepage": "https://github.com/yjg30737/pyqt-openai.git"
},
"split_keywords": [
"openai",
" pyqt",
" pyqt5",
" pyqt6",
" pyside6",
" desktop",
" app",
" chatbot",
" gpt",
" replicate",
" gemini",
" claude",
" llama",
" llm",
" gpt4free",
" litellm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f7b4c056fcfd42569d646182a7fc687565de4e05ec7676153546b46504fecef",
"md5": "702345e5e16e597e94bd6108bdebf82f",
"sha256": "a55cbd2eaf7eb2e561f50b4e6f6f1df9fa2d6eb10d448517ed3b7135df6cdd8d"
},
"downloads": -1,
"filename": "pyqt_openai-1.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "702345e5e16e597e94bd6108bdebf82f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 254497,
"upload_time": "2024-11-17T08:40:52",
"upload_time_iso_8601": "2024-11-17T08:40:52.160516Z",
"url": "https://files.pythonhosted.org/packages/8f/7b/4c056fcfd42569d646182a7fc687565de4e05ec7676153546b46504fecef/pyqt_openai-1.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a48f78adf2e7ad08bf56b66b0dad9bc5a07ca7e061a6297e00a5543be1474cb6",
"md5": "7e54dda2c91a5f207b90d1de4cef73a8",
"sha256": "27f8a7940cc06e4ee89c53fa6b44d8e60aae4ef09abddf31773f1c86606db7f9"
},
"downloads": -1,
"filename": "pyqt_openai-1.8.1.tar.gz",
"has_sig": false,
"md5_digest": "7e54dda2c91a5f207b90d1de4cef73a8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 243776,
"upload_time": "2024-11-17T08:40:54",
"upload_time_iso_8601": "2024-11-17T08:40:54.188125Z",
"url": "https://files.pythonhosted.org/packages/a4/8f/78adf2e7ad08bf56b66b0dad9bc5a07ca7e061a6297e00a5543be1474cb6/pyqt_openai-1.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-17 08:40:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yjg30737",
"github_project": "pyqt-openai",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pyqt-openai"
}