Further troubleshooting instructions, also a minor compatibility fix

week1/day1.ipynb

@@ -57,7 +57,9 @@
     "from dotenv import load_dotenv\n",
     "from bs4 import BeautifulSoup\n",
     "from IPython.display import Markdown, display\n",
-    "from openai import OpenAI"
+    "from openai import OpenAI\n",
+    "\n",
+    "# If you get an error like \"NameError\" running this cell, then please head over to the troubleshooting notebook!"
    ]
   },
   {
@@ -71,6 +73,10 @@
     "\n",
     "## Troubleshooting if you have problems:\n",
     "\n",
+    "Head over to the [troubleshooting](troubleshooting.ipynb) notebook in this folder for step by step code to identify the root cause and fix it!\n",
+    "\n",
+    "A summary of some points:\n",
+    "\n",
     "1. OpenAI takes a few minutes to register after you set up an account. If you receive an error about being over quota, try waiting a few minutes and try again.\n",
     "2. You'll need to set up billing and add the minimum amount of credit at this page [here](https://platform.openai.com/settings/organization/billing/overview). OpenAI requires a minimum of $5 to get started in the U.S. right now - this might be different for your region. You'll only need to use a fraction for this course. In my view, this is well worth the investment for your education and future projects - but if you have any concerns, you can skip this and watch me using OpenAI instead. In week 3 we will start to use free open-source models!\n",
     "3. Also, double check you have the right kind of API token with the right permissions. You should find it on [this webpage](https://platform.openai.com/api-keys) and it should show with Permissions of \"All\". If not, try creating another key by:\n",
@@ -79,8 +85,7 @@
     "- Click Create secret key, and use that new key in the code and the `.env` file (it might take a few minutes to activate)\n",
     "- Do a Kernel >> Restart kernel, and execute the cells in this Jupyter lab starting at the top\n",
     "4. As a fallback, replace the line `openai = OpenAI()` with `openai = OpenAI(api_key=\"your-key-here\")` - while it's not recommended to hard code tokens in Jupyter lab, because then you can't share your lab with others, it's a workaround for now\n",
-    "5. See the [troubleshooting](troubleshooting.ipynb) notebook in this folder for more instructions\n",
-    "6. Contact me! Message me or email ed@edwarddonner.com and we will get this to work.\n",
+    "5. Contact me! Message me or email ed@edwarddonner.com and we will get this to work.\n",
     "\n",
     "Any concerns about API costs? See my notes in the README - costs should be minimal, and you can control it at every point."
    ]
@@ -95,10 +100,31 @@
     "# Load environment variables in a file called .env\n",
     "\n",
     "load_dotenv()\n",
-    "os.environ['OPENAI_API_KEY'] = os.getenv('OPENAI_API_KEY', 'your-key-if-not-using-env')\n",
+    "api_key = os.getenv('OPENAI_API_KEY')\n",
+    "\n",
+    "# Check the key\n",
+    "\n",
+    "if not api_key:\n",
+    "    print(\"No API key was found - please head over to the troubleshooting notebook in this folder to identify & fix!\")\n",
+    "elif api_key[:8]!=\"sk-proj-\":\n",
+    "    print(\"An API key was found, but it doesn't start sk-proj-; please check you're using the right key\")\n",
+    "elif api_key.strip() != api_key:\n",
+    "    print(\"An API key was found, but it looks like it might have space or tab characters at the start or end - please remove them\")\n",
+    "else:\n",
+    "    print(\"API key found and looks good so far!\")\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "019974d9-f3ad-4a8a-b5f9-0a3719aea2d3",
+   "metadata": {},
+   "outputs": [],
+   "source": [
     "openai = OpenAI()\n",
     "\n",
-    "# See the troubleshooting notebook, ot try the below line instead if this gives you any problems:\n",
+    "# If this doesn't work, try Kernel menu >> Restart Kernel and Clear Outputs Of All Cells, then run the cells from the top of this notebook down.\n",
+    "# If it STILL doesn't work (horrors!) then please see the troubleshooting notebook, ot try the below line instead:\n",
     "# openai = OpenAI(api_key=\"your-key-here\")"
    ]
   },