Expanded Colab compatibility and readme

Author: TKIPisalegacycipher

.github/images/colab-notebook-colab_env-import-Annotation_2020-08-05_163815.png

@@ -17,7 +17,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In this first cell, we import the required meraki and os modules, and open the Dashboard API connection using the SDK."
+    "In this first cell, we install and import the required meraki and os modules, and open the Dashboard API connection using the SDK. Make sure you have [set up your environment variables first](https://github.com/meraki/dashboard-api-python/blob/master/notebooks/notebooksReadme.md)."
    ]
   },
   {
@@ -29,11 +29,21 @@
    "outputs": [
     {
      "output_type": "stream",
-     "name": "stderr",
-     "text": "meraki:     INFO > Meraki dashboard API session initialized with these parameters: {'version': '1.0.0b13', 'api_key': '************************************dfb9', 'base_url': 'https://api.meraki.com/api/v1', 'single_request_timeout': 60, 'certificate_path': '', 'requests_proxy': '', 'wait_on_rate_limit': True, 'nginx_429_retry_wait_time': 60, 'action_batch_retry_wait_time': 60, 'retry_4xx_error': False, 'retry_4xx_error_wait_time': 60, 'maximum_retries': 2, 'simulate': False, 'be_geo_id': None, 'caller': None}\n"
+     "name": "stdout",
+     "text": "Requirement already satisfied: meraki==1.0.0b15 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (1.0.0b15)\nRequirement already satisfied: aiohttp in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from meraki==1.0.0b15) (3.6.2)\nRequirement already satisfied: requests in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from meraki==1.0.0b15) (2.24.0)Note: you may need to restart the kernel to use updated packages.\nRequirement already satisfied: attrs>=17.3.0 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from aiohttp->meraki==1.0.0b15) (19.3.0)\nRequirement already satisfied: multidict<5.0,>=4.5 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from aiohttp->meraki==1.0.0b15) (4.7.6)\nRequirement already satisfied: chardet<4.0,>=2.0 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from aiohttp->meraki==1.0.0b15) (3.0.4)\nRequirement already satisfied: async-timeout<4.0,>=3.0 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from aiohttp->meraki==1.0.0b15) (3.0.1)\nRequirement already satisfied: yarl<2.0,>=1.0 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from aiohttp->meraki==1.0.0b15) (1.4.2)\nRequirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from requests->meraki==1.0.0b15) (1.25.9)\nRequirement already satisfied: certifi>=2017.4.17 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from requests->meraki==1.0.0b15) (2020.6.20)\nRequirement already satisfied: idna<3,>=2.5 in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (from requests->meraki==1.0.0b15) (2.10)\n\nWARNING: You are using pip version 20.1.1; however, version 20.2.1 is available.\nYou should consider upgrading via the 'C:\\Users\\john.kuchta\\AppData\\Local\\Programs\\Python\\Python38-32\\python.exe -m pip install --upgrade pip' command.\nWARNING: You are using pip version 20.1.1; however, version 20.2.1 is available.\nYou should consider upgrading via the 'C:\\Users\\john.kuchta\\AppData\\Local\\Programs\\Python\\Python38-32\\python.exe -m pip install --upgrade pip' command.\nRequirement already satisfied: tablib in c:\\users\\john.kuchta\\appdata\\local\\programs\\python\\python38-32\\lib\\site-packages (2.0.0)\nNote: you may need to restart the kernel to use updated packages.\n      meraki:     INFO > Meraki dashboard API session initialized with these parameters: {'version': '1.0.0b15', 'api_key': '************************************dfb9', 'base_url': 'https://api.meraki.com/api/v1', 'single_request_timeout': 60, 'certificate_path': '', 'requests_proxy': '', 'wait_on_rate_limit': True, 'nginx_429_retry_wait_time': 60, 'action_batch_retry_wait_time': 60, 'retry_4xx_error': False, 'retry_4xx_error_wait_time': 60, 'maximum_retries': 2, 'simulate': False, 'be_geo_id': None, 'caller': None}\n"
     }
    ],
    "source": [
+    "# Install the relevant modules. If you are using a local editor (e.g. VS Code, rather than Colab) you can run these commands, without the preceding %, via a terminal. NB: Run `pip install meraki==` to find the latest version of the Meraki SDK.\n",
+    "%pip install meraki==1.0.0b15\n",
+    "%pip install tablib\n",
+    "\n",
+    "# If you are using Google Colab, please ensure you have set up your environment variables as linked above, then delete the two lines of ''' to activate the following code:\n",
+    "'''\n",
+    "%pip install colab-env -qU\n",
+    "import colab_env\n",
+    "'''\n",
+    "\n",
     "# Rely on meraki SDK, os, and tablib -- more on tablib later\n",
     "import meraki\n",
     "import os\n",

.github/images/colab-notebook-colab_env-import-new-instance_Annotation_2020-08-05_163942.png

@@ -19,7 +19,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "In this first cell, we import the required meraki and os modules, and open the Dashboard API connection using the SDK."
+    "In this first cell, we install and import the required meraki and os modules, and open the Dashboard API connection using the SDK. Make sure you have [set up your environment variables first](https://github.com/meraki/dashboard-api-python/blob/master/notebooks/notebooksReadme.md)."
    ]
   },
   {
@@ -30,6 +30,16 @@
    },
    "outputs": [],
    "source": [
+    "# Install the relevant modules. If you are using a local editor (e.g. VS Code, rather than Colab) you can run these commands, without the preceding %, via a terminal. NB: Run `pip install meraki==` to find the latest version of the Meraki SDK.\n",
+    "%pip install meraki==1.0.0b15\n",
+    "%pip install tablib\n",
+    "\n",
+    "# If you are using Google Colab, please ensure you have set up your environment variables as linked above, then delete the two lines of ''' to activate the following code:\n",
+    "'''\n",
+    "%pip install colab-env -qU\n",
+    "import colab_env\n",
+    "'''\n",
+    "\n",
     "# Rely on meraki SDK, os, and tablib -- more on tablib later\n",
     "import meraki\n",
     "import os\n",