Skip to content

Commit

Permalink
deploy: 386cdb8
Browse files Browse the repository at this point in the history
  • Loading branch information
brownsarahm committed Apr 10, 2024
1 parent c724b58 commit d987171
Show file tree
Hide file tree
Showing 6 changed files with 173 additions and 10 deletions.
6 changes: 6 additions & 0 deletions api.html
Original file line number Diff line number Diff line change
Expand Up @@ -441,6 +441,12 @@ <h1>API<a class="headerlink" href="#api" title="Link to this heading">#</a></h1>
</dl>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="cspt.badges.generate_report">
<span class="sig-prename descclassname"><span class="pre">cspt.badges.</span></span><span class="sig-name descname"><span class="pre">generate_report</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">approved_prs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">short</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cspt.badges.generate_report" title="Link to this definition">#</a></dt>
<dd><p>format approved prs into a report</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="cspt.badges.is_title_gradeable">
<span class="sig-prename descclassname"><span class="pre">cspt.badges.</span></span><span class="sig-name descname"><span class="pre">is_title_gradeable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pr_title</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errortype</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#cspt.badges.is_title_gradeable" title="Link to this definition">#</a></dt>
Expand Down
59 changes: 58 additions & 1 deletion cli.html
Original file line number Diff line number Diff line change
Expand Up @@ -408,6 +408,29 @@ <h2>cspt<a class="headerlink" href="#cspt" title="Link to this heading">#</a></h
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cspt<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>COMMAND<span class="w"> </span><span class="o">[</span>ARGS<span class="o">]</span>...
</pre></div>
</div>
<section id="cspt-badgecounts">
<h3>badgecounts<a class="headerlink" href="#cspt-badgecounts" title="Link to this heading">#</a></h3>
<p>check if early bonus is met from output of
<cite>gh pr list -s all –json title,latestReviews,createdAt</cite> and return
a message. input from either a file or -for stdin</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cspt<span class="w"> </span>badgecounts<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>JSON_OUTPUT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-badgecounts-s">
<span id="cmdoption-cspt-badgecounts-soft"></span><span class="sig-name descname"><span class="pre">-s</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--soft</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-badgecounts-s" title="Link to this definition">#</a></dt>
<dd><p>soft check, skip title check</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-badgecounts-arg-JSON_OUTPUT">
<span class="sig-name descname"><span class="pre">JSON_OUTPUT</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-badgecounts-arg-JSON_OUTPUT" title="Link to this definition">#</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="cspt-createtoyfiles">
<h3>createtoyfiles<a class="headerlink" href="#cspt-createtoyfiles" title="Link to this heading">#</a></h3>
<p>from a yaml source file create a set of toy files with file names as the keys
Expand Down Expand Up @@ -438,6 +461,13 @@ <h3>earlybonus<a class="headerlink" href="#cspt-earlybonus" title="Link to this
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cspt<span class="w"> </span>earlybonus<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>JSON_OUTPUT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-earlybonus-y">
<span id="cmdoption-cspt-earlybonus-output-yaml"></span><span class="sig-name descname"><span class="pre">-y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-yaml</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-earlybonus-y" title="Link to this definition">#</a></dt>
<dd><p>output as yaml compatible with grading</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-earlybonus-arg-JSON_OUTPUT">
Expand Down Expand Up @@ -561,6 +591,27 @@ <h3>getbadgedate<a class="headerlink" href="#cspt-getbadgedate" title="Link to t
<span class="sig-name descname"><span class="pre">--practice</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-getbadgedate-practice" title="Link to this definition">#</a></dt>
<dd></dd></dl>

</section>
<section id="cspt-grade">
<h3>grade<a class="headerlink" href="#cspt-grade" title="Link to this heading">#</a></h3>
<p>calculate a grade from yaml that had keys of badges/bonuses and value for counts</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cspt<span class="w"> </span>grade<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>BADGE_FILE
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-grade-i">
<span id="cmdoption-cspt-grade-influence"></span><span class="sig-name descname"><span class="pre">-i</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--influence</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-grade-i" title="Link to this definition">#</a></dt>
<dd><p>return numerical instead of letter</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-grade-arg-BADGE_FILE">
<span class="sig-name descname"><span class="pre">BADGE_FILE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-grade-arg-BADGE_FILE" title="Link to this definition">#</a></dt>
<dd><p>Required argument</p>
</dd></dl>

</section>
<section id="cspt-kwlcsv">
<h3>kwlcsv<a class="headerlink" href="#cspt-kwlcsv" title="Link to this heading">#</a></h3>
Expand Down Expand Up @@ -666,7 +717,7 @@ <h3>progressreport<a class="headerlink" href="#cspt-progressreport" title="Link
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-r">
<span id="cmdoption-cspt-progressreport-report"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-progressreport-r" title="Link to this definition">#</a></dt>
<dd><p>process approved badges by type to a more descriptive report</p>
<dd><p>process approved badges by type to a more descriptive report</p>
</dd></dl>

<dl class="std option">
Expand All @@ -675,6 +726,12 @@ <h3>progressreport<a class="headerlink" href="#cspt-progressreport" title="Link
<dd><p>soft check, skip title check</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-b">
<span id="cmdoption-cspt-progressreport-brief"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--brief</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-progressreport-b" title="Link to this definition">#</a></dt>
<dd><p>short version of report</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-arg-JSON_OUTPUT">
Expand Down
15 changes: 14 additions & 1 deletion examples/standing.html
Original file line number Diff line number Diff line change
Expand Up @@ -451,7 +451,7 @@ <h3>cspt progressreport<a class="headerlink" href="#cspt-progressreport" title="
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-r">
<span id="cmdoption-cspt-progressreport-report"></span><span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-progressreport-r" title="Link to this definition">#</a></dt>
<dd><p>process approved badges by type to a more descriptive report</p>
<dd><p>process approved badges by type to a more descriptive report</p>
</dd></dl>

<dl class="std option">
Expand All @@ -460,6 +460,12 @@ <h3>cspt progressreport<a class="headerlink" href="#cspt-progressreport" title="
<dd><p>soft check, skip title check</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-b">
<span id="cmdoption-cspt-progressreport-brief"></span><span class="sig-name descname"><span class="pre">-b</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--brief</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-progressreport-b" title="Link to this definition">#</a></dt>
<dd><p>short version of report</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-progressreport-arg-JSON_OUTPUT">
Expand Down Expand Up @@ -556,6 +562,13 @@ <h3>cspt earlybonus<a class="headerlink" href="#cspt-earlybonus" title="Link to
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cspt<span class="w"> </span>earlybonus<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span>JSON_OUTPUT
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-earlybonus-y">
<span id="cmdoption-cspt-earlybonus-output-yaml"></span><span class="sig-name descname"><span class="pre">-y</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output-yaml</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-cspt-earlybonus-y" title="Link to this definition">#</a></dt>
<dd><p>output as yaml compatible with grading</p>
</dd></dl>

<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cspt-earlybonus-arg-JSON_OUTPUT">
Expand Down
Loading

0 comments on commit d987171

Please sign in to comment.