Merge pull request #30 from marklogic/feature/more-notebook-improvements

Added more instructions to the example notebook

Author: rjrudin

examples/.gitignore

@@ -0,0 +1 @@
+.ipynb_checkpoints

examples/python-blog-post.ipynb

@@ -23,6 +23,12 @@
     "import requests\n",
     "from requests.auth import HTTPDigestAuth\n",
     "\n",
+    "# The App-Services app server in your MarkLogic instance is assumed to be on port 8000 and to require either 'digest' \n",
+    "# or 'digestbasic' authentication. If the app server uses a different kind of authentication, you will need to modify \n",
+    "# the two lines below that set the 'auth' fields for the admin and user sessions. The 'admin_session' is also used to \n",
+    "# connect to the MarkLogic Manage app server on port 8002, so the authentication strategy should be the same for the \n",
+    "# Manage and App-Services app servers.\n",
+    "\n",
     "admin_session = requests.Session()\n",
     "admin_session.auth = HTTPDigestAuth(adminUser, adminPassword)\n",
     "\n",
@@ -221,6 +227,9 @@
     "# Retrieve employees as JSON rows using an Optic query, printing the response from MarkLogic.\n",
     "# See https://docs.marklogic.com/11.0/guide/optic-guide/en/getting-started-with-optic.html for more information.\n",
     "\n",
+    "# If you run this and receive a \"SQL-TABLEREINDEXING\" error, that is simply because MarkLogic is still indexing the \n",
+    "# table that was created in the previous cell. Wait a few seconds and then try running the cell again.\n",
+    "\n",
     "optic_query = 'op.fromView(\"example\", \"employee\").where(op.eq(op.col(\"City\"), \"San Jose\"))'\n",
     "r = user_session.post(\n",
     "    f'{base_url}:8000/v1/rows?column-types=header', \n",
@@ -243,7 +252,10 @@
    "source": [
     "# Retrieve employees as CSV data and create a pandas DataFrame.\n",
     "\n",
+    "# The line below will install pandas; you can remove it if your Python environment already has pandas installed. If you \n",
+    "# leave it in, you can also ignore any warnings that appear about needing to restart the Jupyter kernel.\n",
     "%pip install pandas\n",
+    "\n",
     "import pandas as pd\n",
     "import io\n",
     "\n",