Notebook optimizations.

Optimizations for uplink prefs backup and restore notebooks, and the SSID limits checker notebook. Tweaked readme.

Author: TKIPisalegacycipher

notebooks/README.md

@@ -4,7 +4,7 @@
 
 Jupyter notebooks are documents that take coding in Python (and potentially other languages) to a whole new level. They are technically just fancy JSON files with a `.ipynb` extension, but with a Jupyter notebook and a compatible IDE, you can:
 
-1. Write, run and re-run code in a block-by-block basis, while keeping all variables in an active and *interactive* kernel space. Those blocks are called "cells."
+1. Write, run and re-run code in a block-by-block basis, while keeping all variables in an active and *interactive* kernel space. Those blocks are called "cells." If you're unfamiliar with Python debugging, it may be easier to use notebooks than debuggers!
 2. Combine executable code, rich text, HTML, and even images in a single document, going way beyond standard Python comments and inserting HTML- or Markdown-formatted documentation inline with code in a way that never interferes with the operation of your code.
 3. Rearrange code and Markdown cells aribitrarily for verification, experimentation, or pure curiosity.
 4. Much more, if you are willing to learn!
@@ -196,4 +196,4 @@ Select the cell, then hold `Ctrl` or `⌘` and type `MY`.
 
 ### Using VS Code
 
-Select the cell, then at the top of the cell click either `M` to convert to text, or `{}` to convert to code.
+Select the cell, then at the top of the cell click either `M` to convert to text, or `{}` to convert to code.

notebooks/merakiSSIDLimitsChecker.ipynb

@@ -32,30 +32,25 @@
    "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\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",
+    "# Rely on meraki SDK and os\n",
     "import meraki\n",
     "import os\n",
-    "import tablib\n",
-    "\n",
     "# We're also going to import Python's built-in JSON module, but only to make the console output pretty. In production, you wouldn't need any of the printing calls at all, nor this import!\n",
     "import json\n",
     "\n",
-    "# Setting API key this way, and storing it in the env variables, lets us keep the sensitive API key out of the script itself\n",
-    "# The meraki.DashboardAPI() method does not require explicitly passing this value; it will check the environment for a variable\n",
-    "# called 'MERAKI_DASHBOARD_API_KEY' on its own. In this case, API_KEY is shown simply as an reference to where that information is\n",
-    "# stored.\n",
-    "API_KEY = os.getenv('MERAKI_DASHBOARD_API_KEY')\n",
+    "# Treat your API key like a password. Store it in your environment variables as 'MERAKI_DASHBOARD_API_KEY' and let the SDK call it for you.\n",
+    "# Or, call it manually after importing Python's os module:\n",
+    "# API_KEY = os.getenv('MERAKI_DASHBOARD_API_KEY')\n",
     "\n",
     "# Initialize the Dashboard connection.\n",
-    "dashboard = meraki.DashboardAPI()"
+    "dashboard = meraki.DashboardAPI(suppress_logging=True)"
    ]
   },
   {
@@ -251,11 +246,13 @@
     "            # SSIDs are always numbered 1-15 (0-14 in the API)\n",
     "            for ssidNumber in range(15):\n",
     "                # Disable rule-based traffic shaping for that network's SSID\n",
+    "                print(f'Modifying {network[\"name\"]} and SSID number {ssidNumber}...')\n",
     "                dashboard.wireless.updateNetworkWirelessSsidTrafficShapingRules(\n",
     "                    network['id'],\n",
     "                    ssidNumber,\n",
     "                    rules=[]\n",
-    "                )"
+    "                )\n",
+    "                "
    ]
   },
   {
@@ -276,24 +273,25 @@
    "outputs": [],
    "source": [
     "# Re-used strings\n",
-    "CONFIRM_STRING = 'OK, are you sure you want to do this? This script does not have an \"undo\" feature.'\n",
-    "CANCEL_STRING = 'OK. Operation canceled.'\n",
-    "WORKING_STRING = 'Working...'\n",
-    "COMPLETE_STRING = 'Operation complete.'\n",
+    "string_constants = dict()\n",
+    "string_constants['CONFIRM'] = 'OK, are you sure you want to do this? This script does not have an \"undo\" feature.'\n",
+    "string_constants['CANCEL'] = 'OK. Operation canceled.'\n",
+    "string_constants['WORKING'] = 'Working...'\n",
+    "string_constants['COMPLETE'] = 'Operation complete.'\n",
     "\n",
     "# Let's give the user the option to clear those bandwidth limits\n",
     "if len(organization_ssids_with_limits):\n",
     "    print('Would you like to remove all SSID-level bandwidth limits?')\n",
     "    if input('([Y]es/[N]o):') in ['Y', 'y', 'Yes', 'yes', 'ye', 'Ye']:\n",
-    "        print(CONFIRM_STRING)\n",
+    "        print(string_constants['CONFIRM'])\n",
     "        if input('([Y]es/[N]o):') in ['Y', 'y', 'Yes', 'yes', 'ye', 'Ye']:\n",
-    "            print(WORKING_STRING)\n",
+    "            print(string_constants['WORKING'])\n",
     "            removeSsidLimits(organization_ssids_with_limits)\n",
-    "            print(COMPLETE_STRING)\n",
+    "            print(string_constants['COMPLETE'])\n",
     "        else:\n",
-    "            print(CANCEL_STRING)\n",
+    "            print(string_constants['CANCEL'])\n",
     "    else:\n",
-    "        print(CANCEL_STRING)"
+    "        print(string_constants['CANCEL'])"
    ]
   },
   {
@@ -314,15 +312,15 @@
     "# Let's also check if the user wants to take the extra step to remove all rule-based limits\n",
     "print('There may also be client bandwidth limits on custom traffic shaping rules. Would you also like to remove any and all custom traffic shaping rules? This may take some time depending on the size and quantity of your networks. This will not clear default traffic shaping rules.')\n",
     "if input('([Y]es/[N]o):') in ['Y', 'y', 'Yes', 'yes', 'ye', 'Ye']:\n",
-    "    print(CONFIRM_STRING)\n",
+    "    print(string_constants['CONFIRM'])\n",
     "    if input('([Y]es/[N]o):') in ['Y', 'y', 'Yes', 'yes', 'ye', 'Ye']:\n",
-    "        print(WORKING_STRING)\n",
+    "        print(string_constants['WORKING'])\n",
     "        removeCustomTrafficShapingRules()\n",
-    "        print(COMPLETE_STRING)\n",
+    "        print(string_constants['COMPLETE'])\n",
     "    else:\n",
-    "        print(CANCEL_STRING)\n",
+    "        print(string_constants['CANCEL'])\n",
     "else:\n",
-    "    print(CANCEL_STRING)\n",
+    "    print(string_constants['CANCEL'])\n",
     "        "
    ]
   },
@@ -336,17 +334,10 @@
     "\n",
     "[Meraki Interactive API Docs](https://developer.cisco.com/meraki/api-v1/#!overview): The official (and interactive!) Meraki API and SDK documentation repository on DevNet.\n",
     "\n",
-    "[VS Code](https://code.visualstudio.com/): An excellent code editor with full support for Python and Python notebooks.\n",
+    "[VS Code](https://code.visualstudio.com/): A code editor with full support for Python and some support for Python notebooks.\n",
     "\n",
     "[Automate the Boring Stuff with Python](https://automatetheboringstuff.com/): An excellent learning resource that puts the real-world problem first, then teaches you the Pythonic solution along the way."
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {
@@ -365,7 +356,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.4"
+   "version": "3.8.4-final"
   }
  },
  "nbformat": 4,