export

Author: jph00

00_core.ipynb

@@ -804,6 +804,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "#export\n",
     "def paged(oper, *args, per_page=30, max_pages=9999, **kwargs):\n",
     "    \"Convert operation `oper(*args,**kwargs)` into an iterator\"\n",
     "    yield from itertools.takewhile(noop, (oper(*args, per_page=per_page, page=i) for i in range(1,max_pages+1)))"

docs/core.html

@@ -842,26 +842,39 @@ <h3 id="Paged-operations">Paged operations<a class="anchor-link" href="#Paged-op
 
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
-<p>However, <code>per_page</code> has a maximum of <code>100</code>, so if you want more, you'll have to pass <code>page=</code> to get pages beyond the first. An easy way to iterate through all pages is to use <code>paged</code>.</p>
+<p>However, <code>per_page</code> has a maximum of <code>100</code>, so if you want more, you'll have to pass <code>page=</code> to get pages beyond the first. An easy way to iterate through all pages is to use <a href="/core.html#paged"><code>paged</code></a>.</p>
 
 </div>
 </div>
 </div>
     {% 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="k">def</span> <span class="nf">paged</span><span class="p">(</span><span class="n">oper</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">per_page</span><span class="o">=</span><span class="mi">30</span><span class="p">,</span> <span class="n">max_pages</span><span class="o">=</span><span class="mi">9999</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
-    <span class="s2">&quot;Convert operation `oper(*args,**kwargs)` into an iterator&quot;</span>
-    <span class="k">yield from</span> <span class="n">itertools</span><span class="o">.</span><span class="n">takewhile</span><span class="p">(</span><span class="n">noop</span><span class="p">,</span> <span class="p">(</span><span class="n">oper</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="n">per_page</span><span class="o">=</span><span class="n">per_page</span><span class="p">,</span> <span class="n">page</span><span class="o">=</span><span class="n">i</span><span class="p">)</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span><span class="n">max_pages</span><span class="o">+</span><span class="mi">1</span><span class="p">)))</span>
-</pre></div>
+<div class="output_wrapper">
+<div class="output">
 
-    </div>
+<div class="output_area">
+
+
+<div class="output_markdown rendered_html output_subarea ">
+<h4 id="paged" class="doc_header"><code>paged</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L119" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>paged</code>(<strong><code>oper</code></strong>, <strong>*<code>args</code></strong>, <strong><code>per_page</code></strong>=<em><code>30</code></em>, <strong><code>max_pages</code></strong>=<em><code>9999</code></em>, <strong>**<code>kwargs</code></strong>)</p>
+</blockquote>
+<p>Convert operation <code>oper(*args,**kwargs)</code> into an iterator</p>
+
+</div>
+
+</div>
+
+</div>
 </div>
+
 </div>
+    {% endraw %}
+
+    {% raw %}
+    
+<div class="cell border-box-sizing code_cell rendered">
 
 </div>
     {% endraw %}
@@ -942,7 +955,7 @@ <h3 id="Paged-operations">Paged operations<a class="anchor-link" href="#Paged-op
 
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
-<p>To convert this operation into a Python iterator, pass the operation itself, along with any arguments (either keyword or positional) to <code>paged</code>:</p>
+<p>To convert this operation into a Python iterator, pass the operation itself, along with any arguments (either keyword or positional) to <a href="/core.html#paged"><code>paged</code></a>:</p>
 
 </div>
 </div>
@@ -1029,7 +1042,7 @@ <h3 id="Preview-endpoints">Preview endpoints<a class="anchor-link" href="#Previe
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="print_summary" class="doc_header"><code>print_summary</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L119" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>print_summary</code>(<strong><code>req</code></strong>:<code>Request</code>)</p>
+<h4 id="print_summary" class="doc_header"><code>print_summary</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L124" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>print_summary</code>(<strong><code>req</code></strong>:<code>Request</code>)</p>
 </blockquote>
 <p>Print <code>Request.summary</code> with the token (if any) removed</p>
 
@@ -1144,7 +1157,7 @@ <h3 id="Releases">Releases<a class="anchor-link" href="#Releases"> </a></h3>
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.upload_file" class="doc_header"><code>GhApi.upload_file</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L131" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.upload_file</code>(<strong><code>rel</code></strong>, <strong><code>fn</code></strong>)</p>
+<h4 id="GhApi.upload_file" class="doc_header"><code>GhApi.upload_file</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L136" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.upload_file</code>(<strong><code>rel</code></strong>, <strong><code>fn</code></strong>)</p>
 </blockquote>
 <p>Upload <code>fn</code> to endpoint for release <code>rel</code></p>
 
@@ -1176,7 +1189,7 @@ <h4 id="GhApi.upload_file" class="doc_header"><code>GhApi.upload_file</code><a h
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.create_release" class="doc_header"><code>GhApi.create_release</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L140" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.create_release</code>(<strong><code>tag_name</code></strong>, <strong><code>branch</code></strong>=<em><code>'master'</code></em>, <strong><code>name</code></strong>=<em><code>None</code></em>, <strong><code>body</code></strong>=<em><code>''</code></em>, <strong><code>draft</code></strong>=<em><code>False</code></em>, <strong><code>prerelease</code></strong>=<em><code>False</code></em>, <strong><code>files</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="GhApi.create_release" class="doc_header"><code>GhApi.create_release</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L145" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.create_release</code>(<strong><code>tag_name</code></strong>, <strong><code>branch</code></strong>=<em><code>'master'</code></em>, <strong><code>name</code></strong>=<em><code>None</code></em>, <strong><code>body</code></strong>=<em><code>''</code></em>, <strong><code>draft</code></strong>=<em><code>False</code></em>, <strong><code>prerelease</code></strong>=<em><code>False</code></em>, <strong><code>files</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 <p>Wrapper for <a href="/core.html#GhApi.repos.create_release"><code>GhApi.repos.create_release</code></a> which also uploads <code>files</code></p>
 
@@ -1277,7 +1290,7 @@ <h4 id="GhApi.create_release" class="doc_header"><code>GhApi.create_release</cod
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.delete_release" class="doc_header"><code>GhApi.delete_release</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L124" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_release</code>(<strong><code>release</code></strong>)</p>
+<h4 id="GhApi.delete_release" class="doc_header"><code>GhApi.delete_release</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L129" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_release</code>(<strong><code>release</code></strong>)</p>
 </blockquote>
 <p>Delete a release and its associated tag</p>
 
@@ -1308,7 +1321,7 @@ <h3 id="Branches-and-tags">Branches and tags<a class="anchor-link" href="#Branch
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.list_tags" class="doc_header"><code>GhApi.list_tags</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L151" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_tags</code>(<strong><code>prefix</code></strong>:<code>str</code>=<em><code>''</code></em>)</p>
+<h4 id="GhApi.list_tags" class="doc_header"><code>GhApi.list_tags</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L156" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_tags</code>(<strong><code>prefix</code></strong>:<code>str</code>=<em><code>''</code></em>)</p>
 </blockquote>
 <p>List all tags, optionally filtered to those starting with <code>prefix</code></p>
 
@@ -1388,7 +1401,7 @@ <h4 id="GhApi.list_tags" class="doc_header"><code>GhApi.list_tags</code><a href=
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.list_branches" class="doc_header"><code>GhApi.list_branches</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L157" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_branches</code>(<strong><code>prefix</code></strong>:<code>str</code>=<em><code>''</code></em>)</p>
+<h4 id="GhApi.list_branches" class="doc_header"><code>GhApi.list_branches</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L162" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_branches</code>(<strong><code>prefix</code></strong>:<code>str</code>=<em><code>''</code></em>)</p>
 </blockquote>
 <p>List all branches, optionally filtered to those starting with <code>prefix</code></p>
 
@@ -1476,7 +1489,7 @@ <h4 id="GhApi.list_branches" class="doc_header"><code>GhApi.list_branches</code>
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.create_branch_empty" class="doc_header"><code>GhApi.create_branch_empty</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L167" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.create_branch_empty</code>(<strong><code>branch</code></strong>)</p>
+<h4 id="GhApi.create_branch_empty" class="doc_header"><code>GhApi.create_branch_empty</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L172" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.create_branch_empty</code>(<strong><code>branch</code></strong>)</p>
 </blockquote>
 
 </div>
@@ -1525,7 +1538,7 @@ <h4 id="GhApi.create_branch_empty" class="doc_header"><code>GhApi.create_branch_
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.delete_tag" class="doc_header"><code>GhApi.delete_tag</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L173" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_tag</code>(<strong><code>tag</code></strong>:<code>str</code>)</p>
+<h4 id="GhApi.delete_tag" class="doc_header"><code>GhApi.delete_tag</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L178" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_tag</code>(<strong><code>tag</code></strong>:<code>str</code>)</p>
 </blockquote>
 <p>Delete a tag</p>
 
@@ -1557,7 +1570,7 @@ <h4 id="GhApi.delete_tag" class="doc_header"><code>GhApi.delete_tag</code><a hre
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.delete_branch" class="doc_header"><code>GhApi.delete_branch</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L179" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_branch</code>(<strong><code>branch</code></strong>:<code>str</code>)</p>
+<h4 id="GhApi.delete_branch" class="doc_header"><code>GhApi.delete_branch</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L184" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.delete_branch</code>(<strong><code>branch</code></strong>:<code>str</code>)</p>
 </blockquote>
 <p>Delete a branch</p>
 
@@ -1607,7 +1620,7 @@ <h4 id="GhApi.delete_branch" class="doc_header"><code>GhApi.delete_branch</code>
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.get_branch" class="doc_header"><code>GhApi.get_branch</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L185" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.get_branch</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="GhApi.get_branch" class="doc_header"><code>GhApi.get_branch</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L190" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.get_branch</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 
 </div>
@@ -1644,7 +1657,7 @@ <h3 id="Content-(git-files)">Content (git files)<a class="anchor-link" href="#Co
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.list_files" class="doc_header"><code>GhApi.list_files</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L191" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_files</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="GhApi.list_files" class="doc_header"><code>GhApi.list_files</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L196" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.list_files</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 
 </div>
@@ -1716,7 +1729,7 @@ <h4 id="GhApi.list_files" class="doc_header"><code>GhApi.list_files</code><a hre
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.get_content" class="doc_header"><code>GhApi.get_content</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L198" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.get_content</code>(<strong><code>path</code></strong>)</p>
+<h4 id="GhApi.get_content" class="doc_header"><code>GhApi.get_content</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L203" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.get_content</code>(<strong><code>path</code></strong>)</p>
 </blockquote>
 
 </div>
@@ -1765,7 +1778,7 @@ <h4 id="GhApi.get_content" class="doc_header"><code>GhApi.get_content</code><a h
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.update_contents" class="doc_header"><code>GhApi.update_contents</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L204" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.update_contents</code>(<strong><code>path</code></strong>, <strong><code>message</code></strong>=<em><code>None</code></em>, <strong><code>content</code></strong>=<em><code>None</code></em>, <strong><code>sha</code></strong>=<em><code>None</code></em>, <strong><code>branch</code></strong>=<em><code>None</code></em>, <strong><code>committer</code></strong>=<em><code>None</code></em>, <strong><code>author</code></strong>=<em><code>None</code></em>)</p>
+<h4 id="GhApi.update_contents" class="doc_header"><code>GhApi.update_contents</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L209" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.update_contents</code>(<strong><code>path</code></strong>, <strong><code>message</code></strong>=<em><code>None</code></em>, <strong><code>content</code></strong>=<em><code>None</code></em>, <strong><code>sha</code></strong>=<em><code>None</code></em>, <strong><code>branch</code></strong>=<em><code>None</code></em>, <strong><code>committer</code></strong>=<em><code>None</code></em>, <strong><code>author</code></strong>=<em><code>None</code></em>)</p>
 </blockquote>
 
 </div>
@@ -1849,7 +1862,7 @@ <h4 id="GhApi.update_contents" class="doc_header"><code>GhApi.update_contents</c
 
 
 <div class="output_markdown rendered_html output_subarea ">
-<h4 id="GhApi.enable_pages" class="doc_header"><code>GhApi.enable_pages</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L214" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.enable_pages</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>, <strong><code>path</code></strong>=<em><code>'/'</code></em>)</p>
+<h4 id="GhApi.enable_pages" class="doc_header"><code>GhApi.enable_pages</code><a href="https://github.com/fastai/ghapi/tree/master/ghapi/core.py#L219" class="source_link" style="float:right">[source]</a></h4><blockquote><p><code>GhApi.enable_pages</code>(<strong><code>branch</code></strong>=<em><code>None</code></em>, <strong><code>path</code></strong>=<em><code>'/'</code></em>)</p>
 </blockquote>
 <p>Enable or update pages for a repo to point to a <code>branch</code> and <code>path</code>.</p>
 

ghapi/_nbdev.py

@@ -4,6 +4,7 @@
 
 index = {"GH_HOST": "00_core.ipynb",
          "GhApi": "00_core.ipynb",
+         "paged": "00_core.ipynb",
          "print_summary": "00_core.ipynb",
          "GhApi.delete_release": "00_core.ipynb",
          "GhApi.upload_file": "00_core.ipynb",

ghapi/core.py

@@ -1,6 +1,6 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: 00_core.ipynb (unless otherwise specified).
 
-__all__ = ['GH_HOST', 'GhApi', 'print_summary', 'EMPTY_TREE_SHA']
+__all__ = ['GH_HOST', 'GhApi', 'paged', 'print_summary', 'EMPTY_TREE_SHA']
 
 # Cell
 from fastcore.utils import *
@@ -115,6 +115,11 @@ def __getitem__(self, k):
     def full_docs(self):
         return '\n'.join(f'## {gn}\n\n{group._repr_markdown_()}\n' for gn,group in sorted(self.groups.items()))
 
+# Cell
+def paged(oper, *args, per_page=30, max_pages=9999, **kwargs):
+    "Convert operation `oper(*args,**kwargs)` into an iterator"
+    yield from itertools.takewhile(noop, (oper(*args, per_page=per_page, page=i) for i in range(1,max_pages+1)))
+
 # Cell
 def print_summary(req:Request):
     "Print `Request.summary` with the token (if any) removed"