Added some documentation

Author: chriscarrollsmith

.env.example

@@ -1,2 +1,2 @@
-OPENAI_API_KEY=
+OPENAI_API_KEY=
 ASSISTANT_ID=

README.md

@@ -13,29 +13,21 @@ git clone https://github.com/Promptly-Technologies-LLC/openai-assistants-python-
 cd openai-assistants-python-quickstart
 ```
 
-### 2. Set your [OpenAI API key](https://platform.openai.com/api-keys)
-
-```shell
-cp .env.example .env
-```
-
-### 3. Install dependencies
+### 2. Install dependencies
 
 ```shell
 uv venv
 uv pip install -r pyproject.toml
 ```
 
-### 4. Create an assistant
+### 3. Run the FastAPI server
 
 ```shell
-uv run create_assistant.py
+uv run uvicorn main:app --host 0.0.0.0 --port 8000 --reload
 ```
 
-### 5. Run the FastAPI server
+### 4. Navigate to [http://localhost:8000](http://localhost:8000).
 
-```shell
-uv run uvicorn main:app --host 0.0.0.0 --port 8000 --reload
-```
+### 5. Set your OpenAI API key and create an assistant in the GUI
 
-### 6. Navigate to [http://localhost:8000](http://localhost:8000).
+If your OPENAI_API_KEY or ASSISTANT_ID are not set, you will be redirected to the setup page where you can set them. (The values will be saved in a .env file in the root of the project.) Once set, you will be redirected to the home page and can begin a chat session.

utils/create_assistant.py

@@ -52,20 +52,23 @@ def update_env_file(var_name: str, var_value: str, logger: logging.Logger):
         var_value: The value to set for the environment variable
         logger: Logger instance for output
     """
+    lines = []
+    # Read existing contents if file exists
     if os.path.exists('.env'):
         with open('.env', 'r') as env_file:
             lines = env_file.readlines()
 
         # Remove any existing line with this variable
         lines = [line for line in lines if not line.startswith(f"{var_name}=")]
+    else:
+        # Log when we're creating a new .env file
+        logger.info("Creating new .env file")
 
-        # Write back the modified lines
-        with open('.env', 'w') as env_file:
-            env_file.writelines(lines)
-
-    # Write the new variable to the .env file
-    with open('.env', 'a') as env_file:
+    # Write back all lines including the new variable
+    with open('.env', 'w') as env_file:
+        env_file.writelines(lines)
         env_file.write(f"{var_name}={var_value}\n")
+    
     logger.debug(f"Environment variable {var_name} written to .env: {var_value}")