Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terry3041/pyChatGPT
An unofficial Python wrapper for OpenAI's ChatGPT API
https://github.com/terry3041/pyChatGPT
Last synced: 2 days ago
JSON representation
An unofficial Python wrapper for OpenAI's ChatGPT API
- Host: GitHub
- URL: https://github.com/terry3041/pyChatGPT
- Owner: terry3041
- License: gpl-3.0
- Archived: true
- Created: 2022-12-06T07:57:49.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-07T04:08:38.000Z (11 months ago)
- Last Synced: 2024-07-24T21:14:18.727Z (4 months ago)
- Language: Python
- Size: 102 KB
- Stars: 1,347
- Watchers: 22
- Forks: 255
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-chatgpt - pyChatGPT - a Python client for the unofficial ChatGPT API
- StarryDivineSky - terry3041/pyChatGPT
README
# pyChatGPT
[](https://pypi.python.org/pypi/pyChatGPT)
[](https://github.com/terry3041/pyChatGPT/blob/main/LICENSE)
> I stopped maintaining this project as ChatGPT now has an official API. See [OpenAI API](https://beta.openai.com/docs/api-reference/introduction) for more details. Feel free to fork this project if you want to continue development.
An unofficial Python wrapper for OpenAI's ChatGPT API
## Features
- [x] Cloudflare's anti-bot protection bypass using `undetected_chromedriver`
- [x] OpenAI / Google / Microsoft login support (experimental)
- [x] Captcha solvers support (2Captcha, PyPasser)
- [x] [Headless machines support](#how-do-i-get-it-to-work-on-headless-linux-server)
- [x] Proxy support (only without basic auth)
## Getting Started
> Since version 0.3.0, this library is using only the `undetected_chromedriver` to bypass Cloudflare's anti-bot protection. `requests` module is no longer used due to the complexity of the protection. **Please make sure you have [Google Chrome](https://www.google.com/chrome/) / [Chromium](https://www.chromium.org/) before using this wrapper.**
### Installation
```bash
pip install -U pyChatGPT
```
### Usage
#### Obtaining session_token
1. Go to https://chat.openai.com/chat and open the developer tools by `F12`.
2. Find the `__Secure-next-auth.session-token` cookie in `Application` > `Storage` > `Cookies` > `https://chat.openai.com`.
3. Copy the value in the `Cookie Value` field.
#### Interactive mode
```bash
python3 -m pyChatGPT
```
#### Import as a module
```python
from pyChatGPT import ChatGPT
session_token = 'abc123' # `__Secure-next-auth.session-token` cookie from https://chat.openai.com/chat
api = ChatGPT(session_token) # auth with session token
api = ChatGPT(session_token, conversation_id='some-random-uuid') # specify conversation id
api = ChatGPT(session_token, proxy='https://proxy.example.com:8080') # specify proxy
api = ChatGPT(session_token, chrome_args=['--window-size=1920,768']) # specify chrome args
api = ChatGPT(session_token, moderation=False) # disable moderation
api = ChatGPT(session_token, verbose=True) # verbose mode (print debug messages)
# auth with google login
api = ChatGPT(auth_type='google', email='[email protected]', password='password')
# auth with microsoft login
api = ChatGPT(auth_type='microsoft', email='[email protected]', password='password')
# auth with openai login (captcha solving using speech-to-text engine)
api = ChatGPT(auth_type='openai', email='[email protected]', password='password')
# auth with openai login (manual captcha solving)
api = ChatGPT(
auth_type='openai', captcha_solver=None,
email='[email protected]', password='password'
)
# auth with openai login (2captcha for captcha solving)
api = ChatGPT(
auth_type='openai', captcha_solver='2captcha', solver_apikey='abc',
email='[email protected]', password='password'
)
# reuse cookies generated by successful login before login,
# if `login_cookies_path` does not exist, it will process logining with `auth_type`, and save cookies to `login_cookies_path`
# only works when `auth_type` is `openai` or `google`
api = ChatGPT(auth_type='openai', email='[email protected]', password='password',
login_cookies_path='your_cookies_path',
)
resp = api.send_message('Hello, world!')
print(resp['message'])
api.reset_conversation() # reset the conversation
api.clear_conversations() # clear all conversations
api.refresh_chat_page() # refresh the chat page
```
## Frequently Asked Questions
### How do I get it to work on headless linux server?
```bash
# install chromium & X virtual framebuffer
sudo apt install chromium-browser xvfb
# start your script
python3 your_script.py
```
### How do I get it to work on Google Colab?
It is normal for the seession to crash when installing dependencies. Just ignore the error and run your script.
```python
# install dependencies
!apt install chromium-browser xvfb
!pip install -U selenium_profiles pyChatGPT
# install chromedriver
from selenium_profiles.utils.installer import install_chromedriver
install_chromedriver()
```
```python
# start your script as normal
!python3 -m pyChatGPT
```
## Insipration
This project is inspired by
- [ChatGPT](https://github.com/acheong08/ChatGPT)
- [chatgpt-api](https://github.com/transitive-bullshit/chatgpt-api)
## Disclaimer
This project is not affiliated with OpenAI in any way. Use at your own risk. I am not responsible for any damage caused by this project. Please read the [OpenAI Terms of Service](https://beta.openai.com/terms) before using this project.
## License
This project is licensed under the GPLv3 License - see the [LICENSE](LICENSE) file for details.