Switch to jupysql. Closes #2.

Author: jtkiley

notebooks/3a_retrieval3.ipynb

@@ -1,6 +1,7 @@
 {
  "cells": [
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -20,7 +21,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import os\n",
+    "from os import environ\n",
     "import urllib.parse\n",
     "\n",
     "from wrds.sql import (\n",
@@ -36,9 +37,9 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "CONN = (\n",
-    "    f\"postgresql://{os.environ['WRDS_USER']}:\"\n",
-    "    f\"{urllib.parse.quote_plus(os.environ['WRDS_PASS'])}@\"\n",
+    "environ[\"DATABASE_URL\"] = (\n",
+    "    f\"postgresql://{environ['WRDS_USER']}:\"\n",
+    "    f\"{urllib.parse.quote_plus(environ['WRDS_PASS'])}@\"\n",
     "    f\"{WRDS_POSTGRES_HOST}:{WRDS_POSTGRES_PORT}/\"\n",
     "    f\"{WRDS_POSTGRES_DB}\"\n",
     ")"
@@ -72,10 +73,11 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "%sql $CONN"
+    "%sql"
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -96,6 +98,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -170,6 +173,24 @@
     "df01.head()  # noqa: F821"
    ]
   },
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## *Aside: code testing*\n",
+    "\n",
+    "(Feel free to skip)\n",
+    "\n",
+    "You may have noticed the comment, `# noqa: F821`, in the method call above.\n",
+    "\n",
+    "This is a specially-formatted comment that tells my testing infrastructure to ignore (i.e. no quality assurance, or noqa, error for the type F821, which corresponds with a `NameError`).\n",
+    "The reason we need to capture it is that the code testing tool doesn't understand the `%%sql` magic commands, and it can't find where `df01` was previously defined.\n",
+    "\n",
+    "For a project of this scope and update frequency, it helps to have some automated testing that helps me catch when things stop working.\n",
+    "One part of that is supressing errors that happen for some technical or intended reason, to isolate real problemsf."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -181,6 +202,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -215,6 +237,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -248,6 +271,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -259,6 +283,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -297,6 +322,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -330,6 +356,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -343,6 +370,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -380,6 +408,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -394,6 +423,7 @@
    ]
   },
   {
+   "attachments": {},
    "cell_type": "markdown",
    "metadata": {},
    "source": [
@@ -440,7 +470,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.2"
+   "version": "3.11.3"
   },
   "vscode": {
    "interpreter": {

requirements.txt

@@ -2,7 +2,7 @@ beautifulsoup4==4.11.2
 geopandas==0.12.2
 geopy==2.3.0
 ipykernel==6.21.2
-ipython-sql==0.4.1
+jupysql==0.7.5
 nbconvert==7.2.9
 nbformat==5.7.3
 pandas==1.5.3