gpt4free

公开

关注 0 Fork 0 Star 1

返回提交历史

XFEstudio/gpt4free

Add Installation Guide for Windows Improve Contributors list in Readme

0de9ca20

Heiner Lohaus <hlohaus@users.noreply.github.com>

提交于 2024-04-06 10:47

父提交 2dbf467

代码差异

11 个文件 +176 -785

Deleted README-DE.md +0 -726

Modified README.md +86 -49

@@ -24,13 +24,13 @@ docker pull hlohaus789/g4f

24 24

25 25 ## 🆕 What's New

26 26

27 - Check out a more in depth local inference @ https://github.com/gpt4free/gpt4local

28 - Join our Telegram Channel: [t.me/g4f_channel](https://telegram.me/g4f_channel)

29 - Join our Discord Group: [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5)

30 - `g4f` now supports 100% local inference: [local-docs](https://g4f.mintlify.app/docs/core/usage/local)

27 - Webview .exe for Windows: 💻 [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)

28 - Join our Telegram Channel: 📨 [telegram.me/g4f_channel](https://telegram.me/g4f_channel)

29 - Join our Discord Group: 💬 [discord.gg/XfybzPXPH5](https://discord.gg/XfybzPXPH5)

30 - `g4f` now supports 100% local inference: 🧠 [local-docs](https://g4f.mintlify.app/docs/core/usage/local)

31 31

32 32 ## 🔻 Site Takedown

Is your site on this repository and you want to take it down? Send an email to takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API ;)

Is your site on this repository and you want to take it down? Send an email to takedown@g4f.ai with proof it is yours and it will be removed as fast as possible. To prevent reproduction please secure your API. 😉

34 34

35 35 ## 🚀 Feedback and Todo

36 36 You can always leave some feedback here: https://forms.gle/FeWV9RLEedfdkmFN6

@@ -42,7 +42,7 @@ As per the survey, here is a list of improvements to come

42 42 - [x] Improve the provider status list & updates

43 43 - [ ] Tutorials on how to reverse sites to write your own wrapper (PoC only ofc)

44 44 - [x] Improve the Bing wrapper. (Wait and Retry or reuse conversation)

45 - [ ] Write a standard provider performance test to improve the stability

45 - [ ] 🚧 Write a standard provider performance test to improve the stability

46 46 - [ ] Potential support and development of local models

47 47 - [ ] 🚧 Improve compatibility and error handling

48 48

@@ -51,8 +51,8 @@ As per the survey, here is a list of improvements to come

51 51 - [🆕 What's New](#-whats-new)

52 52 - [📚 Table of Contents](#-table-of-contents)

53 53 - [🛠️ Getting Started](#-getting-started)

54 + [Docker container](#docker-container)

55 - [Quick start](#quick-start)

54 + [Docker Container Guide](#docker-container-guide)

55 + [Installation Guide for Windows (.exe)](#installation-guide-for-windows-exe)

56 56 + [Use python](#use-python)

57 57 - [Prerequisites](#prerequisites)

58 58 - [Install using PyPI package:](#install-using-pypi-package)

@@ -80,20 +80,41 @@ As per the survey, here is a list of improvements to come

80 80

81 81 ## 🛠️ Getting Started

82 82

83 #### Docker container

83 #### Docker Container Guide

84 84

85 ##### Quick start:

85 ##### Getting Started Quickly:

86 86

87 1. [Download and install Docker](https://docs.docker.com/get-docker/)

88 2. Pull latest image and run the container:

87 1. **Install Docker:** Begin by [downloading and installing Docker](https://docs.docker.com/get-docker/).

89 2. **Set Up the Container:**

90 Use the following commands to pull the latest image and start the container:

89 91

90 92 ```sh

91 93 docker pull hlohaus789/g4f

92 94 docker run -p 8080:8080 -p 1337:1337 -p 7900:7900 --shm-size="2g" -v ${PWD}/hardir:/app/hardir hlohaus789/g4f:latest

93 95 ```

94 3. Open the included client on: [http://localhost:8080/chat/](http://localhost:8080/chat/)

95 or set the API base in your client to: [http://localhost:1337/v1](http://localhost:1337/v1)

4. (Optional) If you need to log in to a provider, you can view the desktop from the container here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret.

97 3. **Access the Client:**

98 - To use the included client, navigate to: [http://localhost:8080/chat/](http://localhost:8080/chat/)

99 - Or set the API base for your client to: [http://localhost:1337/v1](http://localhost:1337/v1)

100

101 4. **(Optional) Provider Login:**

102

   If required, you can access the container's desktop here: http://localhost:7900/?autoconnect=1&resize=scale&password=secret for provider login purposes.

103

104 #### Installation Guide for Windows (.exe)

105

To ensure the seamless operation of our application, please follow the instructions below. These steps are designed to guide you through the installation process on Windows operating systems.

106 ##### Prerequisites

107

1. **WebView2 Runtime**: Our application requires the *WebView2 Runtime* to be installed on your system. If you do not have it installed, please download and install it from the [Microsoft Developer Website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/). If you already have *WebView2 Runtime* installed but are encountering issues, navigate to *Installed Windows Apps*, select *WebView2*, and opt for the repair option.

108 ##### Installation Steps

109

2. **Download the Application**: Visit our [latest releases page](https://github.com/xtekky/gpt4free/releases/latest) and download the most recent version of the application, named `g4f.webview.*.exe`.

110

3. **File Placement**: Once downloaded, transfer the `.exe` file from your downloads folder to a directory of your choice on your system, and then execute it to run the app.

111 ##### Post-Installation Adjustment

112

4. **Firewall Configuration (Hotfix)**: Upon installation, it may be necessary to adjust your Windows Firewall settings to allow the application to operate correctly. To do this, access your Windows Firewall settings and allow the application.

113

114

By following these steps, you should be able to successfully install and run the application on your Windows system. If you encounter any issues during the installation process, please refer to our Issue Tracker or try to get contact over Discord for assistance.

115

116 Run the **Webview UI** on other Platfroms:

117 - [/docs/guides/webview](/docs/webview.md)

97 118

98 119 ##### Use your smartphone:

99 120

@@ -170,34 +191,7 @@ image_url = response.data[0].url

170 191 - New Client API like the OpenAI Python library: [/docs/client](/docs/client.md)

171 192 - Legacy API with python modules: [/docs/legacy](/docs/legacy.md)

172 193

173 ### Webview GUI

174

175 Open the GUI in a window of your OS. Runs on a local/static/ssl server and use a JavaScript API.

176 Supports login into the OpenAI Chat, Image Upload and streamed Text Generation.

177

178 Supports all platforms, but only Linux tested.

179

180 1. Install all requirements with:

181

182 ```bash

183 pip install g4f[webview]

184 ```

185

186 2. Follow the OS specific steps here:

187 [pywebview installation](https://pywebview.flowrl.com/guide/installation.html#dependencies)

188

189 3. Run the app with:

190

191 ```python

192 from g4f.gui.webview import run_webview

193 run_webview(debug=True)

194 ```

195 or execute the following command:

196 ```bash

197 python -m g4f.gui.webview -debug

198 ```

199

200 #### Webserver

194 #### GUI Webserver

201 195

202 196 To start the web interface, type the following codes in python:

203 197

@@ -210,11 +204,13 @@ or execute the following command:

210 204 python -m g4f.cli gui -port 8080 -debug

211 205 ```

212 206

213 ### Interference API

207 #### Interference API

214 208

215 209 You can use the Interference API to serve other OpenAI integrations with G4F.

216 210

217 See: [/docs/interference](/docs/interference.md)

211 See docs: [/docs/interference](/docs/interference.md)

212

213 Access with: http://localhost:1337/v1

218 214

219 215 ### Configuration

220 216

@@ -247,7 +243,7 @@ To utilize the OpenaiChat provider, a .har file is required from https://chat.op

247 243

2. Access the Developer Tools in your browser. This can typically be done by right-clicking the page and selecting "Inspect," or by pressing F12 or Ctrl+Shift+I (Cmd+Option+I on a Mac).

248 244 3. With the Developer Tools open, switch to the "Network" tab.

249 245 4. Reload the website to capture the loading process within the Network tab.

250 5. Initiate an action in the chat which can be capture in the .har file.

246 5. Initiate an action in the chat which can be captured in the .har file.

251 247 6. Right-click any of the network activities listed and select "Save all as HAR with content" to export the .har file.

252 248

253 249 ##### Storing the .HAR File

@@ -780,9 +776,50 @@ We welcome contributions from the community. Whether you're adding new providers

780 776

781 777 ## 🙌 Contributors

782 778

783 A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)

784

The [`Vercel.py`](https://github.com/xtekky/gpt4free/blob/main/g4f/Provider/Vercel.py) file contains code from [vercel-llm-api](https://github.com/ading2210/vercel-llm-api) by [@ading2210](https://github.com/ading2210), which is licensed under the [GNU GPL v3](https://www.gnu.org/licenses/gpl-3.0.txt)

785 Top 1 Contributor: [@hlohaus](https://github.com/hlohaus)

779 A list of all contributors is available [here](https://github.com/xtekky/gpt4free/graphs/contributors)

780

781

<a href="https://github.com/xtekky" target="_blank"><img src="https://avatars.githubusercontent.com/u/98614666?v=4&s=45" width="45" title="xtekky"></a>

782

<a href="https://github.com/hlohaus" target="_blank"><img src="https://avatars.githubusercontent.com/u/983577?v=4&s=45" width="45" title="hlohaus"></a>

783

<a href="https://github.com/bagusindrayana" target="_blank"><img src="https://avatars.githubusercontent.com/u/36830534?v=4&s=45" width="45" title="bagusindrayana"></a>

784

<a href="https://github.com/sudouser777" target="_blank"><img src="https://avatars.githubusercontent.com/u/22415463?v=4&s=45" width="45" title="sudouser777"></a>

785

<a href="https://github.com/thatlukinhasguy1" target="_blank"><img src="https://avatars.githubusercontent.com/u/139662282?v=4&s=45" width="45" title="thatlukinhasguy1"></a>

786

<a href="https://github.com/Commenter123321" target="_blank"><img src="https://avatars.githubusercontent.com/u/36051603?v=4&s=45" width="45" title="Commenter123321"></a>

787

<a href="https://github.com/DanielShemesh" target="_blank"><img src="https://avatars.githubusercontent.com/u/20585236?v=4&s=45" width="45" title="DanielShemesh"></a>

788

<a href="https://github.com/Luneye" target="_blank"><img src="https://avatars.githubusercontent.com/u/73485421?v=4&s=45" width="45" title="Luneye"></a>

789

<a href="https://github.com/enganese" target="_blank"><img src="https://avatars.githubusercontent.com/u/69082498?v=4&s=45" width="45" title="enganese"></a>

790

<a href="https://github.com/ezerinz" target="_blank"><img src="https://avatars.githubusercontent.com/u/100193740?v=4&s=45" width="45" title="ezerinz"></a>

791

<a href="https://github.com/Lin-jun-xiang" target="_blank"><img src="https://avatars.githubusercontent.com/u/63782903?v=4&s=45" width="45" title="Lin-jun-xiang"></a>

792

<a href="https://github.com/nullstreak" target="_blank"><img src="https://avatars.githubusercontent.com/u/139914347?v=4&s=45" width="45" title="nullstreak"></a>

793

<a href="https://github.com/valerii-chirkov" target="_blank"><img src="https://avatars.githubusercontent.com/u/81074936?v=4&s=45" width="45" title="valerii-chirkov"></a>

794

<a href="https://github.com/MIDORIBIN" target="_blank"><img src="https://avatars.githubusercontent.com/u/25425217?v=4&s=45" width="45" title="MIDORIBIN"></a>

795

<a href="https://github.com/repollo" target="_blank"><img src="https://avatars.githubusercontent.com/u/2671466?v=4&s=45" width="45" title="repollo"></a>

796

<a href="https://github.com/hpsj" target="_blank"><img src="https://avatars.githubusercontent.com/u/54535414?v=4&s=45" width="45" title="hpsj"></a>

797

<a href="https://github.com/taiyi747" target="_blank"><img src="https://avatars.githubusercontent.com/u/63543716?v=4&s=45" width="45" title="taiyi747"></a>

798

<a href="https://github.com/ostix360" target="_blank"><img src="https://avatars.githubusercontent.com/u/55257054?v=4&s=45" width="45" title="ostix360"></a>

799

<a href="https://github.com/WdR-Tech" target="_blank"><img src="https://avatars.githubusercontent.com/u/143020293?v=4&s=45" width="45" title="WdR-Tech"></a>

800

<a href="https://github.com/HexyeDEV" target="_blank"><img src="https://avatars.githubusercontent.com/u/65314629?v=4&s=45" width="45" title="HexyeDEV"></a>

801

<a href="https://github.com/9fo" target="_blank"><img src="https://avatars.githubusercontent.com/u/71867245?v=4&s=45" width="45" title="9fo"></a>

802

<a href="https://github.com/eltociear" target="_blank"><img src="https://avatars.githubusercontent.com/u/22633385?v=4&s=45" width="45" title="eltociear"></a>

803

<a href="https://github.com/ramonvc" target="_blank"><img src="https://avatars.githubusercontent.com/u/13617054?v=4&s=45" width="45" title="ramonvc"></a>

804

<a href="https://github.com/naa7" target="_blank"><img src="https://avatars.githubusercontent.com/u/44613678?v=4&s=45" width="45" title="naa7"></a>

805

<a href="https://github.com/zeng-rr" target="_blank"><img src="https://avatars.githubusercontent.com/u/47846202?v=4&s=45" width="45" title="zeng-rr"></a>

806

<a href="https://github.com/editor-syntax" target="_blank"><img src="https://avatars.githubusercontent.com/u/109844019?v=4&s=45" width="45" title="editor-syntax"></a>

807

<a href="https://github.com/devAdityaa" target="_blank"><img src="https://avatars.githubusercontent.com/u/77636021?v=4&s=45" width="45" title="devAdityaa"></a>

808

<a href="https://github.com/kggn" target="_blank"><img src="https://avatars.githubusercontent.com/u/95663228?v=4&s=45" width="45" title="kggn"></a>

809

<a href="https://github.com/xiangsx" target="_blank"><img src="https://avatars.githubusercontent.com/u/29322721?v=4&s=45" width="45" title="xiangsx"></a>

810

<a href="https://github.com/ggindinson" target="_blank"><img src="https://avatars.githubusercontent.com/u/97807772?v=4&s=45" width="45" title="ggindinson"></a>

811 <span></span>

812 <img src="https://avatars.githubusercontent.com/u/71154407?s=45&v=4" width="45" title="ading2210">

813 <img src="https://avatars.githubusercontent.com/u/12299238?s=45&v=4" width="45" title="xqdoo00o">

814 <img src="https://avatars.githubusercontent.com/u/97126670?s=45&v=4" width="45" title="nathanrchn">

815 <img src="https://avatars.githubusercontent.com/u/81407603?v=4&s=45" width="45" title="dsdanielpark">

816

817

- The [`Vercel.py`](g4f/Provider/Vercel.py) file contains code from [vercel-llm-api](https://github.com/ading2210/vercel-llm-api) by [@ading2210](https://github.com/ading2210)

818

- The [`har_file.py`](g4f/Provider/openai/har_file.py) has input from [xqdoo00o/ChatGPT-to-API](https://github.com/xqdoo00o/ChatGPT-to-API)

819

- The [`PerplexityLabs.py`](g4f/Provider/openai/har_file.py) has input from [nathanrchn/perplexityai](https://github.com/nathanrchn/perplexityai)

820

- The [`Gemini.py`](g4f/Provider/needs_auth/Gemini.py) has input from [dsdanielpark/Gemini-API](https://github.com/dsdanielpark/Gemini-API)

821

822 *Having input implies that the AI's code generation utilized it as one of many sources.*

786 823

787 824 ## ©️ Copyright

788 825

Added docs/webview.md +30 -0

@@ -0,0 +1,30 @@

1 ### G4F - Webview GUI

3 Open the GUI in a window of your OS. Runs on a local/static/ssl server and use a JavaScript API.

4 Supports login into the OpenAI Chat (.har files), Image Upload and streamed Text Generation.

6 Supports all platforms, but only Linux/Windows tested.

8 1. Install all python requirements with:

10 ```bash

11 pip install g4f[webview]

12 ```

14 2. *a)* Follow the **OS specific** steps here:

15 [pywebview installation](https://pywebview.flowrl.com/guide/installation.html#dependencies)

2. *b)* **WebView2** on **Windows**: Our application requires the *WebView2 Runtime* to be installed on your system. If you do not have it installed, please download and install it from the [Microsoft Developer Website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/). If you already have *WebView2 Runtime* installed but are encountering issues, navigate to *Installed Windows Apps*, select *WebView2*, and opt for the repair option.

19 3. Run the app with:

21 ```python

22 from g4f.gui.webview import run_webview

23 run_webview(debug=True)

24 ```

25 or execute the following command:

26 ```bash

27 python -m g4f.gui.webview -debug

28 ```

30 [Return to Home](/)

Added etc/tool/contributers.py +6 -0

@@ -0,0 +1,6 @@

1 import requests

3 url = "https://api.github.com/repos/xtekky/gpt4free/contributors"

5 for user in requests.get(url).json():

    print(f'<a href="https://github.com/{user["login"]}" target="_blank"><img src="{user["avatar_url"]}&s=45" width="45" title="{user["login"]}"></a>')

Modified etc/unittest/integration.py +2 -2

@@ -4,13 +4,13 @@ import json

4 4 try:

5 5 import nest_asyncio

6 6 has_nest_asyncio = True

7 except:

7 except ImportError:

8 8 has_nest_asyncio = False

9 9

10 10 from g4f.client import Client, ChatCompletion

11 11 from g4f.Provider import Bing, OpenaiChat

12 12

13 DEFAULT_MESSAGES = [{"role": "system", "content": 'Response in json, Example: {"success: True"}'},

13 DEFAULT_MESSAGES = [{"role": "system", "content": 'Response in json, Example: {"success: true"}'},

14 14 {"role": "user", "content": "Say success true in json"}]

15 15

16 16 class TestProviderIntegration(unittest.TestCase):

Modified g4f/gui/server/api.py +1 -1

@@ -136,7 +136,7 @@ class Api():

136 136 camera.take_picture(filename=filename, on_complete=self.on_camera)

137 137

138 138 def on_image_selection(self, filename):

139 filename = filename[0] if isinstance(filename, list) else filename

139 filename = filename[0] if isinstance(filename, list) and filename else filename

140 140 if filename is not None and os.path.exists(filename):

141 141 self.image = filename

142 142 else:

Modified g4f/gui/webview.py +5 -3

@@ -17,13 +17,14 @@ import g4f.debug

17 17 def run_webview(

18 18 debug: bool = False,

19 19 ssl: bool = True,

20 storage_path: str = None

20 storage_path: str = None,

21 gui: str = None

21 22 ):

22 23 if getattr(sys, 'frozen', False):

23 24 dirname = sys._MEIPASS

24 25 else:

25 26 dirname = os.path.dirname(__file__)

26 webview.settings['OPEN_EXTERNAL_LINKS_IN_BROWSER'] = False

27 webview.settings['OPEN_EXTERNAL_LINKS_IN_BROWSER'] = True

27 28 webview.settings['ALLOW_DOWNLOADS'] = True

28 29 webview.create_window(

29 30 f"g4f - {g4f.version.utils.current_version}",

@@ -37,7 +38,8 @@ def run_webview(

37 38 private_mode=False,

38 39 storage_path=storage_path,

39 40 debug=debug,

40 ssl=ssl

41 ssl=ssl,

42 gui=gui

41 43 )

42 44

43 45 if __name__ == "__main__":

Added windows/docker-compose.yml +19 -0

@@ -0,0 +1,19 @@

1 version: "3"

2 services:

3 windows:

4 image: dockurr/windows

5 container_name: windows

6 environment:

7 VERSION: "win11"

8 devices:

9 - /dev/kvm

10 cap_add:

11 - NET_ADMIN

12 ports:

13 - 8006:8006

14 - 3389:3389/tcp

15 - 3389:3389/udp

16 stop_grace_period: 2m

17 restart: on-failure

18 volumes:

19 - /var/win:/storage

Added windows/icon.ico +0 -0

二进制文件已变更，无法进行逐行预览。

Added windows/main.py +22 -0

@@ -0,0 +1,22 @@

1 import ssl

2 import certifi

3 from functools import partial

5 ssl.default_ca_certs = certifi.where()

6 ssl.create_default_context = partial(

7 ssl.create_default_context,

8 cafile=certifi.where()

9 )

11 from g4f.gui.webview import run_webview

12 from g4f.gui.run import gui_parser

13 import g4f.debug

14 g4f.debug.version_check = False

15 g4f.debug.version = "0.2.8.0"

17 if __name__ == "__main__":

18 parser = gui_parser()

19 args = parser.parse_args()

20 if args.debug:

21 g4f.debug.logging = True

22 run_webview(args.debug)

Renamed windows/main.spec +5 -4

@@ -5,11 +5,11 @@ block_cipher = None

5 5

6 6

7 7 a = Analysis(

8 ['webview.py'],

8 ['main.py'],

9 9 pathex=[],

10 10 binaries=[],

11 11 datas=[],

12 hiddenimports=[],

12 hiddenimports=['plyer.platforms.linux.filechooser', 'plyer.platforms.win.filechooser'],

13 13 hookspath=[],

14 14 hooksconfig={},

15 15 runtime_hooks=[],

@@ -25,11 +25,11 @@ exe = EXE(

25 25 pyz,

26 26 a.scripts,

27 27 a.binaries,

28 Tree('client', prefix='client'),

    Tree('C:/Users/Docker/AppData/Local/Packages/PythonSoftwareFoundation.Python.3.11_qbz5n2kfra8p0/LocalCache/local-packages/Python311/site-packages/g4f/gui/client', prefix='client'),

29 29 a.zipfiles,

30 30 a.datas,

31 31 [],

32 name='webview',

32 name='g4f',

33 33 debug=False,

34 34 bootloader_ignore_signals=False,

35 35 strip=False,

@@ -42,4 +42,5 @@ exe = EXE(

42 42 target_arch=None,

43 43 codesign_identity=None,

44 44 entitlements_file=None,

45 icon='icon.ico',

45 46 )