mv

Author: jph00

docs/_data/sidebars/home_sidebar.yml

@@ -10,7 +10,7 @@ entries:
       title: Overview
       url: /
     - output: web,pdf
-      title: ghtop
+      title: ghtop API
       url: ghtop.html
     output: web
     title: ghtop

docs/ghtop.html

@@ -1,21 +1,21 @@
 ---
 
-title: ghtop
+title: ghtop API
 
 
 keywords: fastai
 sidebar: home_sidebar
 
-summary: "I cannot believe this library name is not already taken on pypi."
-description: "I cannot believe this library name is not already taken on pypi."
-nb_path: "00_ghtop.ipynb"
+summary: "API details"
+description: "API details"
+nb_path: "nbs/00_ghtop.ipynb"
 ---
 <!--
 
 #################################################
 ### THIS FILE WAS AUTOGENERATED! DO NOT EDIT! ###
 #################################################
-# file to edit: 00_ghtop.ipynb
+# file to edit: nbs/00_ghtop.ipynb
 # command to build the docs after a change: nbdev_build_docs
 
 -->
@@ -126,28 +126,14 @@ <h4 id="github_auth_device" class="doc_header"><code>github_auth_device</code><a
 
 <div class="cell border-box-sizing code_cell rendered">
 
-</div>
-    {% endraw %}
-
-    {% raw %}
-    
-<div class="cell border-box-sizing code_cell rendered">
-
-</div>
-    {% endraw %}
-
-    {% raw %}
-    
-<div class="cell border-box-sizing code_cell rendered">
-
 <div class="output_wrapper">
 <div class="output">
 
 <div class="output_area">
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="limit_cb" class="doc_header"><code>limit_cb</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L57" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>limit_cb</code>(<strong><code>rem</code></strong>, <strong><code>quota</code></strong>)</p>
+<h4 id="limit_cb" class="doc_header"><code>limit_cb</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L43" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>limit_cb</code>(<strong><code>rem</code></strong>, <strong><code>quota</code></strong>)</p>
 </blockquote>
 <p>Callback to warn user when close to using up hourly quota</p>
 
@@ -191,16 +177,6 @@ <h4 id="limit_cb" class="doc_header"><code>limit_cb</code><a href="https://githu
     {% raw %}
 
 <div class="cell border-box-sizing code_cell rendered">
-<div class="input">
-
-<div class="inner_cell">
-    <div class="input_area">
-<div class=" highlight hl-ipython3"><pre><span></span><span class="n">api</span> <span class="o">=</span> <span class="n">GhApi</span><span class="p">(</span><span class="n">limit_cb</span><span class="o">=</span><span class="n">limit_cb</span><span class="p">,</span> <span class="n">token</span><span class="o">=</span><span class="n">token</span><span class="p">)</span>
-</pre></div>
-
-    </div>
-</div>
-</div>
 
 </div>
     {% endraw %}
@@ -216,7 +192,7 @@ <h4 id="limit_cb" class="doc_header"><code>limit_cb</code><a href="https://githu
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="fetch_events" class="doc_header"><code>fetch_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L66" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>fetch_events</code>(<strong><code>types</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="fetch_events" class="doc_header"><code>fetch_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L62" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>fetch_events</code>(<strong><code>types</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 <p>Generate an infinite stream of events optionally filtered to <code>types</code></p>
 
@@ -310,7 +286,7 @@ <h4 id="fetch_events" class="doc_header"><code>fetch_events</code><a href="https
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="print_event" class="doc_header"><code>print_event</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L96" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>print_event</code>(<strong><code>e</code></strong>, <strong><code>commits_counter</code></strong>)</p>
+<h4 id="print_event" class="doc_header"><code>print_event</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L92" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>print_event</code>(<strong><code>e</code></strong>, <strong><code>commits_counter</code></strong>)</p>
 </blockquote>
 
 </div>
@@ -391,7 +367,7 @@ <h4 id="print_event" class="doc_header"><code>print_event</code><a href="https:/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="tail_events" class="doc_header"><code>tail_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L108" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>tail_events</code>()</p>
+<h4 id="tail_events" class="doc_header"><code>tail_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L104" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>tail_events</code>()</p>
 </blockquote>
 <p>Print events from <a href="/ghtop/ghtop.html#fetch_events"><code>fetch_events</code></a> along with a counter of push events</p>
 
@@ -423,7 +399,7 @@ <h4 id="tail_events" class="doc_header"><code>tail_events</code><a href="https:/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="batch_events" class="doc_header"><code>batch_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L115" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>batch_events</code>(<strong><code>size</code></strong>, <strong><code>types</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="batch_events" class="doc_header"><code>batch_events</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L111" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>batch_events</code>(<strong><code>size</code></strong>, <strong><code>types</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 <p>Generate an infinite stream of batches of events of <code>size</code> optionally filtered to <code>types</code></p>
 
@@ -455,7 +431,7 @@ <h4 id="batch_events" class="doc_header"><code>batch_events</code><a href="https
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="watch_users" class="doc_header"><code>watch_users</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L121" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>watch_users</code>()</p>
+<h4 id="watch_users" class="doc_header"><code>watch_users</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L117" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>watch_users</code>()</p>
 </blockquote>
 <p>Print a table of the users with the most events</p>
 
@@ -487,7 +463,7 @@ <h4 id="watch_users" class="doc_header"><code>watch_users</code><a href="https:/
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="quad_logs" class="doc_header"><code>quad_logs</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L139" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>quad_logs</code>()</p>
+<h4 id="quad_logs" class="doc_header"><code>quad_logs</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L135" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>quad_logs</code>()</p>
 </blockquote>
 <p>Print 4 panels, showing most recent issues, commits, PRs, and releases</p>
 
@@ -519,7 +495,7 @@ <h4 id="quad_logs" class="doc_header"><code>quad_logs</code><a href="https://git
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="simple" class="doc_header"><code>simple</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L156" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>simple</code>()</p>
+<h4 id="simple" class="doc_header"><code>simple</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L152" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>simple</code>()</p>
 </blockquote>
 
 </div>
@@ -550,7 +526,7 @@ <h4 id="simple" class="doc_header"><code>simple</code><a href="https://github.co
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="main" class="doc_header"><code>main</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L168" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>main</code>(<strong><code>mode</code></strong>:"Operation mode to run")</p>
+<h4 id="main" class="doc_header"><code>main</code><a href="https://github.com/fastai/ghtop/tree/master/ghtop/ghtop.py#L164" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>main</code>(<strong><code>mode</code></strong>:"Operation mode to run")</p>
 </blockquote>
 
 </div>

docs/sidebar.json

@@ -1,6 +1,6 @@
 {
   "ghtop": {
     "Overview": "/",
-    "ghtop": "ghtop.html"
+    "ghtop API": "ghtop.html"
   }
 }

ghtop/_nbdev.py

@@ -5,7 +5,6 @@
 index = {"term": "00_ghtop.ipynb",
          "logfile": "00_ghtop.ipynb",
          "github_auth_device": "00_ghtop.ipynb",
-         "token": "00_ghtop.ipynb",
          "limit_cb": "00_ghtop.ipynb",
          "api": "00_ghtop.ipynb",
          "fetch_events": "00_ghtop.ipynb",

ghtop/ghtop.py

@@ -1,7 +1,7 @@
-# AUTOGENERATED! DO NOT EDIT! File to edit: 00_ghtop.ipynb (unless otherwise specified).
+# AUTOGENERATED! DO NOT EDIT! File to edit: nbs/00_ghtop.ipynb (unless otherwise specified).
 
-__all__ = ['term', 'logfile', 'github_auth_device', 'token', 'limit_cb', 'api', 'fetch_events', 'Events', 'seen',
-           'print_event', 'tail_events', 'batch_events', 'watch_users', 'quad_logs', 'simple', 'main']
+__all__ = ['term', 'logfile', 'github_auth_device', 'limit_cb', 'api', 'fetch_events', 'Events', 'seen', 'print_event',
+           'tail_events', 'batch_events', 'watch_users', 'quad_logs', 'simple', 'main']
 
 # Cell
 import time, sys, signal, shutil, os, json, enlighten, emoji, blessed
@@ -40,27 +40,23 @@ def _exit(msg):
     sys.exit()
 
 # Cell
-def _get_token():
+def limit_cb(rem,quota):
+    "Callback to warn user when close to using up hourly quota"
+    w='WARNING '*7
+    if rem < 1000: print(f"{w}\nRemaining calls: {rem} out of {quota}\n{w}", file=sys.stderr)
+
+# Cell
+def _get_api():
     path = Path.home()/".ghtop_token"
     if path.is_file():
         try: return path.read_text().strip()
         except: _exit("Error reading token")
 
     token = github_auth_device()
     path.write_text(token)
-    return token
-
-# Cell
-token = _get_token()
-
-# Cell
-def limit_cb(rem,quota):
-    "Callback to warn user when close to using up hourly quota"
-    w='WARNING '*7
-    if rem < 1000: print(f"{w}\nRemaining calls: {rem} out of {quota}\n{w}", file=sys.stderr)
+    return GhApi(limit_cb=limit_cb, token=token)
 
-# Cell
-api = GhApi(limit_cb=limit_cb, token=token)
+api = _get_api()
 
 # Cell
 def fetch_events(types=None):

00_ghtop.ipynb renamed to nbs/00_ghtop.ipynb

@@ -13,9 +13,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# ghtop\n",
+    "# ghtop API\n",
     "\n",
-    "> I cannot believe this library name is not already taken on pypi."
+    "> API details"
    ]
   },
   {
@@ -108,34 +108,6 @@
     "    sys.exit()"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": 58,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#export\n",
-    "def _get_token():\n",
-    "    path = Path.home()/\".ghtop_token\"\n",
-    "    if path.is_file():\n",
-    "        try: return path.read_text().strip()\n",
-    "        except: _exit(\"Error reading token\")\n",
-    "\n",
-    "    token = github_auth_device()\n",
-    "    path.write_text(token)\n",
-    "    return token"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 59,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#export\n",
-    "token = _get_token()"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": 60,
@@ -158,12 +130,22 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 61,
+   "execution_count": 81,
    "metadata": {},
    "outputs": [],
    "source": [
-    "#exports\n",
-    "api = GhApi(limit_cb=limit_cb, token=token)"
+    "#export\n",
+    "def _get_api():\n",
+    "    path = Path.home()/\".ghtop_token\"\n",
+    "    if path.is_file():\n",
+    "        try: return path.read_text().strip()\n",
+    "        except: _exit(\"Error reading token\")\n",
+    "\n",
+    "    token = github_auth_device()\n",
+    "    path.write_text(token)\n",
+    "    return GhApi(limit_cb=limit_cb, token=token)\n",
+    "\n",
+    "api = _get_api()"
    ]
   },
   {