gh_date

Author: jph00

00_core.ipynb

@@ -28,13 +28,14 @@
     "from fastcore.utils import *\n",
     "from fastcore.foundation import *\n",
     "from fastcore.meta import *\n",
+    "from ghapi.metadata import funcs\n",
     "\n",
     "import inspect,json,copy,urllib,mimetypes,base64\n",
     "from inspect import signature,Parameter,Signature\n",
     "from urllib.parse import urlencode\n",
-    "from ghapi.metadata import funcs\n",
     "from urllib.request import Request,urlretrieve\n",
     "from urllib.error import HTTPError\n",
+    "from datetime import datetime,timedelta\n",
     "from pprint import pprint"
    ]
   },
@@ -447,7 +448,7 @@
        "- [users](https://docs.github.com/en/free-pro-team@latest/rest/reference/users)"
       ],
       "text/plain": [
-       "<__main__.GhApi at 0x7f496e622e10>"
+       "<__main__.GhApi at 0x7ff9b02eb190>"
       ]
      },
      "execution_count": null,
@@ -597,7 +598,7 @@
        "- [git.get_tree](https://docs.github.com/rest/reference/git#get-a-tree)(tree_sha, recursive): *Get a tree*"
       ],
       "text/plain": [
-       "<__main__._GhVerbGroup at 0x7f496e3f2690>"
+       "<__main__._GhVerbGroup at 0x7ff9b01b8d90>"
       ]
      },
      "execution_count": null,
@@ -904,6 +905,54 @@
     "for page in repos: print(len(page), page[0].name)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Convenience functions"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#exports\n",
+    "def gh_date(dt:datetime):\n",
+    "    \"Convert `dt` (which is assumed to be in UTC time zone) to a format suitable for GitHub API operations\"\n",
+    "    return f'{dt.replace(microsecond=0).isoformat()}Z'"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The GitHub API assumes that dates will be in a specific string format. `gh_date` converts Python standard `datetime` objects to that format. For instance, to find issues opened in the last week:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "1"
+      ]
+     },
+     "execution_count": null,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "dt = gh_date(datetime.utcnow() - timedelta(weeks=1))\n",
+    "issues = api.issues.list_for_repo(since=dt)\n",
+    "len(issues)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},