Documentation improvements and environment variables

Author: AlexSua

README.md

@@ -1,6 +1,9 @@
 <h1 align="center">ChatGPT Python SDK</h1>
-
-<br />
+<p align="center">
+    Library that allows developers to easily integrate the ChatGPT into their Python projects.
+    <br />
+    <br />
+</p>
 <p align="center">
     <a href="https://github.com/labteral/chatgpt-python/issues"><img alt="PyPi" src="https://img.shields.io/github/issues/labteral/chatgpt-python.svg?style=flat-square"></a>
     <a href="https://pypi.python.org/pypi/chatgpt/"><img alt="PyPi" src="https://img.shields.io/pypi/v/chatgpt.svg?style=flat-square"></a>
@@ -13,9 +16,8 @@
 pip install -U chatgpt
 ```
 
-
-## Create a file with your credentials
-> :warning: &nbsp; Please, update the library. Note the change in the config file.
+## Config
+### Create a file with your credentials
 
 Create the file `config.json` in your working directory: 
 ```json
@@ -40,14 +42,24 @@ Create the file `config.json` in your working directory:
     "email": "[email protected]",
     "password": "xxx",
 
-    //Timeout for requests made.
+    // Timeout per request.
     "timeout":300,
 
-    //Cache for saving the cookies and the state of the session.
-    "cache_file_path":"./path_and_filename"
+    // Cache for saving the cookies and the state of the session.
+    "cache_file_path":"/path/filename",
+
+    // Time for refresh the access token.
+    "access_token_seconds_to_expire":1800
 }
 ```
 
+## Environment variable
+You can specify the default configuration folder for chatgpt by setting the `CHATGPT_HOME` environment variable to the desired directory path.
+
+```bash
+export CHATGPT_HOME="/home/$USER/.config/chatgpt"
+```
+
 
 ## Usage
 ### CLI
@@ -65,6 +77,15 @@ These are the available commands:
 - `clear`: clear the terminal.
 - `exit`: exit the CLI.
 
+<br/>
+
+<div style="padding:0.2em;padding-top:0">
+
+![](img/cli_example.gif)
+
+</div>
+<br>
+
 ### SDK
 ```python
 #!/usr/bin/env python
@@ -74,19 +95,48 @@ from chatgpt import Conversation
 
 conversation = Conversation()
 
-# Python generator to stream the message in chunks.
-# the chunk give you a new part of the final message.
+# Stream the message as it arrives.
 for chunk in conversation.stream("We are going to start a conversation. I will speak English and you will speak Portuguese."):
-    # print chunk without line break
     print(chunk, end="")
-    # flush terminal output
     sys.stdout.flush()
 
-# this conversation chat instead is going to wait until the response is completely received.
+# Wait until the message is fully received.
 print(conversation.chat("What's the color of the sky?"))
 
 # The AI will forget it was speaking Portuguese
 conversation.reset()
 print(conversation.chat("What's the color of the sun?"))
 
 ```
+> it is recommended to use *stream* instead of *chat*.
+#### **Exceptions**:
+
+```python
+from chatgpt import ChatgptError, ChatgptErrorCodes
+
+try:
+
+    for chunk in conversation.stream("Hello, world!"):
+        print(chunk, end="")
+        sys.stdout.flush()
+
+except ChatgptError as chatgpt_error:
+
+    message = chatgpt_error.message
+    code = chatgpt_error.code
+
+    if code == ChatgptErrorCodes.INVALID_ACCESS_TOKEN:
+        print("Invalid token")
+
+```
+
+
+#### **Chatgpt Error codes:**
+
+- `INVALID_ACCESS_TOKEN`: This error code indicates that the access token provided to the chatbot's API is not valid or has expired.
+- `CHATGPT_API_ERROR`: This error code indicates that an error has occurred while making a request to the chatbot's API.
+- `CONFIG_FILE_ERROR`: This error code indicates that there is a problem with the configuration file for the chatbot.
+- `UNKNOWN_ERROR`: This error code is used when the cause of the error is unknown or cannot be determined.
+- `LOGIN_ERROR`: This error code indicates that there was a problem with the login process, such as an incorrect username or password.
+- `TIMEOUT_ERROR`: This error code indicates that a request to the chatbot's API has timed out.
+- `CONNECTION_ERROR`: This error code indicates that there is a problem with the connection to the chatbot's API.

chatgpt/__init__.py

@@ -3,4 +3,4 @@
 
 from .chatgpt import *
 
-__version__ = '2.2212.0'
+__version__ = '2.2214.0'