From 238d16038f6e43ca5f52e352cc7e7d4f1a8f6a1d Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Thu, 9 Nov 2023 03:19:31 +0000
Subject: [PATCH] Deployed 75f801d with MkDocs version: 1.5.3

---
 docs/CHANGELOG/index.html    |  10 +-
 docs/calcipy-banner-wide.svg |  20 ---
 docs/calcipy-banner.svg      |  20 ---
 docs/calcipy-square.svg      |  22 ---
 modules/calcipy/classes.svg  | 196 ++++++++++++-------------
 modules/calcipy/packages.svg | 272 +++++++++++++++++------------------
 search/search_index.json     |   2 +-
 sitemap.xml.gz               | Bin 556 -> 556 bytes
 8 files changed, 244 insertions(+), 298 deletions(-)
 delete mode 100644 docs/calcipy-banner-wide.svg
 delete mode 100644 docs/calcipy-banner.svg
 delete mode 100644 docs/calcipy-square.svg

diff --git a/docs/CHANGELOG/index.html b/docs/CHANGELOG/index.html
index 2e5c5b2e..d93e90c9 100644
--- a/docs/CHANGELOG/index.html
+++ b/docs/CHANGELOG/index.html
@@ -1443,7 +1443,14 @@
     Unreleased
   </a>
   
-    <nav class="md-nav" aria-label="Unreleased">
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#202-2023-11-08" class="md-nav__link">
+    2.0.2 (2023-11-08)
+  </a>
+  
+    <nav class="md-nav" aria-label="2.0.2 (2023-11-08)">
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
@@ -3271,6 +3278,7 @@
   <h1>Docs</h1>
 
 <h2 id="unreleased">Unreleased<a class="headerlink" href="#unreleased" title="Permanent link">⚓︎</a></h2>
+<h2 id="202-2023-11-08">2.0.2 (2023-11-08)<a class="headerlink" href="#202-2023-11-08" title="Permanent link">⚓︎</a></h2>
 <h3 id="refactor">Refactor<a class="headerlink" href="#refactor" title="Permanent link">⚓︎</a></h3>
 <ul>
 <li>copier-auto-update</li>
diff --git a/docs/calcipy-banner-wide.svg b/docs/calcipy-banner-wide.svg
deleted file mode 100644
index f85e9217..00000000
--- a/docs/calcipy-banner-wide.svg
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="700px" height="179px" viewBox="0 0 700 179" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-    <!-- Generator: Sketch 56.3 (81716) - https://sketch.com -->
-    <title>calcipy-banner-wide</title>
-    <desc>Created with Sketch.</desc>
-    <defs>
-        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
-            <stop stop-color="#FF2B41" offset="0%"></stop>
-            <stop stop-color="#53D5EC" offset="100%"></stop>
-            <stop stop-color="#F98F00" offset="100%"></stop>
-        </linearGradient>
-    </defs>
-    <g id="calcipy-banner-wide" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
-        <rect fill="#002795" x="0" y="0" width="700" height="179"></rect>
-        <text id="CALCIPY" fill-opacity="0.75" fill="#FFEAC9" font-family="Helvetica" font-size="90" font-weight="normal">
-            <tspan x="268" y="123">CALCIPY</tspan>
-        </text>
-        <path d="M124.078065,220 C122.288919,200.470736 97.382871,188.430988 89.3743129,184.19164 C79.5766088,178.991373 59.5268145,181.365408 53.1654066,171.332284 C46.8039988,161.29916 41.0673721,156.042368 34.7059642,149.937707 C28.3445564,143.833046 32.1500414,136.004383 33.4280028,127.158277 C34.7059642,118.340433 30.2472989,108.56167 25.1354533,102.202648 C20.0520069,95.8436256 12.4126376,97.4828402 10.481496,92.7347703 C8.57875345,87.9867004 12.3842385,86.4040105 20.676788,87.9867004 C28.9693375,89.5693904 34.6775651,97.4828402 41.6921532,102.202648 C48.7067413,106.922455 45.5260374,120.149221 43.5948957,131.228051 C41.6921532,142.306881 48.6783422,143.352587 56.3177114,149.909445 C63.9570806,156.466303 63.9570806,150.729052 63.9570806,145.472261 C63.9570806,140.187207 58.8736342,128.599655 59.4984153,120.686205 C60.1231965,112.772756 47.4003808,87.9867004 41.0389729,75.3251808 C34.6775651,62.6636612 24.4822731,53.1675215 18.7456463,49.4651575 C13.0090196,45.7627935 17.4676849,32.055568 19.3704275,25.187824 C21.27317,18.3200801 11.7310582,4.61285465 13.6338008,-0.672199308 C15.5365433,-5.95725326 22.5511314,-0.672199308 27.6345778,5.65856051 C32.7180243,11.9893203 28.9125392,11.9893203 30.8152818,20.4397542 C32.7180243,28.890188 27.6345778,28.353204 27.6345778,36.8036378 C27.6345778,45.2540717 41.0105738,46.8367616 47.3719816,59.4982813 C53.7333895,72.1598009 51.8306469,47.3737457 53.1086083,41.0429859 C54.3865697,34.7122261 56.9424925,29.9641562 65.2066429,28.3814663 C73.4991924,26.7987763 72.8460121,34.175242 68.3873468,35.2492102 C63.9286815,36.3231784 67.1093854,39.460296 67.7625657,50.0304039 C68.3873468,60.5722494 63.9286815,70.6053733 63.3039004,75.8904272 C62.6791193,81.1754812 67.7625657,82.221187 68.3873468,102.23091 C69.012128,122.268895 76.6798963,104.350584 84.9440467,93.2717544 C93.2365962,82.1929247 88.1247506,82.7299088 88.1247506,79.5645289 C88.1247506,76.399149 76.0267161,67.9487151 78.5826389,60.5722494 C81.1385617,53.1957838 90.6806734,57.9438536 95.7641199,61.1092335 C100.847566,64.2746134 97.6668624,63.7376294 103.403489,72.1880632 C109.140116,80.6384971 104.02827,90.1346368 95.7641199,104.378846 C87.4715704,118.623056 77.3046775,120.205746 76.6514972,140.271994 C76.0267161,160.338241 92.5834159,168.73215 105.959412,179.273996 C119.335408,189.815842 125.072035,194.563911 125.696816,188.233152 C126.321597,181.902392 119.960189,167.121198 118.057446,156.579353 C116.154704,146.037507 112.32082,141.289437 110.304481,135.467399 C108.288142,129.673623 105.959412,120.177484 112.945601,115.938136 C119.960189,111.72705 118.029047,130.719329 123.765674,138.095795 C129.502301,145.472261 132.683005,135.976121 130.780262,123.851585 C128.87752,111.72705 131.405043,99.5742519 123.765674,83.7473523 C116.126305,67.9204528 98.9164246,55.7959173 91.2770554,42.0886918 C83.6376862,28.3814663 77.9010594,25.7248081 70.2616902,17.8113584 C62.622321,9.8979086 60.7195784,-0.643936988 59.441617,-7.5116809 C58.1636556,-14.3794248 64.5250635,-20.1732005 67.8477631,-23.3385804 C71.1420636,-26.5039603 79.1790208,-20.7101846 71.5396516,-16.4708365 C63.9002824,-12.2314884 70.2616902,-12.2597508 71.5396516,-2.22662694 C72.817613,7.80649687 87.4715704,9.8979086 95.1109396,21.5137224 C102.750309,33.1295361 114.848343,46.2997775 115.501524,50.5391256 C116.126305,54.7502114 124.418854,52.1218156 123.794073,44.2083658 C123.169292,36.294916 119.335408,35.2492102 113.598781,26.2617922 C107.862154,17.3026366 109.764897,13.6002726 112.974,8.31521865 C116.154704,3.03016469 119.988588,6.73252869 119.988588,15.6916843 C119.988588,24.65084 124.447253,25.7248081 128.281138,30.9815998 C132.115022,36.2666537 136.573687,27.8162199 134.017764,18.8570642 C131.461842,9.8979086 133.392983,-2.25488926 129.559099,-9.63135494 C125.725215,-17.0078206 119.363807,-24.9212704 110.361279,-31.7890143 C101.330352,-38.6567582 102.182326,-42.3308599 102.835506,-49.1986038 C103.460287,-56.0663477 113.655579,-52.9009678 114.30876,-45.4962398 C114.96194,-38.0915118 116.864682,-32.2977361 127.684756,-28.0866503 C138.504829,-23.8755645 146.797378,-20.1732005 150.602863,-7.5116809 C154.408348,5.14983874 146.768979,-1.71790517 146.768979,14.6459785 C146.768979,31.0098621 161.422937,12.5263044 169.062306,7.26951278 C176.701675,1.98445883 179.257598,-6.9746968 177.809242,-12.7684725 C176.360885,-18.5622483 186.243787,-19.0992323 193.883156,-12.7684725 C201.522525,-6.43771271 198.966602,-1.68964285 191.298834,5.68682283 C183.631066,13.0632885 169.033907,24.1421182 156.935872,33.6382579 C144.837838,43.1343976 144.837838,52.6305374 142.281915,63.709367 C139.725992,74.7881967 139.101211,80.5819724 142.906696,85.3300423 C146.74058,90.0781122 147.990142,84.7930582 156.907473,78.9992825 C165.824804,73.2055068 163.922061,70.5488486 167.102765,66.3377629 C170.283469,62.1266771 176.644877,43.6431194 177.780842,29.2575982 C178.888409,14.872077 195.132718,28.353204 193.854757,49.4368951 C192.576795,70.5488486 170.283469,81.6276783 158.838615,93.7522138 C147.365361,105.876749 156.282692,109.579113 158.213833,116.446857 C160.116576,123.314601 165.228422,123.823323 171.589829,120.657943 C177.951237,117.492563 171.589829,120.657943 183.687864,108.533408 C195.785899,96.408872 183.687864,94.2891979 183.063083,87.421454 C182.438302,80.5537101 186.896967,72.6402603 191.327233,68.9661587 C195.757499,65.2637947 201.550924,68.4291746 200.897744,75.2969185 C200.272963,82.1646624 195.814298,81.6276783 195.814298,90.5868339 C195.814298,99.5459896 197.71704,100.082974 208.537113,93.7522138 C219.357187,87.421454 222.53789,49.9738792 221.913109,36.7753755 C221.288328,23.5768718 238.469809,30.4446157 244.831217,36.7753755 C251.192625,43.1061353 242.928475,61.0527089 228.274517,96.3806097 C213.62056,131.736773 155.68631,141.741634 151.227644,152.28348 C148.302533,159.207748 143.900666,169.664807 140.77676,218.954294" id="Coral" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
-    </g>
-</svg>
diff --git a/docs/calcipy-banner.svg b/docs/calcipy-banner.svg
deleted file mode 100644
index 304b58bb..00000000
--- a/docs/calcipy-banner.svg
+++ /dev/null
@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="403px" height="129px" viewBox="0 0 403 129" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-    <!-- Generator: Sketch 56.3 (81716) - https://sketch.com -->
-    <title>calcipy-banner</title>
-    <desc>Created with Sketch.</desc>
-    <defs>
-        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
-            <stop stop-color="#FF2B41" offset="0%"></stop>
-            <stop stop-color="#53D5EC" offset="100%"></stop>
-            <stop stop-color="#F98F00" offset="100%"></stop>
-        </linearGradient>
-    </defs>
-    <g id="calcipy-banner" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
-        <rect fill="#002795" x="0" y="0" width="403" height="129"></rect>
-        <text id="CALCIPY" fill-opacity="0.85" fill="#FFEAC9" font-family="Helvetica" font-size="60" font-weight="normal">
-            <tspan x="127" y="87">CALCIPY</tspan>
-        </text>
-        <path d="M60.0595726,125 C59.2744622,116.415708 48.3452261,111.123511 44.8309221,109.260061 C40.5315077,106.97423 31.7332857,108.017762 28.9417818,103.607597 C26.1502779,99.197433 23.6329396,96.8867554 20.8414358,94.2033878 C18.0499319,91.5200202 19.7198494,88.0788497 20.2806426,84.1904513 C20.8414358,80.3144759 18.8848907,76.0161186 16.6417179,73.220944 C14.4110072,70.4257695 11.0587102,71.1463034 10.2112894,69.0592397 C9.37633063,66.972176 11.0462481,66.2764881 14.6851728,66.972176 C18.3240975,67.6678639 20.8289737,71.1463034 23.9071052,73.220944 C26.9852367,75.2955847 25.5894848,81.1095478 24.7420639,85.9793631 C23.9071052,90.8491783 26.9727746,91.3088292 30.3250717,94.1909648 C33.6773687,97.0731003 33.6773687,94.5512317 33.6773687,92.2405541 C33.6773687,89.9174535 31.446658,84.8240242 31.7208236,81.3455848 C31.9949892,77.8671453 26.4119814,66.972176 23.6204776,61.4066729 C20.8289737,55.8411697 16.3550903,51.6670424 13.837752,50.0396296 C11.3204137,48.4122169 13.2769588,42.3870628 14.1119175,39.3682743 C14.9468763,36.3494858 10.7596205,30.3243317 11.5945792,28.0012311 C12.429538,25.6781304 15.5076695,28.0012311 17.7383801,30.7839826 C19.9690908,33.5667342 18.2991733,33.5667342 19.1341321,37.2812106 C19.9690908,40.9956871 17.7383801,40.7596501 17.7383801,44.4741265 C17.7383801,48.1886029 23.6080155,48.8842908 26.3995194,54.449794 C29.1910232,60.0152971 28.3560645,49.1203278 28.9168577,46.3375762 C29.4776509,43.5548247 30.5992372,41.467761 34.2256998,40.7720731 C37.8646245,40.0763852 37.5779969,43.3187877 35.6214518,43.7908616 C33.6649067,44.2629355 35.0606586,45.6418883 35.3472862,50.2880896 C35.6214518,54.9218679 33.6649067,59.3320322 33.3907411,61.6551328 C33.1165755,63.9782335 35.3472862,64.4378844 35.6214518,73.233367 C35.8956173,82.0412727 39.2603765,74.1650919 42.8868391,69.2952767 C46.5257637,64.4254614 44.282591,64.6614984 44.282591,63.2701226 C44.282591,61.8787468 38.9737488,58.1642704 40.0953352,54.9218679 C41.2169216,51.6794654 45.4041774,53.7665291 47.634888,55.1579049 C49.8655987,56.5492806 48.4698468,56.3132437 50.9871851,60.0277201 C53.5045234,63.7421965 51.2613506,67.9163239 47.634888,74.1775149 C43.9959634,80.4387059 39.534542,81.1343938 39.2479144,89.9547224 C38.9737488,98.7750511 46.2391361,102.464682 52.1087715,107.09846 C57.9784068,111.732238 60.4957451,113.819302 60.7699107,111.03655 C61.0440762,108.253799 58.2525724,101.756571 57.4176136,97.1227923 C56.5826549,92.4890141 54.9002753,90.4019504 54.0154683,87.8428128 C53.1306613,85.2960982 52.1087715,81.1219708 55.1744409,79.2585211 C58.2525724,77.4074944 57.4051516,85.7557491 59.9224899,88.9981516 C62.4398282,92.2405541 63.8355801,88.0664267 63.0006214,82.7369606 C62.1656626,77.4074944 63.2747869,72.0656052 59.9224899,65.1087263 C56.5701928,58.1518474 49.0181779,52.8223812 45.6658809,46.7972272 C42.3135838,40.7720731 39.7962455,39.6043113 36.4439484,36.1258718 C33.0916514,32.6474324 32.2566927,28.0136541 31.6958995,24.9948655 C31.1351063,21.976077 33.9266101,19.4293624 35.3846724,18.0379866 C36.8302726,16.6466108 40.3570387,19.1933254 37.0047416,21.0567752 C33.6524446,22.9202249 36.4439484,22.9078019 37.0047416,27.3179662 C37.5655348,31.7281305 43.9959634,32.6474324 47.3482604,37.7532846 C50.7005575,42.8591368 56.0093996,48.6482539 56.2960273,50.5117036 C56.5701928,52.3627303 60.2091175,51.2073915 59.9349519,47.728952 C59.6607864,44.2505125 57.9784068,43.7908616 55.4610685,39.8403482 C52.9437302,35.9022578 53.778689,34.2748451 55.186903,31.9517445 C56.5826549,29.6286438 58.2650344,31.2560566 58.2650344,35.194147 C58.2650344,39.1322373 60.2215796,39.6043113 61.9039591,41.9149889 C63.5863387,44.2380896 65.5428838,40.5236131 64.4212974,36.5855227 C63.2997111,32.6474324 64.1471319,27.3055432 62.4647523,24.0631407 C60.7823728,20.8207382 57.9908689,17.3422987 54.0403924,14.3235102 C50.0774539,11.3047217 50.451316,9.68973192 50.7379437,6.67094339 C51.0121092,3.65215486 55.4859927,5.04353064 55.7726203,8.29835614 C56.0592479,11.5531816 56.8942067,14.0998962 61.6422556,15.9509229 C66.3903046,17.8019497 70.0292293,19.4293624 71.6991468,24.9948655 C73.3690643,30.5603687 70.0167672,27.5415801 70.0167672,34.734496 C70.0167672,41.9274119 76.4471958,33.8027712 79.7994928,31.4920935 C83.1517899,29.1689929 84.2733762,25.2309025 83.6378106,22.6841879 C83.002245,20.1374733 87.3390457,19.9014363 90.6913427,22.6841879 C94.0436398,25.4669395 92.9220534,27.5540031 89.5572943,30.7964056 C86.1925352,34.0388081 79.7870308,38.9086234 74.4781886,43.0827507 C69.1693464,47.2568781 69.1693464,51.4310054 68.04776,56.3008207 C66.9261737,61.1706359 66.6520081,63.7173505 68.3219256,65.8044142 C70.0043052,67.8914779 70.5526363,65.5683772 74.4657265,63.0216626 C78.3788168,60.474948 77.543858,59.3071862 78.9396099,57.4561595 C80.3353619,55.6051328 83.1268657,47.480492 83.6253486,41.157186 C84.1113693,34.83388 91.2396738,40.7596501 90.6788806,50.0272067 C90.1180875,59.3071862 80.3353619,64.1770015 75.3131473,69.5064676 C70.2784707,74.8359338 74.191561,76.4633465 75.0389818,79.4821351 C75.8739405,82.5009236 78.1171133,82.7245376 80.9086171,81.3331618 C83.700121,79.941786 80.9086171,81.3331618 86.2174593,76.0036956 C91.5263015,70.6742294 86.2174593,69.7425046 85.9432937,66.7237161 C85.6691282,63.7049275 87.6256733,60.2264881 89.5697563,58.6114983 C91.5138394,56.9840856 94.0561018,58.3754614 93.7694742,61.3942499 C93.4953087,64.4130384 91.5387635,64.1770015 91.5387635,68.1150918 C91.5387635,72.0531822 92.3737223,72.2892192 97.1217713,69.5064676 C101.86982,66.7237161 103.265572,50.2632436 102.991407,44.4617035 C102.717241,38.6601634 110.256794,41.6789519 113.048298,44.4617035 C115.839802,47.2444551 112.213339,55.1330589 105.78291,70.6618064 C99.3524819,86.202977 73.9298575,90.6007183 71.9733123,95.2344966 C70.6897191,98.2781312 68.7580981,102.87464 67.3872703,124.540349" id="Coral" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
-    </g>
-</svg>
diff --git a/docs/calcipy-square.svg b/docs/calcipy-square.svg
deleted file mode 100644
index 6eb5f530..00000000
--- a/docs/calcipy-square.svg
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<svg width="165px" height="129px" viewBox="0 0 165 129" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-    <!-- Generator: Sketch 56.3 (81716) - https://sketch.com -->
-    <title>calcipy</title>
-    <desc>Created with Sketch.</desc>
-    <defs>
-        <linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1">
-            <stop stop-color="#FF2B41" offset="0%"></stop>
-            <stop stop-color="#53D5EC" offset="100%"></stop>
-            <stop stop-color="#F98F00" offset="100%"></stop>
-        </linearGradient>
-    </defs>
-    <g id="calcipy" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
-        <rect fill="#002795" x="0" y="0" width="165" height="129"></rect>
-        <g id="Calcipy-bl-g-gradient-oval-g-copy" transform="translate(27.000000, 3.000000)">
-            <text id="CALCIPY" fill="#FFEAC9" font-family="Helvetica" font-size="26" font-weight="normal">
-                <tspan x="0" y="119">CALCIPY</tspan>
-            </text>
-            <path d="M54.169546,96.5950404 C53.539546,89.6850404 44.769546,85.4250404 41.949546,83.9250404 C38.499546,82.0850404 31.439546,82.9250404 29.199546,79.3750404 C26.959546,75.8250404 24.939546,73.9650404 22.699546,71.8050404 C20.459546,69.6450404 21.799546,66.8750404 22.249546,63.7450404 C22.699546,60.6250404 21.129546,57.1650404 19.329546,54.9150404 C17.539546,52.6650404 14.849546,53.2450404 14.169546,51.5650404 C13.499546,49.8850404 14.839546,49.3250404 17.759546,49.8850404 C20.679546,50.4450404 22.689546,53.2450404 25.159546,54.9150404 C27.629546,56.5850404 26.509546,61.2650404 25.829546,65.1850404 C25.159546,69.1050404 27.619546,69.4750404 30.309546,71.7950404 C32.999546,74.1150404 32.999546,72.0850404 32.999546,70.2250404 C32.999546,68.3550404 31.209546,64.2550404 31.429546,61.4550404 C31.649546,58.6550404 27.169546,49.8850404 24.929546,45.4050404 C22.689546,40.9250404 19.099546,37.5650404 17.079546,36.2550404 C15.059546,34.9450404 16.629546,30.0950404 17.299546,27.6650404 C17.969546,25.2350404 14.609546,20.3850404 15.279546,18.5150404 C15.949546,16.6450404 18.419546,18.5150404 20.209546,20.7550404 C21.999546,22.9950404 20.659546,22.9950404 21.329546,25.9850404 C21.999546,28.9750404 20.209546,28.7850404 20.209546,31.7750404 C20.209546,34.7650404 24.919546,35.3250404 27.159546,39.8050404 C29.399546,44.2850404 28.729546,35.5150404 29.179546,33.2750404 C29.629546,31.0350404 30.529546,29.3550404 33.439546,28.7950404 C36.359546,28.2350404 36.129546,30.8450404 34.559546,31.2250404 C32.989546,31.6050404 34.109546,32.7150404 34.339546,36.4550404 C34.559546,40.1850404 32.989546,43.7350404 32.769546,45.6050404 C32.549546,47.4750404 34.339546,47.8450404 34.559546,54.9250404 C34.779546,62.0150404 37.479546,55.6750404 40.389546,51.7550404 C43.309546,47.8350404 41.509546,48.0250404 41.509546,46.9050404 C41.509546,45.7850404 37.249546,42.7950404 38.149546,40.1850404 C39.049546,37.5750404 42.409546,39.2550404 44.199546,40.3750404 C45.989546,41.4950404 44.869546,41.3050404 46.889546,44.2950404 C48.909546,47.2850404 47.109546,50.6450404 44.199546,55.6850404 C41.279546,60.7250404 37.699546,61.2850404 37.469546,68.3850404 C37.249546,75.4850404 43.079546,78.4550404 47.789546,82.1850404 C52.499546,85.9150404 54.519546,87.5950404 54.739546,85.3550404 C54.959546,83.1150404 52.719546,77.8850404 52.049546,74.1550404 C51.379546,70.4250404 50.029546,68.7450404 49.319546,66.6850404 C48.609546,64.6350404 47.789546,61.2750404 50.249546,59.7750404 C52.719546,58.2850404 52.039546,65.0050404 54.059546,67.6150404 C56.079546,70.2250404 57.199546,66.8650404 56.529546,62.5750404 C55.859546,58.2850404 56.749546,53.9850404 54.059546,48.3850404 C51.369546,42.7850404 45.309546,38.4950404 42.619546,33.6450404 C39.929546,28.7950404 37.909546,27.8550404 35.219546,25.0550404 C32.529546,22.2550404 31.859546,18.5250404 31.409546,16.0950404 C30.959546,13.6650404 33.199546,11.6150404 34.369546,10.4950404 C35.529546,9.37504037 38.359546,11.4250404 35.669546,12.9250404 C32.979546,14.4250404 35.219546,14.4150404 35.669546,17.9650404 C36.119546,21.5150404 41.279546,22.2550404 43.969546,26.3650404 C46.659546,30.4750404 50.919546,35.1350404 51.149546,36.6350404 C51.369546,38.1250404 54.289546,37.1950404 54.069546,34.3950404 C53.849546,31.5950404 52.499546,31.2250404 50.479546,28.0450404 C48.459546,24.8750404 49.129546,23.5650404 50.259546,21.6950404 C51.379546,19.8250404 52.729546,21.1350404 52.729546,24.3050404 C52.729546,27.4750404 54.299546,27.8550404 55.649546,29.7150404 C56.999546,31.5850404 58.569546,28.5950404 57.669546,25.4250404 C56.769546,22.2550404 57.449546,17.9550404 56.099546,15.3450404 C54.749546,12.7350404 52.509546,9.93504037 49.339546,7.50504037 C46.159546,5.07504037 46.459546,3.77504037 46.689546,1.34504037 C46.909546,-1.08495963 50.499546,0.0350403667 50.729546,2.65504037 C50.959546,5.27504037 51.629546,7.32504037 55.439546,8.81504037 C59.249546,10.3050404 62.169546,11.6150404 63.509546,16.0950404 C64.849546,20.5750404 62.159546,18.1450404 62.159546,23.9350404 C62.159546,29.7250404 67.319546,23.1850404 70.009546,21.3250404 C72.699546,19.4550404 73.599546,16.2850404 73.089546,14.2350404 C72.579546,12.1850404 76.059546,11.9950404 78.749546,14.2350404 C81.439546,16.4750404 80.539546,18.1550404 77.839546,20.7650404 C75.139546,23.3750404 69.999546,27.2950404 65.739546,30.6550404 C61.479546,34.0150404 61.479546,37.3750404 60.579546,41.2950404 C59.679546,45.2150404 59.459546,47.2650404 60.799546,48.9450404 C62.149546,50.6250404 62.589546,48.7550404 65.729546,46.7050404 C68.869546,44.6550404 68.199546,43.7150404 69.319546,42.2250404 C70.439546,40.7350404 72.679546,34.1950404 73.079546,29.1050404 C73.469546,24.0150404 79.189546,28.7850404 78.739546,36.2450404 C78.289546,43.7150404 70.439546,47.6350404 66.409546,51.9250404 C62.369546,56.2150404 65.509546,57.5250404 66.189546,59.9550404 C66.859546,62.3850404 68.659546,62.5650404 70.899546,61.4450404 C73.139546,60.3250404 70.899546,61.4450404 75.159546,57.1550404 C79.419546,52.8650404 75.159546,52.1150404 74.939546,49.6850404 C74.719546,47.2550404 76.289546,44.4550404 77.849546,43.1550404 C79.409546,41.8450404 81.449546,42.9650404 81.219546,45.3950404 C80.999546,47.8250404 79.429546,47.6350404 79.429546,50.8050404 C79.429546,53.9750404 80.099546,54.1650404 83.909546,51.9250404 C87.719546,49.6850404 88.839546,36.4350404 88.619546,31.7650404 C88.399546,27.0950404 94.449546,29.5250404 96.689546,31.7650404 C98.929546,34.0050404 96.019546,40.3550404 90.859546,52.8550404 C85.699546,65.3650404 65.299546,68.9050404 63.729546,72.6350404 C62.699546,75.0850404 61.149546,78.7850404 60.049546,96.2250404" id="Coral" fill="url(#linearGradient-1)" fill-rule="nonzero"></path>
-        </g>
-    </g>
-</svg>
diff --git a/modules/calcipy/classes.svg b/modules/calcipy/classes.svg
index 9b481af4..228bac1e 100644
--- a/modules/calcipy/classes.svg
+++ b/modules/calcipy/classes.svg
@@ -1,162 +1,162 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 9.0.0 (20230911.1827)
+<!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: classes Pages: 1 -->
-<svg width="3278pt" height="412pt"
- viewBox="0.00 0.00 3278.25 412.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
-<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 408)">
+<svg width="3999pt" height="413pt"
+ viewBox="0.00 0.00 3998.50 412.80" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 408.8)">
 <title>classes</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-408 3274.25,-408 3274.25,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-408.8 3994.5,-408.8 3994.5,4 -4,4"/>
 <!-- calcipy.cli.CalcipyConfig -->
 <g id="node1" class="node">
 <title>calcipy.cli.CalcipyConfig</title>
-<polygon fill="none" stroke="black" points="0,-354.5 0,-403.5 139,-403.5 139,-354.5 0,-354.5"/>
-<text text-anchor="start" x="29.75" y="-386.2" font-family="Times,serif" font-size="14.00">CalcipyConfig</text>
-<polyline fill="none" stroke="black" points="0,-379 139,-379"/>
-<polyline fill="none" stroke="black" points="0,-379 139,-379"/>
-<text text-anchor="start" x="8" y="-361.7" font-family="Times,serif" font-size="14.00">global_defaults(): Dict</text>
+<polygon fill="none" stroke="black" points="0,-333.5 0,-404.3 173,-404.3 173,-333.5 0,-333.5"/>
+<text text-anchor="start" x="37" y="-389.1" font-family="Times,serif" font-size="14.00">CalcipyConfig</text>
+<polyline fill="none" stroke="black" points="0,-381.3 173,-381.3 "/>
+<polyline fill="none" stroke="black" points="0,-356.5 173,-356.5 "/>
+<text text-anchor="start" x="8" y="-341.3" font-family="Times,serif" font-size="14.00">global_defaults(): Dict</text>
 </g>
 <!-- calcipy.tasks._invoke.Collection -->
 <g id="node2" class="node">
 <title>calcipy.tasks._invoke.Collection</title>
-<polygon fill="none" stroke="black" points="152,-62.25 152,-127.75 1119,-127.75 1119,-62.25 152,-62.25"/>
-<text text-anchor="start" x="607.38" y="-110.45" font-family="Times,serif" font-size="14.00">Collection</text>
-<polyline fill="none" stroke="black" points="152,-103.25 1119,-103.25"/>
-<polyline fill="none" stroke="black" points="152,-103.25 1119,-103.25"/>
-<text text-anchor="start" x="160" y="-85.95" font-family="Times,serif" font-size="14.00">add_task(task: DeferedTask, name: Optional[str], aliases: Optional[Tuple[str, ...]], default: Optional[bool]): None</text>
-<text text-anchor="start" x="160" y="-69.45" font-family="Times,serif" font-size="14.00">from_module(module: ModuleType, name: Optional[str], config: Optional[Dict[str, Any]], loaded_from: Optional[str], auto_dash_names: Optional[bool]): &#39;InvokeCollection&#39;</text>
+<polygon fill="none" stroke="black" points="185,-44.6 185,-130.4 1406,-130.4 1406,-44.6 185,-44.6"/>
+<text text-anchor="start" x="759.5" y="-115.2" font-family="Times,serif" font-size="14.00">Collection</text>
+<polyline fill="none" stroke="black" points="185,-107.4 1406,-107.4 "/>
+<polyline fill="none" stroke="black" points="185,-82.6 1406,-82.6 "/>
+<text text-anchor="start" x="193" y="-67.4" font-family="Times,serif" font-size="14.00">add_task(task: DeferedTask, name: Optional[str], aliases: Optional[Tuple[str, ...]], default: Optional[bool]): None</text>
+<text text-anchor="start" x="193" y="-52.4" font-family="Times,serif" font-size="14.00">from_module(module: ModuleType, name: Optional[str], config: Optional[Dict[str, Any]], loaded_from: Optional[str], auto_dash_names: Optional[bool]): &#39;InvokeCollection&#39;</text>
 </g>
 <!-- calcipy.tasks._invoke.GlobalTaskOptions -->
 <g id="node3" class="node">
 <title>calcipy.tasks._invoke.GlobalTaskOptions</title>
-<polygon fill="none" stroke="black" points="5.25,-33.5 5.25,-156.5 133.75,-156.5 133.75,-33.5 5.25,-33.5"/>
-<text text-anchor="start" x="16.62" y="-139.2" font-family="Times,serif" font-size="14.00">GlobalTaskOptions</text>
-<polyline fill="none" stroke="black" points="5.25,-132 133.75,-132"/>
-<text text-anchor="start" x="13.25" y="-114.7" font-family="Times,serif" font-size="14.00">file_args : List[Path]</text>
-<text text-anchor="start" x="13.25" y="-98.2" font-family="Times,serif" font-size="14.00">keep_going : bool</text>
-<text text-anchor="start" x="13.25" y="-81.7" font-family="Times,serif" font-size="14.00">verbose : Annotated</text>
-<text text-anchor="start" x="13.25" y="-65.2" font-family="Times,serif" font-size="14.00">working_dir : Path</text>
-<polyline fill="none" stroke="black" points="5.25,-58 133.75,-58"/>
-<text text-anchor="start" x="67.62" y="-40.7" font-family="Times,serif" font-size="14.00"> </text>
+<polygon fill="none" stroke="black" points="6.5,-30.5 6.5,-144.5 166.5,-144.5 166.5,-30.5 6.5,-30.5"/>
+<text text-anchor="start" x="19.5" y="-129.3" font-family="Times,serif" font-size="14.00">GlobalTaskOptions</text>
+<polyline fill="none" stroke="black" points="6.5,-121.5 166.5,-121.5 "/>
+<text text-anchor="start" x="14.5" y="-106.3" font-family="Times,serif" font-size="14.00">file_args : List[Path]</text>
+<text text-anchor="start" x="14.5" y="-91.3" font-family="Times,serif" font-size="14.00">keep_going : bool</text>
+<text text-anchor="start" x="14.5" y="-76.3" font-family="Times,serif" font-size="14.00">verbose : Annotated</text>
+<text text-anchor="start" x="14.5" y="-61.3" font-family="Times,serif" font-size="14.00">working_dir : Path</text>
+<polyline fill="none" stroke="black" points="6.5,-53.5 166.5,-53.5 "/>
+<text text-anchor="start" x="84" y="-38.3" font-family="Times,serif" font-size="14.00"> </text>
 </g>
 <!-- calcipy.cli.start_program._CalcipyConfig -->
 <g id="node4" class="node">
 <title>calcipy.cli.start_program._CalcipyConfig</title>
-<polygon fill="none" stroke="black" points="18.38,-243 18.38,-316.5 120.62,-316.5 120.62,-243 18.38,-243"/>
-<text text-anchor="start" x="26.38" y="-299.2" font-family="Times,serif" font-size="14.00">_CalcipyConfig</text>
-<polyline fill="none" stroke="black" points="18.38,-292 120.62,-292"/>
-<text text-anchor="start" x="60.88" y="-274.7" font-family="Times,serif" font-size="14.00">gto</text>
-<polyline fill="none" stroke="black" points="18.38,-267.5 120.62,-267.5"/>
-<text text-anchor="start" x="67.62" y="-250.2" font-family="Times,serif" font-size="14.00"> </text>
+<polygon fill="none" stroke="black" points="25.5,-226.5 25.5,-295.5 147.5,-295.5 147.5,-226.5 25.5,-226.5"/>
+<text text-anchor="start" x="33.5" y="-280.3" font-family="Times,serif" font-size="14.00">_CalcipyConfig</text>
+<polyline fill="none" stroke="black" points="25.5,-272.5 147.5,-272.5 "/>
+<text text-anchor="start" x="74.5" y="-257.3" font-family="Times,serif" font-size="14.00">gto</text>
+<polyline fill="none" stroke="black" points="25.5,-249.5 147.5,-249.5 "/>
+<text text-anchor="start" x="84" y="-234.3" font-family="Times,serif" font-size="14.00"> </text>
 </g>
 <!-- calcipy.tasks._invoke.GlobalTaskOptions&#45;&gt;calcipy.cli.start_program._CalcipyConfig -->
 <g id="edge2" class="edge">
 <title>calcipy.tasks._invoke.GlobalTaskOptions&#45;&gt;calcipy.cli.start_program._CalcipyConfig</title>
-<path fill="none" stroke="black" d="M69.5,-156.85C69.5,-180.52 69.5,-207.28 69.5,-229.69"/>
-<polygon fill="black" stroke="black" points="69.5,-229.76 73.5,-235.76 69.5,-241.76 65.5,-235.76 69.5,-229.76"/>
-<text text-anchor="middle" x="78.12" y="-211.2" font-family="Times,serif" font-size="14.00" fill="green">gto</text>
+<path fill="none" stroke="black" d="M86.5,-144.66C86.5,-167.19 86.5,-192.84 86.5,-214.22"/>
+<polygon fill="black" stroke="black" points="86.5,-214.26 90.5,-220.26 86.5,-226.26 82.5,-220.26 86.5,-214.26"/>
+<text text-anchor="middle" x="98.5" y="-196.8" font-family="Times,serif" font-size="14.00" fill="green">gto</text>
 </g>
 <!-- calcipy.cli.start_program._CalcipyConfig&#45;&gt;calcipy.cli.CalcipyConfig -->
 <g id="edge1" class="edge">
 <title>calcipy.cli.start_program._CalcipyConfig&#45;&gt;calcipy.cli.CalcipyConfig</title>
-<path fill="none" stroke="black" d="M69.5,-316.96C69.5,-325.4 69.5,-334.38 69.5,-342.78"/>
-<polygon fill="none" stroke="black" points="66,-342.64 69.5,-352.64 73,-342.64 66,-342.64"/>
+<path fill="none" stroke="black" d="M86.5,-295.51C86.5,-304.22 86.5,-313.76 86.5,-322.96"/>
+<polygon fill="none" stroke="black" points="83,-323.15 86.5,-333.15 90,-323.15 83,-323.15"/>
 </g>
 <!-- calcipy.cli._CalcipyProgram -->
 <g id="node5" class="node">
 <title>calcipy.cli._CalcipyProgram</title>
-<polygon fill="none" stroke="black" points="1136.88,-70.5 1136.88,-119.5 1254.12,-119.5 1254.12,-70.5 1136.88,-70.5"/>
-<text text-anchor="start" x="1147.5" y="-102.2" font-family="Times,serif" font-size="14.00">_CalcipyProgram</text>
-<polyline fill="none" stroke="black" points="1136.88,-95 1254.12,-95"/>
-<polyline fill="none" stroke="black" points="1136.88,-95 1254.12,-95"/>
-<text text-anchor="start" x="1144.88" y="-77.7" font-family="Times,serif" font-size="14.00">print_help(): None</text>
+<polygon fill="none" stroke="black" points="1424.5,-52.1 1424.5,-122.9 1570.5,-122.9 1570.5,-52.1 1424.5,-52.1"/>
+<text text-anchor="start" x="1436.5" y="-107.7" font-family="Times,serif" font-size="14.00">_CalcipyProgram</text>
+<polyline fill="none" stroke="black" points="1424.5,-99.9 1570.5,-99.9 "/>
+<polyline fill="none" stroke="black" points="1424.5,-75.1 1570.5,-75.1 "/>
+<text text-anchor="start" x="1432.5" y="-59.9" font-family="Times,serif" font-size="14.00">print_help(): None</text>
 </g>
 <!-- calcipy.code_tag_collector._collector._CodeTag -->
 <g id="node6" class="node">
 <title>calcipy.code_tag_collector._collector._CodeTag</title>
-<polygon fill="none" stroke="black" points="1272.62,-33.5 1272.62,-156.5 1436.38,-156.5 1436.38,-33.5 1272.62,-33.5"/>
-<text text-anchor="start" x="1326.38" y="-139.2" font-family="Times,serif" font-size="14.00">_CodeTag</text>
-<polyline fill="none" stroke="black" points="1272.62,-132 1436.38,-132"/>
-<text text-anchor="start" x="1280.62" y="-114.7" font-family="Times,serif" font-size="14.00">lineno : int</text>
-<text text-anchor="start" x="1280.62" y="-98.2" font-family="Times,serif" font-size="14.00">model_config : ConfigDict</text>
-<text text-anchor="start" x="1280.62" y="-81.7" font-family="Times,serif" font-size="14.00">tag : str</text>
-<text text-anchor="start" x="1280.62" y="-65.2" font-family="Times,serif" font-size="14.00">text : str</text>
-<polyline fill="none" stroke="black" points="1272.62,-58 1436.38,-58"/>
-<text text-anchor="start" x="1352.62" y="-40.7" font-family="Times,serif" font-size="14.00"> </text>
+<polygon fill="none" stroke="black" points="1588.5,-30.5 1588.5,-144.5 1698.5,-144.5 1698.5,-30.5 1588.5,-30.5"/>
+<text text-anchor="start" x="1609" y="-129.3" font-family="Times,serif" font-size="14.00">_CodeTag</text>
+<polyline fill="none" stroke="black" points="1588.5,-121.5 1698.5,-121.5 "/>
+<text text-anchor="start" x="1596.5" y="-106.3" font-family="Times,serif" font-size="14.00">lineno : int</text>
+<text text-anchor="start" x="1596.5" y="-91.3" font-family="Times,serif" font-size="14.00">model_config</text>
+<text text-anchor="start" x="1596.5" y="-76.3" font-family="Times,serif" font-size="14.00">tag : str</text>
+<text text-anchor="start" x="1596.5" y="-61.3" font-family="Times,serif" font-size="14.00">text : str</text>
+<polyline fill="none" stroke="black" points="1588.5,-53.5 1698.5,-53.5 "/>
+<text text-anchor="start" x="1641" y="-38.3" font-family="Times,serif" font-size="14.00"> </text>
 </g>
 <!-- calcipy.code_tag_collector._collector._CollectorRow -->
 <g id="node7" class="node">
 <title>calcipy.code_tag_collector._collector._CollectorRow</title>
-<polygon fill="none" stroke="black" points="1454.25,-33.5 1454.25,-156.5 1930.75,-156.5 1930.75,-33.5 1454.25,-33.5"/>
-<text text-anchor="start" x="1651.25" y="-139.2" font-family="Times,serif" font-size="14.00">_CollectorRow</text>
-<polyline fill="none" stroke="black" points="1454.25,-132 1930.75,-132"/>
-<text text-anchor="start" x="1650.12" y="-114.7" font-family="Times,serif" font-size="14.00">comment : str</text>
-<text text-anchor="start" x="1650.12" y="-98.2" font-family="Times,serif" font-size="14.00">last_edit : str</text>
-<text text-anchor="start" x="1650.12" y="-81.7" font-family="Times,serif" font-size="14.00">source_file : str</text>
-<text text-anchor="start" x="1650.12" y="-65.2" font-family="Times,serif" font-size="14.00">tag_name : str</text>
-<polyline fill="none" stroke="black" points="1454.25,-58 1930.75,-58"/>
-<text text-anchor="start" x="1462.25" y="-40.7" font-family="Times,serif" font-size="14.00">from_code_tag(code_tag: _CodeTag, last_edit: str, source_file: str): &#39;_CollectorRow&#39;</text>
+<polygon fill="none" stroke="black" points="1717,-30.5 1717,-144.5 2318,-144.5 2318,-30.5 1717,-30.5"/>
+<text text-anchor="start" x="1966" y="-129.3" font-family="Times,serif" font-size="14.00">_CollectorRow</text>
+<polyline fill="none" stroke="black" points="1717,-121.5 2318,-121.5 "/>
+<text text-anchor="start" x="1962.5" y="-106.3" font-family="Times,serif" font-size="14.00">comment : str</text>
+<text text-anchor="start" x="1962.5" y="-91.3" font-family="Times,serif" font-size="14.00">last_edit : str</text>
+<text text-anchor="start" x="1962.5" y="-76.3" font-family="Times,serif" font-size="14.00">source_file : str</text>
+<text text-anchor="start" x="1962.5" y="-61.3" font-family="Times,serif" font-size="14.00">tag_name : str</text>
+<polyline fill="none" stroke="black" points="1717,-53.5 2318,-53.5 "/>
+<text text-anchor="start" x="1725" y="-38.3" font-family="Times,serif" font-size="14.00">from_code_tag(code_tag: _CodeTag, last_edit: str, source_file: str): &#39;_CollectorRow&#39;</text>
 </g>
 <!-- calcipy.check_for_stale_packages._check_for_stale_packages._HostedPythonPackage -->
 <g id="node8" class="node">
 <title>calcipy.check_for_stale_packages._check_for_stale_packages._HostedPythonPackage</title>
-<polygon fill="none" stroke="black" points="1948.75,-0.5 1948.75,-189.5 2278.25,-189.5 2278.25,-0.5 1948.75,-0.5"/>
-<text text-anchor="start" x="2049.38" y="-172.2" font-family="Times,serif" font-size="14.00">_HostedPythonPackage</text>
-<polyline fill="none" stroke="black" points="1948.75,-165 2278.25,-165"/>
-<text text-anchor="start" x="2020.88" y="-147.7" font-family="Times,serif" font-size="14.00">datetime : Optional[Arrow]</text>
-<text text-anchor="start" x="2020.88" y="-131.2" font-family="Times,serif" font-size="14.00">domain : str</text>
-<text text-anchor="start" x="2020.88" y="-114.7" font-family="Times,serif" font-size="14.00">latest_datetime : Optional[Arrow]</text>
-<text text-anchor="start" x="2020.88" y="-98.2" font-family="Times,serif" font-size="14.00">latest_version : str</text>
-<text text-anchor="start" x="2020.88" y="-81.7" font-family="Times,serif" font-size="14.00">model_config : ConfigDict</text>
-<text text-anchor="start" x="2020.88" y="-65.2" font-family="Times,serif" font-size="14.00">name : str</text>
-<text text-anchor="start" x="2020.88" y="-48.7" font-family="Times,serif" font-size="14.00">version : str</text>
-<polyline fill="none" stroke="black" points="1948.75,-41.5 2278.25,-41.5"/>
-<text text-anchor="start" x="1956.75" y="-24.2" font-family="Times,serif" font-size="14.00">date_validator(value: Union[str, Arrow]): Arrow</text>
-<text text-anchor="start" x="1956.75" y="-7.7" font-family="Times,serif" font-size="14.00">serialize_datetime(value: Optional[Arrow]): Optional[str]</text>
+<polygon fill="none" stroke="black" points="2336.5,-0.5 2336.5,-174.5 2756.5,-174.5 2756.5,-0.5 2336.5,-0.5"/>
+<text text-anchor="start" x="2463" y="-159.3" font-family="Times,serif" font-size="14.00">_HostedPythonPackage</text>
+<polyline fill="none" stroke="black" points="2336.5,-151.5 2756.5,-151.5 "/>
+<text text-anchor="start" x="2426.5" y="-136.3" font-family="Times,serif" font-size="14.00">datetime : Optional[Arrow]</text>
+<text text-anchor="start" x="2426.5" y="-121.3" font-family="Times,serif" font-size="14.00">domain : str</text>
+<text text-anchor="start" x="2426.5" y="-106.3" font-family="Times,serif" font-size="14.00">latest_datetime : Optional[Arrow]</text>
+<text text-anchor="start" x="2426.5" y="-91.3" font-family="Times,serif" font-size="14.00">latest_version : str</text>
+<text text-anchor="start" x="2426.5" y="-76.3" font-family="Times,serif" font-size="14.00">model_config : ConfigDict</text>
+<text text-anchor="start" x="2426.5" y="-61.3" font-family="Times,serif" font-size="14.00">name : str</text>
+<text text-anchor="start" x="2426.5" y="-46.3" font-family="Times,serif" font-size="14.00">version : str</text>
+<polyline fill="none" stroke="black" points="2336.5,-38.5 2756.5,-38.5 "/>
+<text text-anchor="start" x="2344.5" y="-23.3" font-family="Times,serif" font-size="14.00">date_validator(value: Union[str, Arrow]): Arrow</text>
+<text text-anchor="start" x="2344.5" y="-8.3" font-family="Times,serif" font-size="14.00">serialize_datetime(value: Optional[Arrow]): Optional[str]</text>
 </g>
 <!-- calcipy.md_writer._writer._ParseSkipError -->
 <g id="node9" class="node">
 <title>calcipy.md_writer._writer._ParseSkipError</title>
-<polygon fill="none" stroke="black" points="2295.88,-70.5 2295.88,-119.5 2401.12,-119.5 2401.12,-70.5 2295.88,-70.5"/>
-<text text-anchor="start" x="2303.88" y="-102.2" font-family="Times,serif" font-size="14.00" fill="red">_ParseSkipError</text>
-<polyline fill="none" stroke="black" points="2295.88,-95 2401.12,-95"/>
-<polyline fill="none" stroke="black" points="2295.88,-95 2401.12,-95"/>
-<text text-anchor="start" x="2346.62" y="-77.7" font-family="Times,serif" font-size="14.00" fill="red"> </text>
+<polygon fill="none" stroke="black" points="2774.5,-52.1 2774.5,-122.9 2908.5,-122.9 2908.5,-52.1 2774.5,-52.1"/>
+<text text-anchor="start" x="2782.5" y="-107.7" font-family="Times,serif" font-size="14.00" fill="red">_ParseSkipError</text>
+<polyline fill="none" stroke="black" points="2774.5,-99.9 2908.5,-99.9 "/>
+<polyline fill="none" stroke="black" points="2774.5,-75.1 2908.5,-75.1 "/>
+<text text-anchor="start" x="2839" y="-59.9" font-family="Times,serif" font-size="14.00" fill="red"> </text>
 </g>
 <!-- calcipy.md_writer._writer._ReplacementMachine -->
 <g id="node10" class="node">
 <title>calcipy.md_writer._writer._ReplacementMachine</title>
-<polygon fill="none" stroke="black" points="2419.12,-50 2419.12,-140 2879.88,-140 2879.88,-50 2419.12,-50"/>
-<text text-anchor="start" x="2586.5" y="-122.7" font-family="Times,serif" font-size="14.00">_ReplacementMachine</text>
-<polyline fill="none" stroke="black" points="2419.12,-115.5 2879.88,-115.5"/>
-<text text-anchor="start" x="2609.75" y="-98.2" font-family="Times,serif" font-size="14.00">state_auto : str</text>
-<text text-anchor="start" x="2609.75" y="-81.7" font-family="Times,serif" font-size="14.00">state_user : str</text>
-<polyline fill="none" stroke="black" points="2419.12,-74.5 2879.88,-74.5"/>
-<text text-anchor="start" x="2427.12" y="-57.2" font-family="Times,serif" font-size="14.00">parse(lines: List[str], handler_lookup: HandlerLookupT, path_file: Path): List[str]</text>
+<polygon fill="none" stroke="black" points="2927,-45.5 2927,-129.5 3516,-129.5 3516,-45.5 2927,-45.5"/>
+<text text-anchor="start" x="3141" y="-114.3" font-family="Times,serif" font-size="14.00">_ReplacementMachine</text>
+<polyline fill="none" stroke="black" points="2927,-106.5 3516,-106.5 "/>
+<text text-anchor="start" x="3167" y="-91.3" font-family="Times,serif" font-size="14.00">state_auto : str</text>
+<text text-anchor="start" x="3167" y="-76.3" font-family="Times,serif" font-size="14.00">state_user : str</text>
+<polyline fill="none" stroke="black" points="2927,-68.5 3516,-68.5 "/>
+<text text-anchor="start" x="2935" y="-53.3" font-family="Times,serif" font-size="14.00">parse(lines: List[str], handler_lookup: HandlerLookupT, path_file: Path): List[str]</text>
 </g>
 <!-- calcipy._RuntimeTypeCheckingModes -->
 <g id="node11" class="node">
 <title>calcipy._RuntimeTypeCheckingModes</title>
-<polygon fill="none" stroke="black" points="2898,-58.25 2898,-131.75 3085,-131.75 3085,-58.25 2898,-58.25"/>
-<text text-anchor="start" x="2906" y="-114.45" font-family="Times,serif" font-size="14.00">_RuntimeTypeCheckingModes</text>
-<polyline fill="none" stroke="black" points="2898,-107.25 3085,-107.25"/>
-<text text-anchor="start" x="2976.5" y="-89.95" font-family="Times,serif" font-size="14.00">name</text>
-<polyline fill="none" stroke="black" points="2898,-82.75 3085,-82.75"/>
-<text text-anchor="start" x="2921" y="-65.45" font-family="Times,serif" font-size="14.00">from_environment(): Self</text>
+<polygon fill="none" stroke="black" points="3534.5,-53 3534.5,-122 3766.5,-122 3766.5,-53 3534.5,-53"/>
+<text text-anchor="start" x="3542.5" y="-106.8" font-family="Times,serif" font-size="14.00">_RuntimeTypeCheckingModes</text>
+<polyline fill="none" stroke="black" points="3534.5,-99 3766.5,-99 "/>
+<text text-anchor="start" x="3630.5" y="-83.8" font-family="Times,serif" font-size="14.00">name</text>
+<polyline fill="none" stroke="black" points="3534.5,-76 3766.5,-76 "/>
+<text text-anchor="start" x="3561" y="-60.8" font-family="Times,serif" font-size="14.00">from_environment(): Self</text>
 </g>
 <!-- calcipy.code_tag_collector._collector._Tags -->
 <g id="node12" class="node">
 <title>calcipy.code_tag_collector._collector._Tags</title>
-<polygon fill="none" stroke="black" points="3102.75,-41.75 3102.75,-148.25 3270.25,-148.25 3270.25,-41.75 3102.75,-41.75"/>
-<text text-anchor="start" x="3170" y="-130.95" font-family="Times,serif" font-size="14.00">_Tags</text>
-<polyline fill="none" stroke="black" points="3102.75,-123.75 3270.25,-123.75"/>
-<text text-anchor="start" x="3110.75" y="-106.45" font-family="Times,serif" font-size="14.00">code_tags : List[_CodeTag]</text>
-<text text-anchor="start" x="3110.75" y="-89.95" font-family="Times,serif" font-size="14.00">model_config : ConfigDict</text>
-<text text-anchor="start" x="3110.75" y="-73.45" font-family="Times,serif" font-size="14.00">path_source : Path</text>
-<polyline fill="none" stroke="black" points="3102.75,-66.25 3270.25,-66.25"/>
-<text text-anchor="start" x="3184.62" y="-48.95" font-family="Times,serif" font-size="14.00"> </text>
+<polygon fill="none" stroke="black" points="3784.5,-38 3784.5,-137 3990.5,-137 3990.5,-38 3784.5,-38"/>
+<text text-anchor="start" x="3867.5" y="-121.8" font-family="Times,serif" font-size="14.00">_Tags</text>
+<polyline fill="none" stroke="black" points="3784.5,-114 3990.5,-114 "/>
+<text text-anchor="start" x="3792.5" y="-98.8" font-family="Times,serif" font-size="14.00">code_tags : List[_CodeTag]</text>
+<text text-anchor="start" x="3792.5" y="-83.8" font-family="Times,serif" font-size="14.00">model_config</text>
+<text text-anchor="start" x="3792.5" y="-68.8" font-family="Times,serif" font-size="14.00">path_source : Path</text>
+<polyline fill="none" stroke="black" points="3784.5,-61 3990.5,-61 "/>
+<text text-anchor="start" x="3885" y="-45.8" font-family="Times,serif" font-size="14.00"> </text>
 </g>
 </g>
 </svg>
diff --git a/modules/calcipy/packages.svg b/modules/calcipy/packages.svg
index 42ddc727..b2786403 100644
--- a/modules/calcipy/packages.svg
+++ b/modules/calcipy/packages.svg
@@ -1,409 +1,409 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
  "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
-<!-- Generated by graphviz version 9.0.0 (20230911.1827)
+<!-- Generated by graphviz version 2.43.0 (0)
  -->
 <!-- Title: packages Pages: 1 -->
-<svg width="2987pt" height="404pt"
- viewBox="0.00 0.00 2987.00 404.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<svg width="3637pt" height="404pt"
+ viewBox="0.00 0.00 3637.00 404.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
 <g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 400)">
 <title>packages</title>
-<polygon fill="white" stroke="none" points="-4,4 -4,-400 2983,-400 2983,4 -4,4"/>
+<polygon fill="white" stroke="transparent" points="-4,4 -4,-400 3633,-400 3633,4 -4,4"/>
 <!-- calcipy -->
 <g id="node1" class="node">
 <title>calcipy</title>
-<polygon fill="none" stroke="black" points="55,-36 0,-36 0,0 55,0 55,-36"/>
-<text text-anchor="middle" x="27.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy</text>
+<polygon fill="none" stroke="black" points="66,-36 0,-36 0,0 66,0 66,-36"/>
+<text text-anchor="middle" x="33" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy</text>
 </g>
 <!-- calcipy.can_skip -->
 <g id="node2" class="node">
 <title>calcipy.can_skip</title>
-<polygon fill="none" stroke="black" points="179.5,-36 73.5,-36 73.5,0 179.5,0 179.5,-36"/>
-<text text-anchor="middle" x="126.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.can_skip</text>
+<polygon fill="none" stroke="black" points="213.5,-36 84.5,-36 84.5,0 213.5,0 213.5,-36"/>
+<text text-anchor="middle" x="149" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.can_skip</text>
 </g>
 <!-- calcipy.check_for_stale_packages -->
 <g id="node3" class="node">
 <title>calcipy.check_for_stale_packages</title>
-<polygon fill="none" stroke="black" points="397.38,-36 197.62,-36 197.62,0 397.38,0 397.38,-36"/>
-<text text-anchor="middle" x="297.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.check_for_stale_packages</text>
+<polygon fill="none" stroke="black" points="482,-36 232,-36 232,0 482,0 482,-36"/>
+<text text-anchor="middle" x="357" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.check_for_stale_packages</text>
 </g>
 <!-- calcipy.check_for_stale_packages._check_for_stale_packages -->
 <g id="node4" class="node">
 <title>calcipy.check_for_stale_packages._check_for_stale_packages</title>
-<polygon fill="none" stroke="black" points="473.5,-108 121.5,-108 121.5,-72 473.5,-72 473.5,-108"/>
-<text text-anchor="middle" x="297.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.check_for_stale_packages._check_for_stale_packages</text>
+<polygon fill="none" stroke="black" points="578.5,-108 135.5,-108 135.5,-72 578.5,-72 578.5,-108"/>
+<text text-anchor="middle" x="357" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.check_for_stale_packages._check_for_stale_packages</text>
 </g>
 <!-- calcipy.check_for_stale_packages&#45;&gt;calcipy.check_for_stale_packages._check_for_stale_packages -->
 <g id="edge1" class="edge">
 <title>calcipy.check_for_stale_packages&#45;&gt;calcipy.check_for_stale_packages._check_for_stale_packages</title>
-<path fill="none" stroke="black" d="M297.5,-36.3C297.5,-43.68 297.5,-52.48 297.5,-60.75"/>
-<polygon fill="black" stroke="black" points="297.5,-70.68 293,-60.68 297.5,-66.9 297.5,-60.68 297.5,-60.68 297.5,-60.68 297.5,-66.9 302,-60.68 297.5,-70.68"/>
+<path fill="none" stroke="black" d="M357,-36.3C357,-44.02 357,-53.29 357,-61.89"/>
+<polygon fill="black" stroke="black" points="357,-71.9 352.5,-61.9 357,-66.9 357,-61.9 357,-61.9 357,-61.9 357,-66.9 361.5,-61.9 357,-71.9 357,-71.9"/>
 </g>
 <!-- calcipy.cli -->
 <g id="node5" class="node">
 <title>calcipy.cli</title>
-<polygon fill="none" stroke="black" points="790.25,-108 718.75,-108 718.75,-72 790.25,-72 790.25,-108"/>
-<text text-anchor="middle" x="754.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.cli</text>
+<polygon fill="none" stroke="black" points="964.5,-108 879.5,-108 879.5,-72 964.5,-72 964.5,-108"/>
+<text text-anchor="middle" x="922" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.cli</text>
 </g>
 <!-- calcipy.invoke_helpers -->
 <g id="node14" class="node">
 <title>calcipy.invoke_helpers</title>
-<polygon fill="none" stroke="black" points="927.75,-180 787.25,-180 787.25,-144 927.75,-144 927.75,-180"/>
-<text text-anchor="middle" x="857.5" y="-156.95" font-family="Times,serif" font-size="14.00">calcipy.invoke_helpers</text>
+<polygon fill="none" stroke="black" points="1202.5,-180 1027.5,-180 1027.5,-144 1202.5,-144 1202.5,-180"/>
+<text text-anchor="middle" x="1115" y="-158.3" font-family="Times,serif" font-size="14.00">calcipy.invoke_helpers</text>
 </g>
 <!-- calcipy.cli&#45;&gt;calcipy.invoke_helpers -->
 <g id="edge2" class="edge">
 <title>calcipy.cli&#45;&gt;calcipy.invoke_helpers</title>
-<path fill="none" stroke="black" d="M780.23,-108.48C793.23,-117.32 809.18,-128.16 823.21,-137.7"/>
-<polygon fill="black" stroke="black" points="831.09,-143.05 820.29,-141.16 827.97,-140.93 822.82,-137.43 822.82,-137.43 822.82,-137.43 827.97,-140.93 825.35,-133.71 831.09,-143.05"/>
+<path fill="none" stroke="black" d="M964.83,-106.54C992.39,-116.53 1028.51,-129.63 1058.42,-140.48"/>
+<polygon fill="black" stroke="black" points="1067.89,-143.91 1056.96,-144.73 1063.19,-142.21 1058.49,-140.5 1058.49,-140.5 1058.49,-140.5 1063.19,-142.21 1060.02,-136.27 1067.89,-143.91 1067.89,-143.91"/>
 </g>
 <!-- calcipy.tasks._invoke -->
 <g id="node21" class="node">
 <title>calcipy.tasks._invoke</title>
-<polygon fill="none" stroke="black" points="1141.62,-252 1009.38,-252 1009.38,-216 1141.62,-216 1141.62,-252"/>
-<text text-anchor="middle" x="1075.5" y="-228.95" font-family="Times,serif" font-size="14.00">calcipy.tasks._invoke</text>
+<polygon fill="none" stroke="black" points="1425,-252 1261,-252 1261,-216 1425,-216 1425,-252"/>
+<text text-anchor="middle" x="1343" y="-230.3" font-family="Times,serif" font-size="14.00">calcipy.tasks._invoke</text>
 </g>
 <!-- calcipy.cli&#45;&gt;calcipy.tasks._invoke -->
 <g id="edge3" class="edge">
 <title>calcipy.cli&#45;&gt;calcipy.tasks._invoke</title>
-<path fill="none" stroke="black" d="M754.02,-108.16C754.44,-128.4 758.45,-161.62 778.5,-180 809.82,-208.72 920.77,-222.32 997.81,-228.44"/>
-<polygon fill="black" stroke="black" points="1007.7,-229.19 997.39,-232.92 1003.93,-228.9 997.73,-228.43 997.73,-228.43 997.73,-228.43 1003.93,-228.9 998.07,-223.94 1007.7,-229.19"/>
+<path fill="none" stroke="black" d="M940.37,-108.09C968.08,-133.86 1017.41,-179.71 1018,-180 1091.04,-215.7 1183.21,-228.09 1250.73,-232.05"/>
+<polygon fill="black" stroke="black" points="1260.93,-232.6 1250.7,-236.56 1255.93,-232.33 1250.94,-232.07 1250.94,-232.07 1250.94,-232.07 1255.93,-232.33 1251.18,-227.57 1260.93,-232.6 1260.93,-232.6"/>
 </g>
 <!-- calcipy.code_tag_collector -->
 <g id="node6" class="node">
 <title>calcipy.code_tag_collector</title>
-<polygon fill="none" stroke="black" points="1622.88,-36 1462.12,-36 1462.12,0 1622.88,0 1622.88,-36"/>
-<text text-anchor="middle" x="1542.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.code_tag_collector</text>
+<polygon fill="none" stroke="black" points="1963,-36 1763,-36 1763,0 1963,0 1963,-36"/>
+<text text-anchor="middle" x="1863" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.code_tag_collector</text>
 </g>
 <!-- calcipy.code_tag_collector._collector -->
 <g id="node7" class="node">
 <title>calcipy.code_tag_collector._collector</title>
-<polygon fill="none" stroke="black" points="1651.38,-108 1433.62,-108 1433.62,-72 1651.38,-72 1651.38,-108"/>
-<text text-anchor="middle" x="1542.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.code_tag_collector._collector</text>
+<polygon fill="none" stroke="black" points="1998.5,-108 1727.5,-108 1727.5,-72 1998.5,-72 1998.5,-108"/>
+<text text-anchor="middle" x="1863" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.code_tag_collector._collector</text>
 </g>
 <!-- calcipy.code_tag_collector&#45;&gt;calcipy.code_tag_collector._collector -->
 <g id="edge4" class="edge">
 <title>calcipy.code_tag_collector&#45;&gt;calcipy.code_tag_collector._collector</title>
-<path fill="none" stroke="black" d="M1542.5,-36.3C1542.5,-43.68 1542.5,-52.48 1542.5,-60.75"/>
-<polygon fill="black" stroke="black" points="1542.5,-70.68 1538,-60.68 1542.5,-66.9 1542.5,-60.68 1542.5,-60.68 1542.5,-60.68 1542.5,-66.9 1547,-60.68 1542.5,-70.68"/>
+<path fill="none" stroke="black" d="M1863,-36.3C1863,-44.02 1863,-53.29 1863,-61.89"/>
+<polygon fill="black" stroke="black" points="1863,-71.9 1858.5,-61.9 1863,-66.9 1863,-61.9 1863,-61.9 1863,-61.9 1863,-66.9 1867.5,-61.9 1863,-71.9 1863,-71.9"/>
 </g>
 <!-- calcipy.dot_dict -->
 <g id="node8" class="node">
 <title>calcipy.dot_dict</title>
-<polygon fill="none" stroke="black" points="1798.62,-36 1696.38,-36 1696.38,0 1798.62,0 1798.62,-36"/>
-<text text-anchor="middle" x="1747.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.dot_dict</text>
+<polygon fill="none" stroke="black" points="2176.5,-36 2051.5,-36 2051.5,0 2176.5,0 2176.5,-36"/>
+<text text-anchor="middle" x="2114" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.dot_dict</text>
 </g>
 <!-- calcipy.dot_dict._dot_dict -->
 <g id="node9" class="node">
 <title>calcipy.dot_dict._dot_dict</title>
-<polygon fill="none" stroke="black" points="1826,-108 1669,-108 1669,-72 1826,-72 1826,-108"/>
-<text text-anchor="middle" x="1747.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.dot_dict._dot_dict</text>
+<polygon fill="none" stroke="black" points="2211,-108 2017,-108 2017,-72 2211,-72 2211,-108"/>
+<text text-anchor="middle" x="2114" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.dot_dict._dot_dict</text>
 </g>
 <!-- calcipy.dot_dict&#45;&gt;calcipy.dot_dict._dot_dict -->
 <g id="edge5" class="edge">
 <title>calcipy.dot_dict&#45;&gt;calcipy.dot_dict._dot_dict</title>
-<path fill="none" stroke="black" d="M1747.5,-36.3C1747.5,-43.68 1747.5,-52.48 1747.5,-60.75"/>
-<polygon fill="black" stroke="black" points="1747.5,-70.68 1743,-60.68 1747.5,-66.9 1747.5,-60.68 1747.5,-60.68 1747.5,-60.68 1747.5,-66.9 1752,-60.68 1747.5,-70.68"/>
+<path fill="none" stroke="black" d="M2114,-36.3C2114,-44.02 2114,-53.29 2114,-61.89"/>
+<polygon fill="black" stroke="black" points="2114,-71.9 2109.5,-61.9 2114,-66.9 2114,-61.9 2114,-61.9 2114,-61.9 2114,-66.9 2118.5,-61.9 2114,-71.9 2114,-71.9"/>
 </g>
 <!-- calcipy.experiments -->
 <g id="node10" class="node">
 <title>calcipy.experiments</title>
-<polygon fill="none" stroke="black" points="1941.88,-36 1817.12,-36 1817.12,0 1941.88,0 1941.88,-36"/>
-<text text-anchor="middle" x="1879.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.experiments</text>
+<polygon fill="none" stroke="black" points="2353,-36 2195,-36 2195,0 2353,0 2353,-36"/>
+<text text-anchor="middle" x="2274" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.experiments</text>
 </g>
 <!-- calcipy.experiments.bump_programmatically -->
 <g id="node11" class="node">
 <title>calcipy.experiments.bump_programmatically</title>
-<polygon fill="none" stroke="black" points="2224.62,-36 1960.38,-36 1960.38,0 2224.62,0 2224.62,-36"/>
-<text text-anchor="middle" x="2092.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.experiments.bump_programmatically</text>
+<polygon fill="none" stroke="black" points="2707,-36 2371,-36 2371,0 2707,0 2707,-36"/>
+<text text-anchor="middle" x="2539" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.experiments.bump_programmatically</text>
 </g>
 <!-- calcipy.experiments.check_duplicate_test_names -->
 <g id="node12" class="node">
 <title>calcipy.experiments.check_duplicate_test_names</title>
-<polygon fill="none" stroke="black" points="2526.38,-36 2242.62,-36 2242.62,0 2526.38,0 2526.38,-36"/>
-<text text-anchor="middle" x="2384.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.experiments.check_duplicate_test_names</text>
+<polygon fill="none" stroke="black" points="3087.5,-36 2724.5,-36 2724.5,0 3087.5,0 3087.5,-36"/>
+<text text-anchor="middle" x="2906" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.experiments.check_duplicate_test_names</text>
 </g>
 <!-- calcipy.file_search -->
 <g id="node13" class="node">
 <title>calcipy.file_search</title>
-<polygon fill="none" stroke="black" points="2662.12,-36 2544.88,-36 2544.88,0 2662.12,0 2662.12,-36"/>
-<text text-anchor="middle" x="2603.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.file_search</text>
+<polygon fill="none" stroke="black" points="3250,-36 3106,-36 3106,0 3250,0 3250,-36"/>
+<text text-anchor="middle" x="3178" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.file_search</text>
 </g>
 <!-- calcipy.md_writer -->
 <g id="node15" class="node">
 <title>calcipy.md_writer</title>
-<polygon fill="none" stroke="black" points="2795,-36 2680,-36 2680,0 2795,0 2795,-36"/>
-<text text-anchor="middle" x="2737.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.md_writer</text>
+<polygon fill="none" stroke="black" points="3410,-36 3268,-36 3268,0 3410,0 3410,-36"/>
+<text text-anchor="middle" x="3339" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.md_writer</text>
 </g>
 <!-- calcipy.md_writer._writer -->
 <g id="node16" class="node">
 <title>calcipy.md_writer._writer</title>
-<polygon fill="none" stroke="black" points="2816,-108 2659,-108 2659,-72 2816,-72 2816,-108"/>
-<text text-anchor="middle" x="2737.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.md_writer._writer</text>
+<polygon fill="none" stroke="black" points="3437,-108 3241,-108 3241,-72 3437,-72 3437,-108"/>
+<text text-anchor="middle" x="3339" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.md_writer._writer</text>
 </g>
 <!-- calcipy.md_writer&#45;&gt;calcipy.md_writer._writer -->
 <g id="edge6" class="edge">
 <title>calcipy.md_writer&#45;&gt;calcipy.md_writer._writer</title>
-<path fill="none" stroke="black" d="M2737.5,-36.3C2737.5,-43.68 2737.5,-52.48 2737.5,-60.75"/>
-<polygon fill="black" stroke="black" points="2737.5,-70.68 2733,-60.68 2737.5,-66.9 2737.5,-60.68 2737.5,-60.68 2737.5,-60.68 2737.5,-66.9 2742,-60.68 2737.5,-70.68"/>
+<path fill="none" stroke="black" d="M3339,-36.3C3339,-44.02 3339,-53.29 3339,-61.89"/>
+<polygon fill="black" stroke="black" points="3339,-71.9 3334.5,-61.9 3339,-66.9 3339,-61.9 3339,-61.9 3339,-61.9 3339,-66.9 3343.5,-61.9 3339,-71.9 3339,-71.9"/>
 </g>
 <!-- calcipy.noxfile -->
 <g id="node17" class="node">
 <title>calcipy.noxfile</title>
-<polygon fill="none" stroke="black" points="2954.62,-36 2858.38,-36 2858.38,0 2954.62,0 2954.62,-36"/>
-<text text-anchor="middle" x="2906.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.noxfile</text>
+<polygon fill="none" stroke="black" points="3600,-36 3484,-36 3484,0 3600,0 3600,-36"/>
+<text text-anchor="middle" x="3542" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.noxfile</text>
 </g>
 <!-- calcipy.noxfile._noxfile -->
 <g id="node18" class="node">
 <title>calcipy.noxfile._noxfile</title>
-<polygon fill="none" stroke="black" points="2979,-108 2834,-108 2834,-72 2979,-72 2979,-108"/>
-<text text-anchor="middle" x="2906.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.noxfile._noxfile</text>
+<polygon fill="none" stroke="black" points="3629,-108 3455,-108 3455,-72 3629,-72 3629,-108"/>
+<text text-anchor="middle" x="3542" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.noxfile._noxfile</text>
 </g>
 <!-- calcipy.noxfile&#45;&gt;calcipy.noxfile._noxfile -->
 <g id="edge7" class="edge">
 <title>calcipy.noxfile&#45;&gt;calcipy.noxfile._noxfile</title>
-<path fill="none" stroke="black" d="M2906.5,-36.3C2906.5,-43.68 2906.5,-52.48 2906.5,-60.75"/>
-<polygon fill="black" stroke="black" points="2906.5,-70.68 2902,-60.68 2906.5,-66.9 2906.5,-60.68 2906.5,-60.68 2906.5,-60.68 2906.5,-66.9 2911,-60.68 2906.5,-70.68"/>
+<path fill="none" stroke="black" d="M3542,-36.3C3542,-44.02 3542,-53.29 3542,-61.89"/>
+<polygon fill="black" stroke="black" points="3542,-71.9 3537.5,-61.9 3542,-66.9 3542,-61.9 3542,-61.9 3542,-61.9 3542,-66.9 3546.5,-61.9 3542,-71.9 3542,-71.9"/>
 </g>
 <!-- calcipy.scripts -->
 <g id="node19" class="node">
 <title>calcipy.scripts</title>
-<polygon fill="none" stroke="black" points="993.12,-36 899.88,-36 899.88,0 993.12,0 993.12,-36"/>
-<text text-anchor="middle" x="946.5" y="-12.95" font-family="Times,serif" font-size="14.00">calcipy.scripts</text>
+<polygon fill="none" stroke="black" points="1214.5,-36 1097.5,-36 1097.5,0 1214.5,0 1214.5,-36"/>
+<text text-anchor="middle" x="1156" y="-14.3" font-family="Times,serif" font-size="14.00">calcipy.scripts</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.cli -->
 <g id="edge8" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.cli</title>
-<path fill="none" stroke="black" d="M899.43,-35.77C872.92,-45.26 838.97,-57.49 800.7,-71.58"/>
-<polygon fill="black" stroke="black" points="791.49,-74.98 799.31,-67.3 795.03,-73.67 800.87,-71.52 800.87,-71.52 800.87,-71.52 795.03,-73.67 802.43,-75.74 791.49,-74.98"/>
+<path fill="none" stroke="black" d="M1097.25,-35.58C1063.83,-45.14 1020.98,-57.59 974.24,-71.97"/>
+<polygon fill="black" stroke="black" points="964.53,-74.97 972.76,-67.72 969.31,-73.5 974.09,-72.02 974.09,-72.02 974.09,-72.02 969.31,-73.5 975.41,-76.32 964.53,-74.97 964.53,-74.97"/>
 </g>
 <!-- calcipy.tasks -->
 <g id="node20" class="node">
 <title>calcipy.tasks</title>
-<polygon fill="none" stroke="black" points="1416,-108 1331,-108 1331,-72 1416,-72 1416,-108"/>
-<text text-anchor="middle" x="1373.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.tasks</text>
+<polygon fill="none" stroke="black" points="1709,-108 1603,-108 1603,-72 1709,-72 1709,-108"/>
+<text text-anchor="middle" x="1656" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.tasks</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks -->
 <g id="edge9" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks</title>
-<path fill="none" stroke="black" d="M993.62,-23.5C1064.32,-30.75 1201.78,-46.82 1316.5,-72 1317.66,-72.25 1318.83,-72.52 1320.01,-72.8"/>
-<polygon fill="black" stroke="black" points="1329.55,-75.21 1318.75,-77.12 1325.88,-74.28 1319.85,-72.76 1319.85,-72.76 1319.85,-72.76 1325.88,-74.28 1320.95,-68.39 1329.55,-75.21"/>
+<path fill="none" stroke="black" d="M1214.84,-23.82C1298.47,-31.21 1456.31,-47.15 1589,-72 1590.26,-72.24 1591.53,-72.48 1592.81,-72.74"/>
+<polygon fill="black" stroke="black" points="1602.74,-74.84 1592.03,-77.17 1597.85,-73.8 1592.96,-72.77 1592.96,-72.77 1592.96,-72.77 1597.85,-73.8 1593.89,-68.37 1602.74,-74.84 1602.74,-74.84"/>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks._invoke -->
 <g id="edge10" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks._invoke</title>
-<path fill="none" stroke="black" d="M993.36,-20.26C1069.27,-23.39 1213.87,-34.28 1245.5,-72 1291.11,-126.41 1195.36,-181.52 1129.9,-211.04"/>
-<polygon fill="black" stroke="black" points="1120.79,-215.07 1128.12,-206.91 1124.25,-213.54 1129.94,-211.03 1129.94,-211.03 1129.94,-211.03 1124.25,-213.54 1131.76,-215.14 1120.79,-215.07"/>
+<path fill="none" stroke="black" d="M1214.85,-18.71C1307.18,-19.64 1479.53,-27.49 1518,-72 1565.63,-127.11 1464.46,-182.74 1396.99,-211.99"/>
+<polygon fill="black" stroke="black" points="1387.71,-215.94 1395.15,-207.88 1392.31,-213.98 1396.91,-212.02 1396.91,-212.02 1396.91,-212.02 1392.31,-213.98 1398.68,-216.16 1387.71,-215.94 1387.71,-215.94"/>
 </g>
 <!-- calcipy.tasks.all_tasks -->
 <g id="node22" class="node">
 <title>calcipy.tasks.all_tasks</title>
-<polygon fill="none" stroke="black" points="944.5,-108 808.5,-108 808.5,-72 944.5,-72 944.5,-108"/>
-<text text-anchor="middle" x="876.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.all_tasks</text>
+<polygon fill="none" stroke="black" points="1155,-108 983,-108 983,-72 1155,-72 1155,-108"/>
+<text text-anchor="middle" x="1069" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.all_tasks</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.all_tasks -->
 <g id="edge11" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.all_tasks</title>
-<path fill="none" stroke="black" d="M929.2,-36.3C920.8,-44.7 910.57,-54.93 901.36,-64.14"/>
-<polygon fill="black" stroke="black" points="894.47,-71.03 898.35,-60.78 897.14,-68.36 901.54,-63.96 901.54,-63.96 901.54,-63.96 897.14,-68.36 904.72,-67.15 894.47,-71.03"/>
+<path fill="none" stroke="black" d="M1134.49,-36.3C1123.54,-45.12 1110.05,-55.97 1098.18,-65.53"/>
+<polygon fill="black" stroke="black" points="1090.26,-71.9 1095.23,-62.12 1094.15,-68.76 1098.05,-65.63 1098.05,-65.63 1098.05,-65.63 1094.15,-68.76 1100.87,-69.13 1090.26,-71.9 1090.26,-71.9"/>
 </g>
 <!-- calcipy.tasks.cl -->
 <g id="node23" class="node">
 <title>calcipy.tasks.cl</title>
-<polygon fill="none" stroke="black" points="530.75,-180 432.25,-180 432.25,-144 530.75,-144 530.75,-180"/>
-<text text-anchor="middle" x="481.5" y="-156.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.cl</text>
+<polygon fill="none" stroke="black" points="672,-252 550,-252 550,-216 672,-216 672,-252"/>
+<text text-anchor="middle" x="611" y="-230.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.cl</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.cl -->
 <g id="edge12" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.cl</title>
-<path fill="none" stroke="black" d="M899.41,-20.59C806.68,-24.46 604.32,-36.79 545.5,-72 521.72,-86.23 504.29,-113.07 493.67,-133.57"/>
-<polygon fill="black" stroke="black" points="489.28,-142.51 489.65,-131.55 490.95,-139.12 493.69,-133.54 493.69,-133.54 493.69,-133.54 490.95,-139.12 497.73,-135.52 489.28,-142.51"/>
+<path fill="none" stroke="black" d="M1097.31,-18.37C1014.66,-19.26 860.37,-27.51 738,-72 682.39,-92.22 658.59,-94.61 626,-144 613.97,-162.23 610.59,-187 610.01,-205.78"/>
+<polygon fill="black" stroke="black" points="609.95,-215.78 605.51,-205.75 609.98,-210.78 610.01,-205.78 610.01,-205.78 610.01,-205.78 609.98,-210.78 614.51,-205.82 609.95,-215.78 609.95,-215.78"/>
 </g>
 <!-- calcipy.tasks.defaults -->
 <g id="node24" class="node">
 <title>calcipy.tasks.defaults</title>
-<polygon fill="none" stroke="black" points="1141.25,-180 1009.75,-180 1009.75,-144 1141.25,-144 1141.25,-180"/>
-<text text-anchor="middle" x="1075.5" y="-156.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.defaults</text>
+<polygon fill="none" stroke="black" points="1427,-180 1259,-180 1259,-144 1427,-144 1427,-180"/>
+<text text-anchor="middle" x="1343" y="-158.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.defaults</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.defaults -->
 <g id="edge13" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.defaults</title>
-<path fill="none" stroke="black" d="M993.3,-24.04C1023.95,-30.04 1061.86,-43.19 1081.5,-72 1093.55,-89.67 1090.85,-114.18 1085.81,-133.01"/>
-<polygon fill="black" stroke="black" points="1082.93,-142.44 1081.54,-131.57 1084.03,-138.83 1085.85,-132.88 1085.85,-132.88 1085.85,-132.88 1084.03,-138.83 1090.15,-134.19 1082.93,-142.44"/>
+<path fill="none" stroke="black" d="M1214.86,-23.17C1250.98,-28.85 1295.45,-41.96 1323,-72 1338.26,-88.64 1342.73,-114.36 1343.69,-133.87"/>
+<polygon fill="black" stroke="black" points="1343.91,-143.98 1339.19,-134.08 1343.8,-138.98 1343.69,-133.99 1343.69,-133.99 1343.69,-133.99 1343.8,-138.98 1348.19,-133.89 1343.91,-143.98 1343.91,-143.98"/>
 </g>
 <!-- calcipy.tasks.doc -->
 <g id="node25" class="node">
 <title>calcipy.tasks.doc</title>
-<polygon fill="none" stroke="black" points="615.62,-252 507.38,-252 507.38,-216 615.62,-216 615.62,-252"/>
-<text text-anchor="middle" x="561.5" y="-228.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.doc</text>
+<polygon fill="none" stroke="black" points="770.5,-180 635.5,-180 635.5,-144 770.5,-144 770.5,-180"/>
+<text text-anchor="middle" x="703" y="-158.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.doc</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.doc -->
 <g id="edge14" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.doc</title>
-<path fill="none" stroke="black" d="M899.49,-18.63C838.23,-20.04 729.39,-29.09 648.5,-72 609.07,-92.92 599.11,-104.41 578.5,-144 568.73,-162.77 564.53,-186.39 562.75,-204.58"/>
-<polygon fill="black" stroke="black" points="561.99,-214.43 558.27,-204.11 562.28,-210.66 562.76,-204.46 562.76,-204.46 562.76,-204.46 562.28,-210.66 567.25,-204.81 561.99,-214.43"/>
+<path fill="none" stroke="black" d="M1097.41,-22.58C1006.92,-28.91 838.05,-44.1 785,-72 757.01,-86.72 733.59,-114.89 719.04,-135.61"/>
+<polygon fill="black" stroke="black" points="713.36,-143.97 715.26,-133.17 716.17,-139.84 718.98,-135.7 718.98,-135.7 718.98,-135.7 716.17,-139.84 722.7,-138.23 713.36,-143.97 713.36,-143.97"/>
 </g>
 <!-- calcipy.tasks.lint -->
 <g id="node27" class="node">
 <title>calcipy.tasks.lint</title>
-<polygon fill="none" stroke="black" points="693.88,-180 587.12,-180 587.12,-144 693.88,-144 693.88,-180"/>
-<text text-anchor="middle" x="640.5" y="-156.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.lint</text>
+<polygon fill="none" stroke="black" points="866,-252 732,-252 732,-216 866,-216 866,-252"/>
+<text text-anchor="middle" x="799" y="-230.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.lint</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.lint -->
 <g id="edge15" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.lint</title>
-<path fill="none" stroke="black" d="M899.42,-22.87C831.34,-29.34 709.88,-44.44 676.5,-72 658.23,-87.08 649.15,-112.84 644.69,-132.78"/>
-<polygon fill="black" stroke="black" points="642.79,-142.53 640.29,-131.85 643.52,-138.82 644.7,-132.71 644.7,-132.71 644.7,-132.71 643.52,-138.82 649.12,-133.57 642.79,-142.53"/>
+<path fill="none" stroke="black" d="M1097.18,-23.59C1021.84,-30.46 896.49,-45.53 859,-72 815.64,-102.62 803.57,-168.45 800.24,-205.76"/>
+<polygon fill="black" stroke="black" points="799.49,-215.91 795.74,-205.61 799.86,-210.92 800.23,-205.94 800.23,-205.94 800.23,-205.94 799.86,-210.92 804.71,-206.27 799.49,-215.91 799.49,-215.91"/>
 </g>
 <!-- calcipy.tasks.pack -->
 <g id="node29" class="node">
 <title>calcipy.tasks.pack</title>
-<polygon fill="none" stroke="black" points="826.62,-252 712.38,-252 712.38,-216 826.62,-216 826.62,-252"/>
-<text text-anchor="middle" x="769.5" y="-228.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.pack</text>
+<polygon fill="none" stroke="black" points="970.5,-180 827.5,-180 827.5,-144 970.5,-144 970.5,-180"/>
+<text text-anchor="middle" x="899" y="-158.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.pack</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.pack -->
 <g id="edge16" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.pack</title>
-<path fill="none" stroke="black" d="M899.39,-22.71C837.19,-28.69 732.83,-42.88 709.5,-72 676.8,-112.82 717.04,-173.25 745.64,-207.27"/>
-<polygon fill="black" stroke="black" points="752.17,-214.81 742.22,-210.2 749.7,-211.95 745.62,-207.25 745.62,-207.25 745.62,-207.25 749.7,-211.95 749.02,-204.31 752.17,-214.81"/>
+<path fill="none" stroke="black" d="M1097.35,-21.32C1022.23,-25.67 898.34,-37.93 870,-72 854.95,-90.09 866.21,-116.2 878.83,-135.46"/>
+<polygon fill="black" stroke="black" points="884.63,-143.77 875.22,-138.15 881.77,-139.67 878.91,-135.57 878.91,-135.57 878.91,-135.57 881.77,-139.67 882.6,-133 884.63,-143.77 884.63,-143.77"/>
 </g>
 <!-- calcipy.tasks.tags -->
 <g id="node31" class="node">
 <title>calcipy.tasks.tags</title>
-<polygon fill="none" stroke="black" points="1072.75,-108 962.25,-108 962.25,-72 1072.75,-72 1072.75,-108"/>
-<text text-anchor="middle" x="1017.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.tags</text>
+<polygon fill="none" stroke="black" points="1314.5,-108 1173.5,-108 1173.5,-72 1314.5,-72 1314.5,-108"/>
+<text text-anchor="middle" x="1244" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.tags</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.tags -->
 <g id="edge17" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.tags</title>
-<path fill="none" stroke="black" d="M964.05,-36.3C972.56,-44.7 982.94,-54.93 992.28,-64.14"/>
-<polygon fill="black" stroke="black" points="999.28,-71.04 989,-67.22 996.59,-68.39 992.16,-64.02 992.16,-64.02 992.16,-64.02 996.59,-68.39 995.32,-60.81 999.28,-71.04"/>
+<path fill="none" stroke="black" d="M1177.75,-36.3C1188.84,-45.12 1202.47,-55.97 1214.49,-65.53"/>
+<polygon fill="black" stroke="black" points="1222.5,-71.9 1211.87,-69.19 1218.58,-68.78 1214.67,-65.67 1214.67,-65.67 1214.67,-65.67 1218.58,-68.78 1217.47,-62.15 1222.5,-71.9 1222.5,-71.9"/>
 </g>
 <!-- calcipy.tasks.test -->
 <g id="node32" class="node">
 <title>calcipy.tasks.test</title>
-<polygon fill="none" stroke="black" points="1236.25,-108 1128.75,-108 1128.75,-72 1236.25,-72 1236.25,-108"/>
-<text text-anchor="middle" x="1182.5" y="-84.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.test</text>
+<polygon fill="none" stroke="black" points="1509,-108 1371,-108 1371,-72 1509,-72 1509,-108"/>
+<text text-anchor="middle" x="1440" y="-86.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.test</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.test -->
 <g id="edge18" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.test</title>
-<path fill="none" stroke="black" d="M993.41,-32.91C1029.12,-43.51 1078.67,-58.2 1118.1,-69.9"/>
-<polygon fill="black" stroke="black" points="1127.5,-72.69 1116.63,-74.16 1123.87,-71.61 1117.91,-69.84 1117.91,-69.84 1117.91,-69.84 1123.87,-71.61 1119.19,-65.53 1127.5,-72.69"/>
+<path fill="none" stroke="black" d="M1214.5,-33.42C1256.87,-43.86 1314.63,-58.1 1361.08,-69.55"/>
+<polygon fill="black" stroke="black" points="1370.81,-71.95 1360.02,-73.92 1365.95,-70.75 1361.1,-69.55 1361.1,-69.55 1361.1,-69.55 1365.95,-70.75 1362.18,-65.18 1370.81,-71.95 1370.81,-71.95"/>
 </g>
 <!-- calcipy.tasks.types -->
 <g id="node33" class="node">
 <title>calcipy.tasks.types</title>
-<polygon fill="none" stroke="black" points="1358.12,-324 1240.88,-324 1240.88,-288 1358.12,-288 1358.12,-324"/>
-<text text-anchor="middle" x="1299.5" y="-300.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.types</text>
+<polygon fill="none" stroke="black" points="1654.5,-324 1505.5,-324 1505.5,-288 1654.5,-288 1654.5,-324"/>
+<text text-anchor="middle" x="1580" y="-302.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.types</text>
 </g>
 <!-- calcipy.scripts&#45;&gt;calcipy.tasks.types -->
 <g id="edge19" class="edge">
 <title>calcipy.scripts&#45;&gt;calcipy.tasks.types</title>
-<path fill="none" stroke="black" d="M993.61,-20.23C1073.01,-23.34 1228.46,-34.22 1265.5,-72 1319.57,-127.15 1312.35,-227.79 1304.86,-276.75"/>
-<polygon fill="black" stroke="black" points="1303.23,-286.55 1300.43,-275.95 1303.85,-282.82 1304.87,-276.69 1304.87,-276.69 1304.87,-276.69 1303.85,-282.82 1309.31,-277.42 1303.23,-286.55"/>
+<path fill="none" stroke="black" d="M1214.62,-18.98C1310.28,-20.24 1493.81,-28.44 1539,-72 1595.36,-126.33 1590.53,-228.9 1584.38,-277.78"/>
+<polygon fill="black" stroke="black" points="1582.98,-287.9 1579.89,-277.38 1583.67,-282.95 1584.35,-277.99 1584.35,-277.99 1584.35,-277.99 1583.67,-282.95 1588.8,-278.61 1582.98,-287.9 1582.98,-287.9"/>
 </g>
 <!-- calcipy.tasks._invoke&#45;&gt;calcipy.tasks.types -->
 <g id="edge20" class="edge">
 <title>calcipy.tasks._invoke&#45;&gt;calcipy.tasks.types</title>
-<path fill="none" stroke="black" d="M1131.45,-252.48C1162.43,-262.17 1201.13,-274.26 1233.58,-284.4"/>
-<polygon fill="black" stroke="black" points="1242.72,-287.25 1231.83,-288.57 1239.11,-286.13 1233.17,-284.27 1233.17,-284.27 1233.17,-284.27 1239.11,-286.13 1234.51,-279.98 1242.72,-287.25"/>
+<path fill="none" stroke="black" d="M1400.67,-252.03C1434.36,-261.99 1477.05,-274.59 1512.33,-285.01"/>
+<polygon fill="black" stroke="black" points="1522.07,-287.89 1511.2,-289.37 1517.27,-286.47 1512.48,-285.06 1512.48,-285.06 1512.48,-285.06 1517.27,-286.47 1513.75,-280.74 1522.07,-287.89 1522.07,-287.89"/>
 </g>
 <!-- calcipy.tasks.all_tasks&#45;&gt;calcipy.tasks._invoke -->
 <g id="edge21" class="edge">
 <title>calcipy.tasks.all_tasks&#45;&gt;calcipy.tasks._invoke</title>
-<path fill="none" stroke="black" d="M900.7,-108.45C925.66,-126.43 965.75,-155.25 1000.5,-180 1013.98,-189.6 1028.86,-200.13 1041.79,-209.26"/>
-<polygon fill="black" stroke="black" points="1049.81,-214.92 1039.05,-212.83 1046.72,-212.74 1041.64,-209.15 1041.64,-209.15 1041.64,-209.15 1046.72,-212.74 1044.24,-205.48 1049.81,-214.92"/>
+<path fill="none" stroke="black" d="M1130.11,-108.02C1156.12,-116.7 1186.12,-128.7 1211,-144 1231.09,-156.36 1230.96,-166.07 1250,-180 1265.42,-191.28 1283.46,-202.05 1299.52,-210.9"/>
+<polygon fill="black" stroke="black" points="1308.71,-215.88 1297.78,-215.08 1304.32,-213.5 1299.92,-211.12 1299.92,-211.12 1299.92,-211.12 1304.32,-213.5 1302.06,-207.16 1308.71,-215.88 1308.71,-215.88"/>
 </g>
 <!-- calcipy.tasks.all_tasks&#45;&gt;calcipy.tasks.defaults -->
 <g id="edge22" class="edge">
 <title>calcipy.tasks.all_tasks&#45;&gt;calcipy.tasks.defaults</title>
-<path fill="none" stroke="black" d="M926.2,-108.48C953.37,-118.04 987.22,-129.95 1015.81,-140"/>
-<polygon fill="black" stroke="black" points="1024.94,-143.21 1014.01,-144.14 1021.37,-141.96 1015.5,-139.9 1015.5,-139.9 1015.5,-139.9 1021.37,-141.96 1017,-135.65 1024.94,-143.21"/>
+<path fill="none" stroke="black" d="M1135.68,-108.03C1175.13,-118.11 1225.25,-130.92 1266.33,-141.41"/>
+<polygon fill="black" stroke="black" points="1276.02,-143.89 1265.22,-145.77 1271.18,-142.65 1266.33,-141.41 1266.33,-141.41 1266.33,-141.41 1271.18,-142.65 1267.45,-137.05 1276.02,-143.89 1276.02,-143.89"/>
 </g>
 <!-- calcipy.tasks.executable_utils -->
 <g id="node26" class="node">
 <title>calcipy.tasks.executable_utils</title>
-<polygon fill="none" stroke="black" points="855.75,-396 679.25,-396 679.25,-360 855.75,-360 855.75,-396"/>
-<text text-anchor="middle" x="767.5" y="-372.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.executable_utils</text>
+<polygon fill="none" stroke="black" points="1027,-396 801,-396 801,-360 1027,-360 1027,-396"/>
+<text text-anchor="middle" x="914" y="-374.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.executable_utils</text>
 </g>
 <!-- calcipy.tasks.cl&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge23" class="edge">
 <title>calcipy.tasks.cl&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M481.27,-180.36C481.79,-199.3 484.93,-229.88 498.5,-252 525.84,-296.55 545.03,-300.06 591.5,-324 618.04,-337.67 648.68,-348.43 676.89,-356.57"/>
-<polygon fill="black" stroke="black" points="686.39,-359.24 675.55,-360.87 682.75,-358.22 676.77,-356.54 676.77,-356.54 676.77,-356.54 682.75,-358.22 677.98,-352.21 686.39,-359.24"/>
+<path fill="none" stroke="black" d="M621.55,-252.28C634.91,-272.65 659.85,-305.98 690,-324 720.36,-342.14 756.51,-354.08 790.81,-361.92"/>
+<polygon fill="black" stroke="black" points="800.9,-364.13 790.17,-366.39 796.02,-363.06 791.14,-362 791.14,-362 791.14,-362 796.02,-363.06 792.1,-357.6 800.9,-364.13 800.9,-364.13"/>
 </g>
 <!-- calcipy.tasks.defaults&#45;&gt;calcipy.tasks._invoke -->
 <g id="edge24" class="edge">
 <title>calcipy.tasks.defaults&#45;&gt;calcipy.tasks._invoke</title>
-<path fill="none" stroke="black" d="M1075.5,-180.3C1075.5,-187.68 1075.5,-196.48 1075.5,-204.75"/>
-<polygon fill="black" stroke="black" points="1075.5,-214.68 1071,-204.68 1075.5,-210.9 1075.5,-204.68 1075.5,-204.68 1075.5,-204.68 1075.5,-210.9 1080,-204.68 1075.5,-214.68"/>
+<path fill="none" stroke="black" d="M1343,-180.3C1343,-188.02 1343,-197.29 1343,-205.89"/>
+<polygon fill="black" stroke="black" points="1343,-215.9 1338.5,-205.9 1343,-210.9 1343,-205.9 1343,-205.9 1343,-205.9 1343,-210.9 1347.5,-205.9 1343,-215.9 1343,-215.9"/>
 </g>
 <!-- calcipy.tasks.doc&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge25" class="edge">
 <title>calcipy.tasks.doc&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M570.81,-252.38C582.23,-272.21 603.35,-304.42 629.5,-324 647.43,-337.42 669.17,-347.85 690.04,-355.77"/>
-<polygon fill="black" stroke="black" points="699.37,-359.15 688.44,-359.97 695.82,-357.86 689.97,-355.74 689.97,-355.74 689.97,-355.74 695.82,-357.86 691.51,-351.51 699.37,-359.15"/>
+<path fill="none" stroke="black" d="M704.64,-180.1C706.9,-198.56 712.02,-228.47 723,-252 740.03,-288.49 745.82,-299.79 778,-324 796.26,-337.74 818.54,-348.38 839.73,-356.39"/>
+<polygon fill="black" stroke="black" points="849.37,-359.89 838.44,-360.71 844.67,-358.19 839.97,-356.48 839.97,-356.48 839.97,-356.48 844.67,-358.19 841.51,-352.25 849.37,-359.89 849.37,-359.89"/>
 </g>
 <!-- calcipy.tasks.lint&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge26" class="edge">
 <title>calcipy.tasks.lint&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M637.98,-180.38C634.36,-212.1 631.21,-280.13 662.5,-324 671.8,-337.03 685.25,-347.06 699.44,-354.69"/>
-<polygon fill="black" stroke="black" points="708.25,-359.06 697.29,-358.64 704.86,-357.38 699.29,-354.61 699.29,-354.61 699.29,-354.61 704.86,-357.38 701.29,-350.58 708.25,-359.06"/>
+<path fill="none" stroke="black" d="M790.88,-252.29C783.19,-271.45 774.75,-302.48 789,-324 798.11,-337.75 811.57,-347.95 826.34,-355.5"/>
+<polygon fill="black" stroke="black" points="835.67,-359.87 824.71,-359.71 831.14,-357.75 826.62,-355.63 826.62,-355.63 826.62,-355.63 831.14,-357.75 828.52,-351.55 835.67,-359.87 835.67,-359.87"/>
 </g>
 <!-- calcipy.tasks.nox -->
 <g id="node28" class="node">
 <title>calcipy.tasks.nox</title>
-<polygon fill="none" stroke="black" points="781,-324 672,-324 672,-288 781,-288 781,-324"/>
-<text text-anchor="middle" x="726.5" y="-300.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.nox</text>
+<polygon fill="none" stroke="black" points="934,-324 798,-324 798,-288 934,-288 934,-324"/>
+<text text-anchor="middle" x="866" y="-302.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.nox</text>
 </g>
 <!-- calcipy.tasks.nox&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge27" class="edge">
 <title>calcipy.tasks.nox&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M736.63,-324.3C741.25,-332.19 746.82,-341.7 751.95,-350.45"/>
-<polygon fill="black" stroke="black" points="756.87,-358.84 747.93,-352.49 754.95,-355.58 751.81,-350.22 751.81,-350.22 751.81,-350.22 754.95,-355.58 755.69,-347.94 756.87,-358.84"/>
+<path fill="none" stroke="black" d="M877.87,-324.3C883.5,-332.53 890.35,-342.52 896.57,-351.58"/>
+<polygon fill="black" stroke="black" points="902.27,-359.9 892.9,-354.19 899.44,-355.77 896.62,-351.65 896.62,-351.65 896.62,-351.65 899.44,-355.77 900.33,-349.1 902.27,-359.9 902.27,-359.9"/>
 </g>
 <!-- calcipy.tasks.pack&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge28" class="edge">
 <title>calcipy.tasks.pack&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M777.81,-252.21C782.24,-262.37 787.24,-275.62 789.5,-288 792.37,-303.74 792.63,-308.31 789.5,-324 787.77,-332.7 784.58,-341.75 781.16,-349.86"/>
-<polygon fill="black" stroke="black" points="777.13,-358.77 777.15,-347.8 778.69,-355.32 781.25,-349.66 781.25,-349.66 781.25,-349.66 778.69,-355.32 785.35,-351.51 777.13,-358.77"/>
+<path fill="none" stroke="black" d="M909.79,-180.34C926.76,-209.79 956.42,-271.5 943,-324 940.62,-333.3 936.24,-342.73 931.58,-351"/>
+<polygon fill="black" stroke="black" points="926.31,-359.78 927.6,-348.89 928.88,-355.5 931.46,-351.21 931.46,-351.21 931.46,-351.21 928.88,-355.5 935.31,-353.53 926.31,-359.78 926.31,-359.78"/>
 </g>
 <!-- calcipy.tasks.stale -->
 <g id="node30" class="node">
 <title>calcipy.tasks.stale</title>
-<polygon fill="none" stroke="black" points="951.25,-324 837.75,-324 837.75,-288 951.25,-288 951.25,-324"/>
-<text text-anchor="middle" x="894.5" y="-300.95" font-family="Times,serif" font-size="14.00">calcipy.tasks.stale</text>
+<polygon fill="none" stroke="black" points="1135.5,-324 990.5,-324 990.5,-288 1135.5,-288 1135.5,-324"/>
+<text text-anchor="middle" x="1063" y="-302.3" font-family="Times,serif" font-size="14.00">calcipy.tasks.stale</text>
 </g>
 <!-- calcipy.tasks.stale&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge29" class="edge">
 <title>calcipy.tasks.stale&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M862.78,-324.48C846.29,-333.57 825.95,-344.78 808.3,-354.51"/>
-<polygon fill="black" stroke="black" points="799.88,-359.15 806.47,-350.38 803.19,-357.33 808.64,-354.32 808.64,-354.32 808.64,-354.32 803.19,-357.33 810.81,-358.27 799.88,-359.15"/>
+<path fill="none" stroke="black" d="M1026.55,-324.12C1006.36,-333.61 981.08,-345.49 959.59,-355.58"/>
+<polygon fill="black" stroke="black" points="950.33,-359.93 957.47,-351.61 954.86,-357.81 959.38,-355.68 959.38,-355.68 959.38,-355.68 954.86,-357.81 961.3,-359.75 950.33,-359.93 950.33,-359.93"/>
 </g>
 <!-- calcipy.tasks.tags&#45;&gt;calcipy.tasks.defaults -->
 <g id="edge30" class="edge">
 <title>calcipy.tasks.tags&#45;&gt;calcipy.tasks.defaults</title>
-<path fill="none" stroke="black" d="M1031.84,-108.3C1038.58,-116.44 1046.76,-126.31 1054.2,-135.3"/>
-<polygon fill="black" stroke="black" points="1060.55,-142.96 1050.71,-138.13 1058.14,-140.05 1054.17,-135.26 1054.17,-135.26 1054.17,-135.26 1058.14,-140.05 1057.64,-132.39 1060.55,-142.96"/>
+<path fill="none" stroke="black" d="M1268.22,-108.12C1280.92,-117.11 1296.66,-128.24 1310.42,-137.97"/>
+<polygon fill="black" stroke="black" points="1318.69,-143.81 1307.93,-141.71 1314.61,-140.92 1310.52,-138.04 1310.52,-138.04 1310.52,-138.04 1314.61,-140.92 1313.12,-134.36 1318.69,-143.81 1318.69,-143.81"/>
 </g>
 <!-- calcipy.tasks.test&#45;&gt;calcipy.tasks.defaults -->
 <g id="edge31" class="edge">
 <title>calcipy.tasks.test&#45;&gt;calcipy.tasks.defaults</title>
-<path fill="none" stroke="black" d="M1155.78,-108.48C1142.27,-117.32 1125.69,-128.16 1111.12,-137.7"/>
-<polygon fill="black" stroke="black" points="1102.9,-143.07 1108.81,-133.83 1106.07,-141 1111.27,-137.6 1111.27,-137.6 1111.27,-137.6 1106.07,-141 1113.74,-141.36 1102.9,-143.07"/>
+<path fill="none" stroke="black" d="M1416.02,-108.3C1403.69,-117.2 1388.48,-128.18 1375.15,-137.8"/>
+<polygon fill="black" stroke="black" points="1366.7,-143.9 1372.18,-134.39 1370.76,-140.97 1374.81,-138.04 1374.81,-138.04 1374.81,-138.04 1370.76,-140.97 1377.44,-141.69 1366.7,-143.9 1366.7,-143.9"/>
 </g>
 <!-- calcipy.tasks.test&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge32" class="edge">
 <title>calcipy.tasks.test&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M1184.13,-108.33C1186.17,-140.55 1185.85,-210.23 1150.5,-252 1080.62,-334.56 955.42,-362.99 867.22,-372.56"/>
-<polygon fill="black" stroke="black" points="857.33,-373.56 866.82,-368.07 861.09,-373.18 867.28,-372.55 867.28,-372.55 867.28,-372.55 861.09,-373.18 867.73,-377.03 857.33,-373.56"/>
+<path fill="none" stroke="black" d="M1445.41,-108.34C1454.31,-140.6 1467.87,-210.32 1434,-252 1384.66,-312.72 1174.92,-347.67 1037.35,-364.46"/>
+<polygon fill="black" stroke="black" points="1027.16,-365.69 1036.55,-360.02 1032.13,-365.09 1037.09,-364.49 1037.09,-364.49 1037.09,-364.49 1032.13,-365.09 1037.63,-368.96 1027.16,-365.69 1027.16,-365.69"/>
 </g>
 <!-- calcipy.tasks.types&#45;&gt;calcipy.tasks.executable_utils -->
 <g id="edge33" class="edge">
 <title>calcipy.tasks.types&#45;&gt;calcipy.tasks.executable_utils</title>
-<path fill="none" stroke="black" d="M1240.65,-321.31C1235.88,-322.29 1231.12,-323.2 1226.5,-324 1103.46,-345.36 960.34,-360.34 867.05,-368.8"/>
-<polygon fill="black" stroke="black" points="857.13,-369.69 866.69,-364.31 860.9,-369.35 867.09,-368.8 867.09,-368.8 867.09,-368.8 860.9,-369.35 867.5,-373.28 857.13,-369.69"/>
+<path fill="none" stroke="black" d="M1505.19,-321.98C1500.74,-322.7 1496.31,-323.39 1492,-324 1335.8,-346.19 1154.48,-361.06 1037.17,-369.27"/>
+<polygon fill="black" stroke="black" points="1027.08,-369.97 1036.75,-364.79 1032.07,-369.62 1037.06,-369.28 1037.06,-369.28 1037.06,-369.28 1032.07,-369.62 1037.37,-373.76 1027.08,-369.97 1027.08,-369.97"/>
 </g>
 </g>
 </svg>
diff --git a/search/search_index.json b/search/search_index.json
index af568783..4f912ea0 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"calcipy","text":"<p><code>calcipy</code> is a Python package that implements best practices such as code style (linting, auto-fixes), documentation, CI/CD, and logging. Like the calcium carbonate in hard coral, packages can be built on the <code>calcipy</code> foundation.</p> <p><code>calcipy</code> has some configurability, but is tailored for my particular use cases. If you want the same sort of functionality, there are a number of alternatives to consider:</p> <ul> <li>pyscaffold is a much more mature project that aims for the same goals, but with a slightly different approach and tech stack (tox vs. nox, cookiecutter vs. copier, etc.)</li> <li>tidypy, pylama, and codecheck offer similar functionality of bundling and running static checkers, but makes far fewer assumptions</li> <li>pytoil is a general CLI tool for developer automation</li> <li>And many more such as pyta, prospector, wemake-python-styleguide / cjolowicz/cookiecutter-hypermodern-python, formate, johnthagen/python-blueprint, oxsecurity/megalinter, etc.</li> </ul>"},{"location":"#installation","title":"Installation","text":"<p>Calcipy needs a few static files managed using copier and a template project: kyleking/calcipy_template</p> <p>You can quickly use the template to create a new project or add calcipy to an existing one:</p> <pre><code># Install copier. pipx is recommended\npipx install copier\n\n# To create a new project\ncopier copy gh:KyleKing/calcipy_template new_project\ncd new_project\n\n# Or convert/update an existing one\ncd my_project\ncopier copy gh:KyleKing/calcipy_template .\ncopier update\n</code></pre>"},{"location":"#calcipy-cli","title":"Calcipy CLI","text":"<p>Additionally, <code>calcipy</code> can be run as a CLI application without adding the package as a dependency.</p> <p>Quick Start:</p> <pre><code># For the CLI, only install a few of the extras which can be used from a few different CLI commands\npipx install 'calcipy[flake8,lint,tags]'\n\n# Use 'tags' to create a CODE_TAG_SUMMARY of the specified directory\ncalcipy-tags tags --help\ncalcipy-tags tags --base-dir=~/path/to/my_project\n\n# You can list all provided CLI commands with\npipx list\n</code></pre> <pre><code>venvs are in ~/.local/pipx/venvs\napps are exposed on your $PATH at ~/.local/bin\n   package calcipy 1.4.0, installed using Python 3.11.4\n    - calcipy\n    - calcipy-lint\n    - calcipy-pack\n    - calcipy-tags\n    - calcipy-types\n</code></pre> <p>Note: the CLI output below is compressed for readability, but you can try running each of these commands locally to see the most up-to-date documentation and the full set of options. The \u201cUsage\u201d, \u201cCore options\u201d, and \u201cGlobal Task Options\u201d are the same for each subsequent command, so they are excluded for brevity.</p> <pre><code>&gt; calcipy-lint\nUsage: calcipy-lint [--core-opts] &lt;subcommand&gt; [--subcommand-opts] ...\n\nCore options:\n\n  --complete                         Print tab-completion candidates for given parse remainder.\n  --hide=STRING                      Set default value of run()'s 'hide' kwarg.\n  --print-completion-script=STRING   Print the tab-completion script for your preferred shell (bash|zsh|fish).\n  --prompt-for-sudo-password         Prompt user at start of session for the sudo.password config value.\n  --write-pyc                        Enable creation of .pyc files.\n  -d, --debug                        Enable debug output.\n  -D INT, --list-depth=INT           When listing tasks, only show the first INT levels.\n  -e, --echo                         Echo executed commands before running.\n  -f STRING, --config=STRING         Runtime configuration file to use.\n  -F STRING, --list-format=STRING    Change the display format used when listing tasks. Should be one of: flat (default), nested, json.\n  -h [STRING], --help[=STRING]       Show core or per-task help and exit.\n  -l [STRING], --list[=STRING]       List available tasks, optionally limited to a namespace.\n  -p, --pty                          Use a pty when executing shell commands.\n  -R, --dry                          Echo commands instead of running.\n  -T INT, --command-timeout=INT      Specify a global command execution timeout, in seconds.\n  -V, --version                      Show version and exit.\n  -w, --warn-only                    Warn, instead of failing, when shell commands fail.\n\nSubcommands:\n\n  lint.autopep8       Run autopep8.\n  lint.check (lint)   Run ruff as check-only.\n  lint.fix            Run ruff and apply fixes.\n  lint.flake8         Run flake8.\n  lint.pre-commit     Run pre-commit.\n  lint.pylint         Run pylint.\n  lint.security       Attempt to identify possible security vulnerabilities.\n  lint.watch          Run ruff as check-only.\n\nGlobal Task Options:\n\n  *file_args             List of Paths available globally to all tasks. Will resolve paths with working_dir\n  --keep-going           Continue running tasks even on failure\n  --working_dir=STRING   Set the cwd for the program. Example: \"../run --working-dir .. lint test\"\n  -v,-vv,-vvv            Globally configure logger verbosity (-vvv for most verbose)\n\n&gt; calcipy-pack\n\nSubcommands:\n\n  pack.check-licenses   Check licenses for compatibility with `licensecheck`.\n  pack.install-extras   Run poetry install with all extras.\n  pack.lock             Ensure poetry.lock is  up-to-date.\n  pack.publish          Build the distributed format(s) and publish.\n\n&gt; calcipy-tags\n\nSubcommands:\n\n  tags.collect-code-tags (tags)   Create a `CODE_TAG_SUMMARY.md` with a table          for TODO- and FIXME-style code comments.\n\n&gt; calcipy-types\n\nSubcommands:\n\n  types.mypy      Run mypy.\n  types.pyright   Run pyright.\n</code></pre>"},{"location":"#calcipy-pre-commit","title":"Calcipy Pre-Commit","text":"<p><code>calcipy</code> can also be used as a <code>pre-commit</code> task by adding the below snippet to your <code>pre-commit</code> file:</p> <pre><code>repos:\n  - repo: https://github.com/KyleKing/calcipy\n    rev: main\n    hooks:\n      - id: tags\n      - id: lint-fix\n      - id: types\n</code></pre>"},{"location":"#project-status","title":"Project Status","text":"<p>See the <code>Open Issues</code> and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:</p> <ul> <li>DEVELOPER_GUIDE</li> <li>STYLE_GUIDE</li> </ul>"},{"location":"#code-of-conduct","title":"Code of Conduct","text":"<p>We follow the Contributor Covenant Code of Conduct.</p>"},{"location":"#open-source-status","title":"Open Source Status","text":"<p>We try to reasonably meet most aspects of the \u201cOpenSSF scorecard\u201d from Open Source Insights</p>"},{"location":"#responsible-disclosure","title":"Responsible Disclosure","text":"<p>If you have any security issue to report, please contact the project maintainers privately. You can reach us at dev.act.kyle@gmail.com.</p>"},{"location":"#license","title":"License","text":"<p>LICENSE</p>"},{"location":"docs/CHANGELOG/","title":"Docs","text":""},{"location":"docs/CHANGELOG/#unreleased","title":"Unreleased","text":""},{"location":"docs/CHANGELOG/#refactor","title":"Refactor","text":"<ul> <li>copier-auto-update</li> </ul>"},{"location":"docs/CHANGELOG/#201-2023-09-08","title":"2.0.1 (2023-09-08)","text":""},{"location":"docs/CHANGELOG/#fix","title":"Fix","text":"<ul> <li>add missing setuptools for some mkdocs dependencies</li> <li>add calcipy-docs and restore missing extras for type checking</li> <li>add scoped \u2018calcipy-test\u2019</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_1","title":"Refactor","text":"<ul> <li>really move nox</li> <li>use ruff.external to allow list flake8 rules</li> </ul>"},{"location":"docs/CHANGELOG/#200-2023-09-02","title":"2.0.0 (2023-09-02)","text":""},{"location":"docs/CHANGELOG/#feat","title":"Feat","text":"<ul> <li>drop Python 3.8</li> </ul>"},{"location":"docs/CHANGELOG/#fix_1","title":"Fix","text":"<ul> <li>specify a unique name when binding new kwargs</li> </ul>"},{"location":"docs/CHANGELOG/#164-2023-08-28","title":"1.6.4 (2023-08-28)","text":""},{"location":"docs/CHANGELOG/#fix_2","title":"Fix","text":"<ul> <li>update pyrate-limiter</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_2","title":"Refactor","text":"<ul> <li>address pydantic v2 migration warnings</li> </ul>"},{"location":"docs/CHANGELOG/#163-2023-08-13","title":"1.6.3 (2023-08-13)","text":""},{"location":"docs/CHANGELOG/#fix_3","title":"Fix","text":"<ul> <li>remove redundant beartype to lru_cache</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_3","title":"Refactor","text":"<ul> <li>resolve asdf</li> <li>tried get_env_vars</li> </ul>"},{"location":"docs/CHANGELOG/#162-2023-08-12","title":"1.6.2 (2023-08-12)","text":""},{"location":"docs/CHANGELOG/#161rc0-2023-08-12","title":"1.6.1rc0 (2023-08-12)","text":""},{"location":"docs/CHANGELOG/#fix_4","title":"Fix","text":"<ul> <li>support partial kwargs for pre/post</li> <li>defer Task to support decorator chaining</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_4","title":"Refactor","text":"<ul> <li>setup for deferred task refactor</li> <li>update dependency versions</li> <li>update copier for a more generic environment variable</li> </ul>"},{"location":"docs/CHANGELOG/#160-2023-07-23","title":"1.6.0 (2023-07-23)","text":""},{"location":"docs/CHANGELOG/#feat_1","title":"Feat","text":"<ul> <li>experiment with griffe for version bumping</li> </ul>"},{"location":"docs/CHANGELOG/#fix_5","title":"Fix","text":"<ul> <li>resolve minor bugs in griffe experiment</li> <li>remove dependency on flake8-beartype</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_5","title":"Refactor","text":"<ul> <li>downgrade replacement machine error to warning</li> </ul>"},{"location":"docs/CHANGELOG/#150-2023-07-22","title":"1.5.0 (2023-07-22)","text":""},{"location":"docs/CHANGELOG/#feat_2","title":"Feat","text":"<ul> <li>add configurable ignore patterns for tags</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_6","title":"Refactor","text":"<ul> <li>resolve pylint warnings</li> <li>run bump-pydantic</li> </ul>"},{"location":"docs/CHANGELOG/#142-2023-07-16","title":"1.4.2 (2023-07-16)","text":""},{"location":"docs/CHANGELOG/#fix_6","title":"Fix","text":"<ul> <li>use the correct exclude rule for semgrep</li> <li>support pydantic v2 serialization</li> <li>skip SemGrep rule to pin GitHub Actions to commit IDs</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_7","title":"Refactor","text":"<ul> <li>resolve local test suite problems</li> </ul>"},{"location":"docs/CHANGELOG/#141-2023-07-07","title":"1.4.1 (2023-07-07)","text":""},{"location":"docs/CHANGELOG/#fix_7","title":"Fix","text":"<ul> <li>retrieve only unique python versions from .tool-versions</li> </ul>"},{"location":"docs/CHANGELOG/#140-2023-06-25","title":"1.4.0 (2023-06-25)","text":""},{"location":"docs/CHANGELOG/#feat_3","title":"Feat","text":"<ul> <li>add calcipy-pack to use install-extras without the extras</li> </ul>"},{"location":"docs/CHANGELOG/#fix_8","title":"Fix","text":"<ul> <li>show a readable warning when gh, pyright, and/or pre-commit are not installed</li> <li>use calcipy\u2019s python environment when installed with pipx</li> </ul>"},{"location":"docs/CHANGELOG/#130-2023-06-21","title":"1.3.0 (2023-06-21)","text":""},{"location":"docs/CHANGELOG/#feat_4","title":"Feat","text":"<ul> <li>switch to httpx for async requests</li> </ul>"},{"location":"docs/CHANGELOG/#perf","title":"Perf","text":"<ul> <li>lazy cache compiling the regex</li> </ul>"},{"location":"docs/CHANGELOG/#126-2023-06-17","title":"1.2.6 (2023-06-17)","text":""},{"location":"docs/CHANGELOG/#fix_9","title":"Fix","text":"<ul> <li>handle missing git remotes in code tag collection</li> <li>always re-cache packages if empty</li> <li>ignore new TD002 &amp; TD003 linting rules</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_8","title":"Refactor","text":"<ul> <li>try to handle exceptions when no git origin URL</li> </ul>"},{"location":"docs/CHANGELOG/#125-2023-05-23","title":"1.2.5 (2023-05-23)","text":""},{"location":"docs/CHANGELOG/#fix_10","title":"Fix","text":"<ul> <li>resolve typing and import errors</li> <li>upgrade to invoke 2.1.2</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_9","title":"Refactor","text":"<ul> <li>suppress ruff autofix</li> </ul>"},{"location":"docs/CHANGELOG/#124-2023-05-16","title":"1.2.4 (2023-05-16)","text":""},{"location":"docs/CHANGELOG/#fix_11","title":"Fix","text":"<ul> <li>add pack.install-extras</li> <li>bump minimum pymdown dependency</li> <li>pydantic alias doesn\u2019t work like that</li> <li>refactor for higher pylint quality</li> <li>update the help string to include \u2013keep-going</li> <li>support branch coverage</li> <li>move pyright to \u2018main\u2019 tasks</li> </ul>"},{"location":"docs/CHANGELOG/#123-2023-04-08","title":"1.2.3 (2023-04-08)","text":""},{"location":"docs/CHANGELOG/#fix_12","title":"Fix","text":"<ul> <li>handle dev installs when only calcipy</li> </ul>"},{"location":"docs/CHANGELOG/#122-2023-04-08","title":"1.2.2 (2023-04-08)","text":""},{"location":"docs/CHANGELOG/#fix_13","title":"Fix","text":"<ul> <li>add preview of \u2013keep-going</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_10","title":"Refactor","text":"<ul> <li>extract task logic from wrapper</li> </ul>"},{"location":"docs/CHANGELOG/#121-2023-04-07","title":"1.2.1 (2023-04-07)","text":""},{"location":"docs/CHANGELOG/#fix_14","title":"Fix","text":"<ul> <li>skip assert_used in bandit</li> </ul>"},{"location":"docs/CHANGELOG/#120-2023-04-06","title":"1.2.0 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#feat_5","title":"Feat","text":"<ul> <li>add test.check with duplicate name logic</li> </ul>"},{"location":"docs/CHANGELOG/#fix_15","title":"Fix","text":"<ul> <li>remove lru_cache, which was causing mypy errors</li> </ul>"},{"location":"docs/CHANGELOG/#111-2023-04-06","title":"1.1.1 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#fix_16","title":"Fix","text":"<ul> <li>resolve linting errors</li> <li>use copier copy</li> </ul>"},{"location":"docs/CHANGELOG/#110-2023-04-06","title":"1.1.0 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#feat_6","title":"Feat","text":"<ul> <li>add experimental check duplicate test names</li> </ul>"},{"location":"docs/CHANGELOG/#fix_17","title":"Fix","text":"<ul> <li>suppress unexpected exit errors in update docs</li> <li>skip pre-commit uninstall for doc.deploy when pre-commit not available</li> <li>skip pre-commit on doc.deploy</li> </ul>"},{"location":"docs/CHANGELOG/#101-2023-03-01","title":"1.0.1 (2023-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_18","title":"Fix","text":"<ul> <li>bump minimum ruff version</li> </ul>"},{"location":"docs/CHANGELOG/#100-2023-02-25","title":"1.0.0 (2023-02-25)","text":""},{"location":"docs/CHANGELOG/#fix_19","title":"Fix","text":"<ul> <li>lower default logging level</li> </ul>"},{"location":"docs/CHANGELOG/#100rc7-2023-02-23","title":"1.0.0rc7 (2023-02-23)","text":""},{"location":"docs/CHANGELOG/#feat_7","title":"Feat","text":"<ul> <li>add lint.security to pre-commit lint-fix hook</li> </ul>"},{"location":"docs/CHANGELOG/#fix_20","title":"Fix","text":"<ul> <li>remove types hook, which doesn\u2019t work when not local</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_11","title":"Refactor","text":"<ul> <li>make task summary optional</li> <li>configure start program inline</li> </ul>"},{"location":"docs/CHANGELOG/#100rc6-2023-02-22","title":"1.0.0rc6 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_21","title":"Fix","text":"<ul> <li>provide subcommands to support pre-commit</li> </ul>"},{"location":"docs/CHANGELOG/#100rc5-2023-02-22","title":"1.0.0rc5 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#feat_8","title":"Feat","text":"<ul> <li>add pre-commit hooks and update docs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_22","title":"Fix","text":"<ul> <li>handle KeyError when not yet on PyPi\u2019s JSON API</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_12","title":"Refactor","text":"<ul> <li>sync with corallium ruff and remove flake8 class-attr-order</li> </ul>"},{"location":"docs/CHANGELOG/#100rc4-2023-02-22","title":"1.0.0rc4 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_23","title":"Fix","text":"<ul> <li>fully support nox and corallium</li> </ul>"},{"location":"docs/CHANGELOG/#100rc3-2023-02-22","title":"1.0.0rc3 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_24","title":"Fix","text":"<ul> <li>add depedency on corallium</li> </ul>"},{"location":"docs/CHANGELOG/#100rc2-2023-02-21","title":"1.0.0rc2 (2023-02-21)","text":""},{"location":"docs/CHANGELOG/#feat_9","title":"Feat","text":"<ul> <li>merge shoal source code into calcipy</li> </ul>"},{"location":"docs/CHANGELOG/#100rc1-2023-02-21","title":"1.0.0rc1 (2023-02-21)","text":""},{"location":"docs/CHANGELOG/#fix_25","title":"Fix","text":"<ul> <li>upgrade shoal dependency and add summary</li> <li>add pylint to document</li> <li>move autopep8 to the lint extras</li> </ul>"},{"location":"docs/CHANGELOG/#100rc0-2023-02-20","title":"1.0.0rc0 (2023-02-20)","text":""},{"location":"docs/CHANGELOG/#feat_10","title":"Feat","text":"<ul> <li>fully support working-dir by wrapping ctx.run</li> <li>recursively find the tool versions file</li> <li>add dont_skip for testing</li> <li>add tests for code tag collector</li> <li>replace dg with user configuration file</li> <li>better support min-cover</li> <li>unit test write_autoformatted_md_sections</li> <li>start using check_imports</li> <li>support prereleases and add autopep8</li> <li>introduce cl namespace</li> <li>run lint on file_args and use absolufy</li> <li>add initial version of doc namespace</li> <li>remove pre-commit; add doc and ddict extras</li> <li>add progress indicator to tasks</li> <li>add lint.security</li> <li>add ./run to generlize local entrypoint</li> <li>add lint.pre-commit</li> <li>restore most of noxfile</li> <li>run mypy-silent and add main task</li> <li>use can_skip for the package_lock file</li> <li>start manually fixing lint issues</li> <li>add linting</li> <li>migrate over stale package logic</li> <li>add pyright, mypy, and DEFAULTS</li> <li>add write_json and cached pyproject reader</li> <li>add pytest-based tasks and first unit tests</li> <li>experiment with parallel processing</li> <li>init placeholders for new namespaces</li> <li>add can_skip</li> <li>add initial nox task to invoke</li> <li>switch to invoke</li> <li>start restoring files and switching to shoal</li> <li>add shoal</li> </ul>"},{"location":"docs/CHANGELOG/#fix_26","title":"Fix","text":"<ul> <li>correct ignore pattern logic and expand task tests</li> <li>get doc and cl tasks working</li> <li>code tag summary and rename default tasks</li> <li>properly map CLI arguments to code tag collector</li> <li>show all URLs on the same line in CTC</li> <li>write Code Tags to docs/docs</li> <li>resolve issues with test.watch-json</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_13","title":"Refactor","text":"<ul> <li>update Progress task</li> <li>extract use_pty to a default in shoal</li> <li>generlize find_in_parents for pyproject.toml as well</li> <li>introduce logger.print and print_debug</li> <li>drop absolufy-imports task</li> <li>simplify configuration</li> <li>fix remaining pyright and flake8 errors</li> <li>rename write-json to coverage</li> <li>resolve pylint issues</li> <li>reorder main tasks</li> <li>resolve flake8 warnings and better manage filenames</li> <li>apply autopep8 to fix whitespace issues</li> <li>import initialized logger directly</li> <li>try to wrap running tasks programmatically\u2026</li> <li>run prc main</li> <li>move log configuration to shoal.cli.task</li> <li>resolve typecheck errors</li> <li>manually resolve additional linting errors</li> <li>make lint.check default</li> <li>extract start program to shoal</li> <li>another round of manual lint corrections</li> <li>move can_skip to shoal</li> <li> <p>nest invoke-specific code in tasks/</p> </li> <li> <p>drop pytest-html and conftest completely</p> </li> </ul>"},{"location":"docs/CHANGELOG/#0216-2023-01-31","title":"0.21.6 (2023-01-31)","text":""},{"location":"docs/CHANGELOG/#feat_11","title":"Feat","text":"<ul> <li>use the \u2013now flag for ptw!</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_14","title":"Refactor","text":"<ul> <li>remove autoflake in favor of unimport</li> </ul>"},{"location":"docs/CHANGELOG/#0215-2022-11-27","title":"0.21.5 (2022-11-27)","text":""},{"location":"docs/CHANGELOG/#fix_27","title":"Fix","text":"<ul> <li>escape % in yaml files as well</li> </ul>"},{"location":"docs/CHANGELOG/#0214-2022-11-20","title":"0.21.4 (2022-11-20)","text":""},{"location":"docs/CHANGELOG/#fix_28","title":"Fix","text":"<ul> <li>handle % in path names for ctt</li> <li>suppress code tag failures when not a git directory</li> <li>add support for tomllib in Python 3.11!</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_15","title":"Refactor","text":"<ul> <li>copier update</li> </ul>"},{"location":"docs/CHANGELOG/#0213-2022-11-13","title":"0.21.3 (2022-11-13)","text":""},{"location":"docs/CHANGELOG/#fix_29","title":"Fix","text":"<ul> <li>remove unimplemented diff-cover</li> <li>exit 1 on semgrep errors</li> </ul>"},{"location":"docs/CHANGELOG/#0212-2022-11-12","title":"0.21.2 (2022-11-12)","text":""},{"location":"docs/CHANGELOG/#fix_30","title":"Fix","text":"<ul> <li>add relative path prefix for linting \u2018./\u2019</li> <li>ensure that cz bump doesn\u2019t break the requirements file</li> <li>bump minimum pip-check</li> </ul>"},{"location":"docs/CHANGELOG/#0211-2022-11-05","title":"0.21.1 (2022-11-05)","text":""},{"location":"docs/CHANGELOG/#fix_31","title":"Fix","text":"<ul> <li>install poetry for \u2018doit publish\u2019</li> <li>bump minimum mkdocs for deploy_docs</li> </ul>"},{"location":"docs/CHANGELOG/#0210-2022-11-05","title":"0.21.0 (2022-11-05)","text":""},{"location":"docs/CHANGELOG/#feat_12","title":"Feat","text":"<ul> <li>remove if-expr and other unnecessary new flake8 plugins</li> <li>merge extra flake8 packages based on flake8-aggressive</li> </ul>"},{"location":"docs/CHANGELOG/#fix_32","title":"Fix","text":"<ul> <li>prevent line break in table for Code Tag summary</li> <li>add pdbr with rich to replace pdbpp</li> </ul>"},{"location":"docs/CHANGELOG/#0201-2022-10-19","title":"0.20.1 (2022-10-19)","text":""},{"location":"docs/CHANGELOG/#fix_33","title":"Fix","text":"<ul> <li>drop pdbpp and add flake8-fine-pytest</li> </ul>"},{"location":"docs/CHANGELOG/#0200-2022-10-16","title":"0.20.0 (2022-10-16)","text":""},{"location":"docs/CHANGELOG/#feat_13","title":"Feat","text":"<ul> <li>sign commitizen tags</li> <li>add plantuml generation to mkdocs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_34","title":"Fix","text":"<ul> <li>remove version conflict with flake8-simplify and cl_bump</li> </ul>"},{"location":"docs/CHANGELOG/#0191-2022-10-13","title":"0.19.1 (2022-10-13)","text":""},{"location":"docs/CHANGELOG/#fix_35","title":"Fix","text":"<ul> <li>don\u2019t auto-install types</li> </ul>"},{"location":"docs/CHANGELOG/#0190-2022-10-06","title":"0.19.0 (2022-10-06)","text":""},{"location":"docs/CHANGELOG/#feat_14","title":"Feat","text":"<ul> <li>support optional logging of arguments</li> </ul>"},{"location":"docs/CHANGELOG/#fix_36","title":"Fix","text":"<ul> <li>split mypy install from mypy run</li> </ul>"},{"location":"docs/CHANGELOG/#0180-2022-09-27","title":"0.18.0 (2022-09-27)","text":""},{"location":"docs/CHANGELOG/#feat_15","title":"Feat","text":"<ul> <li>support Arrow in pydantic and mypy (ArrowType was causing errors)</li> <li>remove pdoc(s) from document task</li> <li>add gen_ref_nav!</li> <li>tried pybetter, but too focused on adding all</li> <li>#102: sort-of-replace pdocs, but pdoc only shows one function</li> <li>add mypy install argument</li> <li>expand flake8 and reduce tests</li> </ul>"},{"location":"docs/CHANGELOG/#fix_37","title":"Fix","text":"<ul> <li>re-run prdc</li> <li>lower fail-under for diff. Raise for regular test</li> <li>standardize on a single doit task list</li> <li>Pathlib.absolute is not documented. Use .resolve</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_16","title":"Refactor","text":"<ul> <li>add type hints and minor changes for mypy</li> <li>make python files non-executable (chmod -x)</li> </ul>"},{"location":"docs/CHANGELOG/#0171-2022-09-22","title":"0.17.1 (2022-09-22)","text":""},{"location":"docs/CHANGELOG/#fix_38","title":"Fix","text":"<ul> <li>pytest cache assert circular reference</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_17","title":"Refactor","text":"<ul> <li>move check_security from nox into doit</li> </ul>"},{"location":"docs/CHANGELOG/#0170-2022-09-17","title":"0.17.0 (2022-09-17)","text":""},{"location":"docs/CHANGELOG/#feat_16","title":"Feat","text":"<ul> <li>add docformat</li> <li>make pyupgrade flag configurable based on minimum python version</li> <li>replace pendulum with arrow</li> <li>update to latest copier</li> </ul>"},{"location":"docs/CHANGELOG/#fix_39","title":"Fix","text":"<ul> <li>move yamllint configuration to project-specific config</li> <li>naive datetimes can\u2019t be subtracted on Windows</li> <li>hack together a dictionary instead of punq</li> <li>drop safety because of false positives on Calcipy CalVer</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_18","title":"Refactor","text":"<ul> <li>experiment with custom semgrep rules</li> <li>formalize solution from last commit</li> <li>try to fix punq by switching to functions</li> <li>fix one test, refactor a little, but punq is still not working</li> <li>begin replacing attrs with pydantic</li> <li>update semgrep nox task</li> <li>upgrade copier with linting fixes</li> </ul>"},{"location":"docs/CHANGELOG/#0160-2022-08-04","title":"0.16.0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_17","title":"Feat","text":"<ul> <li>add flake8-simplify</li> </ul>"},{"location":"docs/CHANGELOG/#fix_40","title":"Fix","text":"<ul> <li>show only date in coverage table</li> </ul>"},{"location":"docs/CHANGELOG/#0150-2022-08-03","title":"0.15.0 (2022-08-03)","text":""},{"location":"docs/CHANGELOG/#fix_41","title":"Fix","text":"<ul> <li>resolve pyroma errors by installing poetry as a module</li> </ul>"},{"location":"docs/CHANGELOG/#0150rc0-2022-07-24","title":"0.15.0rc0 (2022-07-24)","text":""},{"location":"docs/CHANGELOG/#feat_18","title":"Feat","text":"<ul> <li>init update workflow and toml sorter</li> <li>create script to bump toml minimum requirements</li> </ul>"},{"location":"docs/CHANGELOG/#fix_42","title":"Fix","text":"<ul> <li>properly handle missing datetime</li> <li>try to use separate sqlite files for pre-commit and doit</li> <li>correct safety arguments</li> <li>use the unversioned API for releases</li> <li>try to handle pypi response when no \u201creleases\u201d</li> <li>handle prefix of \u201c*\u201d</li> <li>improve error message when \u201creleases\u201d not present</li> <li> <p>use sqlite3 for pre-commit concurrent doit access</p> </li> <li> <p>bump Python to 3.8.4 and drop 3.7</p> </li> </ul>"},{"location":"docs/CHANGELOG/#0145-2022-03-05","title":"0.14.5 (2022-03-05)","text":""},{"location":"docs/CHANGELOG/#fix_43","title":"Fix","text":"<ul> <li>#91: prevent minified files from appearing in Code Tag Summary</li> </ul>"},{"location":"docs/CHANGELOG/#0144-2022-03-01","title":"0.14.4 (2022-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_44","title":"Fix","text":"<ul> <li>set upper limit to fix flake8-bandit compat</li> </ul>"},{"location":"docs/CHANGELOG/#0143-2022-03-01","title":"0.14.3 (2022-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_45","title":"Fix","text":"<ul> <li>suppress only known git blame errors</li> <li>use Github tables to prevent multi-line rows in Code Tag Summary</li> </ul>"},{"location":"docs/CHANGELOG/#0142-2022-02-27","title":"0.14.2 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#fix_46","title":"Fix","text":"<ul> <li>don\u2019t allow multi-line tables</li> </ul>"},{"location":"docs/CHANGELOG/#0141-2022-02-27","title":"0.14.1 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#fix_47","title":"Fix","text":"<ul> <li>lower pandas constraint for better 3.7 support</li> <li>drop generation of requirements.txt</li> </ul>"},{"location":"docs/CHANGELOG/#0140-2022-02-27","title":"0.14.0 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#feat_19","title":"Feat","text":"<ul> <li>use next-gen attrs syntax</li> <li>improve code tag regex</li> </ul>"},{"location":"docs/CHANGELOG/#fix_48","title":"Fix","text":"<ul> <li>correct type annotations</li> <li>undo silent nox step</li> <li>make coverage.json optional for task_doc</li> </ul>"},{"location":"docs/CHANGELOG/#0130-2022-02-23","title":"0.13.0 (2022-02-23)","text":""},{"location":"docs/CHANGELOG/#feat_20","title":"Feat","text":"<ul> <li>drop AppVeyor and update with copier</li> <li>#67: initialize GH CI Action</li> </ul>"},{"location":"docs/CHANGELOG/#fix_49","title":"Fix","text":"<ul> <li>drop appveyor from cz version files</li> <li>attempt to resolve UnicodeError on Windows action</li> <li>address more minor CI errors</li> <li>make yamllint more relaxed</li> <li>attempt to resolve CI issues</li> <li>remove diff-quality check until fixed for CI</li> <li>always use Interactive when using /dev/null</li> <li>run push hook stage and format subproject</li> <li>support Python 3.7.12</li> <li>don\u2019t suppress nox missing interpreter errors</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_19","title":"Refactor","text":"<ul> <li>pre-commit can be run in one command</li> <li>resolve LGTM error</li> </ul>"},{"location":"docs/CHANGELOG/#0122-2022-02-21","title":"0.12.2 (2022-02-21)","text":""},{"location":"docs/CHANGELOG/#fix_50","title":"Fix","text":"<ul> <li>skip cassette files</li> </ul>"},{"location":"docs/CHANGELOG/#0121-2022-02-18","title":"0.12.1 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#fix_51","title":"Fix","text":"<ul> <li>always return 0 to complete format task</li> <li>use short paths when formatting Python code if available</li> </ul>"},{"location":"docs/CHANGELOG/#0120-2022-02-18","title":"0.12.0 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#feat_21","title":"Feat","text":"<ul> <li>initialize calcipy pre-commit hook</li> </ul>"},{"location":"docs/CHANGELOG/#0110-2022-02-18","title":"0.11.0 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#feat_22","title":"Feat","text":"<ul> <li>don\u2019t verify on cz_bump</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_20","title":"Refactor","text":"<ul> <li>format fixes</li> <li>reduce noise on matched vulnerabilities</li> <li>make run_cmd public</li> <li>remove jsonlint action</li> <li>use beartype typing</li> <li>move pre-commit hooks into doit</li> </ul>"},{"location":"docs/CHANGELOG/#0100-2022-01-19","title":"0.10.0 (2022-01-19)","text":""},{"location":"docs/CHANGELOG/#feat_23","title":"Feat","text":"<ul> <li>create Github release if gh CLI is installed</li> </ul>"},{"location":"docs/CHANGELOG/#091-2022-01-17","title":"0.9.1 (2022-01-17)","text":""},{"location":"docs/CHANGELOG/#fix_52","title":"Fix","text":"<ul> <li>correct code-tag-collector for CLI use</li> <li>use target file\u2019s directory for git info</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_21","title":"Refactor","text":"<ul> <li>drop template echo command</li> </ul>"},{"location":"docs/CHANGELOG/#090-2022-01-17","title":"0.9.0 (2022-01-17)","text":""},{"location":"docs/CHANGELOG/#feat_24","title":"Feat","text":"<ul> <li>show code tag summary as a table</li> <li>add date of last blame to code tag summary</li> <li>only link code tag from line number</li> <li>use revision-specific commit hashes</li> <li>add git links to code tag summary</li> <li>add python format pre-commit hook</li> <li>add support for TOML formatting with taplo</li> </ul>"},{"location":"docs/CHANGELOG/#fix_53","title":"Fix","text":"<ul> <li>handle \u201c0000..\u201d hash by using branch name</li> <li>handle non-git directories</li> <li>use correct line number for pinned hash</li> <li>handle git dependencies when checking stale packages</li> <li>use positional arguments for pre-commit commands</li> <li>correct syntax error in pre-commit command</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_22","title":"Refactor","text":"<ul> <li>make slow python pre-commit push-only</li> <li>apply auto-format tools to test project</li> </ul>"},{"location":"docs/CHANGELOG/#082-2022-01-16","title":"0.8.2 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#fix_54","title":"Fix","text":"<ul> <li>drop all references to CalVer</li> </ul>"},{"location":"docs/CHANGELOG/#081-2022-01-16","title":"0.8.1 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#refactor_23","title":"Refactor","text":"<ul> <li>drop tag_format and use semver-only</li> </ul>"},{"location":"docs/CHANGELOG/#080-2022-01-16","title":"0.8.0 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#feat_25","title":"Feat","text":"<ul> <li>add pip-check for prettier outdated</li> <li>add cct command</li> <li>initialize the cement CLI application</li> <li>replace toml with tomli (#74)</li> <li>move wily to nox to reduce version conflicts</li> <li>add pip-audit</li> <li>add attrs_strict</li> <li>trim trailing whitespace from doc output</li> </ul>"},{"location":"docs/CHANGELOG/#fix_55","title":"Fix","text":"<ul> <li>bump year to 2022</li> <li>code_tag_collector must return doit-compliant value (None)</li> <li>only run pre-commit once</li> <li>Code Tag Collector cannot return a Path for DoIt tasks</li> <li>cct was not being created as an alias. Use full command</li> <li>wily</li> <li>properly exclude auto-generated doc files from code tag collector</li> <li>run ptw on whole directory, not just test files</li> <li>drop FYI and NOTE from Code Tags</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_24","title":"Refactor","text":"<ul> <li>fix PY-W2000 by using all</li> <li>move file_search to top-level</li> <li>just run pre-commit install</li> <li>replace pass with \u2026 to keep it from being removed</li> </ul>"},{"location":"docs/CHANGELOG/#060rc2-2022-08-04","title":"0.6.0rc2 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_26","title":"Feat","text":"<ul> <li>drop pytest-cov and run coverage directly</li> </ul>"},{"location":"docs/CHANGELOG/#fix_56","title":"Fix","text":"<ul> <li>swap pytest-watch(er) and other version bumps</li> <li>pin min-version (xenon) &amp; drop preconvert and flake8-mock</li> </ul>"},{"location":"docs/CHANGELOG/#060rc1-2022-08-04","title":"0.6.0rc1 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#fix_57","title":"Fix","text":"<ul> <li>bug in noxfile and code tags reading doc output files</li> </ul>"},{"location":"docs/CHANGELOG/#060rc0-2022-08-04","title":"0.6.0rc0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_27","title":"Feat","text":"<ul> <li>implement pylint rules</li> <li>add xenon (wraps radon)</li> <li>condense doit output in show_cmd</li> <li>initial semgrep implementation</li> <li>add code diagrams to doc-site</li> <li>add notes on wily and pylint</li> <li>add vulture</li> <li>diff-quality (lint)</li> <li>add it</li> <li>add output if no stale packages found</li> <li>add autoflake</li> </ul>"},{"location":"docs/CHANGELOG/#fix_58","title":"Fix","text":"<ul> <li>try to fix issues found with pytest_cache_assert</li> <li>drop unused Python2 demjson</li> <li>error in noxfile with poetry install</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_25","title":"Refactor","text":"<ul> <li>decouple code tag collector from DG</li> <li>improve lint_py and the return type check is working</li> <li>zip release task</li> <li>cleanup a few minor errors</li> <li>use Interactive instead of Chrome</li> <li>apply fixes found from semgrep</li> <li>rename \u201cwrappers\u201d to \u201cdot_dict\u201d</li> <li>prevent mutation in DG.set_paths</li> </ul>"},{"location":"docs/CHANGELOG/#031rc0-2022-08-04","title":"0.3.1rc0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_28","title":"Feat","text":"<ul> <li>add task to zip artifacts from testing</li> <li>implement pandas.to_markdown for cov table</li> <li>#58: implement doc task and merge serve_docs</li> <li>make loading YAML files more generic</li> <li>create doit summary report</li> <li>add task to check license compliance</li> <li>move lock into doit tasks with file-dependency</li> <li>#38: re-implement coverage and write source</li> <li>drop subprocess-tee</li> <li>#36: WIP implementation of doc formatting</li> <li>implement publish tasks</li> <li>add pip outdated to stale check</li> <li>implement check for stale packages</li> <li>begin implementing stale package check</li> <li>smart default tasks for CI vs. local</li> <li>make nox imports optional</li> <li>try doit rather than CWD for initial path</li> <li>move noxfile into calcipy</li> <li>integrate nox to doit tasks</li> <li>WIP check for stale dep &amp; placeholder publish</li> <li>add additional configuration options</li> <li>add nox tasks</li> <li>add detect-secrets as pre-commit</li> <li>lint non-Python files</li> <li>read doc_dir from copier file</li> <li>make most settings configurable</li> <li>added dotted-dict wrapper of Box</li> <li>delete old files rather than full directory</li> <li>filter with glob-like ignore_patterns (2/2)</li> <li>add security check task</li> <li>add skip_phrase for code tag skipping</li> <li>beartype - roar!</li> <li>optionally clear log directory. Move file_helpers from base</li> <li>new tail-like reverse read_lines</li> <li>rename DIG to DG because doit is one word</li> <li>retrieve doc_dir from copier</li> <li>add log-setup fun for doit</li> <li>make (source) doc_dir configurable</li> <li>add sanitizer</li> <li>add pytype</li> <li>#36: start WIP ReadMeMachine</li> <li>#36: merge logic of markdown auto-formatters</li> <li>make code tag partially configurable</li> <li>move check_types into calcipy</li> <li>import templates from pdocs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_59","title":"Fix","text":"<ul> <li>install full dev-dep as temporary nox workaround</li> <li>prevent committing changelog at base dir</li> <li>remove type_name from docstring for Google-style</li> <li>run pytest as a module for nox</li> <li>resolve doc_dir and style errors</li> <li>#58: remove None from pdocs output</li> <li>deconflict doit/nox</li> <li>repair failing test</li> <li>packaging needed keyword argument</li> <li>import and nox syntax errors</li> <li>run push pre-commit hooks with doit</li> <li>show log warning instead of error for stale dep</li> <li>improve output from check_stale</li> <li>errors caught in testing</li> <li>suppress beartype warnings for now</li> <li>drop logger middleware</li> <li>catch most calcipy section typos in toml</li> <li>remove check-secrets but keep snippets</li> <li>errors in ignore patterns</li> <li>import doit and expand nox test file</li> <li>skip tags must be at bottom</li> <li>reset Lint paths instead of extend</li> <li>use find_files for code tag summary</li> <li>don\u2019t manually add the package source dir</li> <li>lint typing and improve tests</li> <li>create separate file_search file to fix imports</li> <li>#51: replace glob with git-based file identification</li> <li>#53: Use Interact instead of LongRunning</li> <li>undo PEP585 for runtime beartype</li> <li>resolve file explosion from _find_files</li> <li>import the loguru Logger class safely</li> <li>additional problems found with mypy</li> <li>fix Doit Types and start beartype</li> <li>add no-verify to cl_bump</li> <li>correct isort configuration</li> <li>restore ReadMeMachine</li> <li>repair small bugs found in tests</li> <li>make transitions optional</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_26","title":"Refactor","text":"<ul> <li>see if only one space is okay for skipcq</li> <li>fix anti-pattern with nox session decorator and arg</li> <li>improve code quality</li> <li>try to suppress deepsource errors</li> <li>address DeepSource issues</li> <li>split up set_paths from DG</li> <li>fix formatting error from pre-push</li> <li>rename doc_dir to doc_sub_dir for clarity</li> <li>apply 0.0.10 template</li> <li>move markdown to subdirectory for mkdocs</li> <li>move isort back to toml</li> <li>fix edge case in diff-cov failing and lint errors</li> <li>relicense with MIT for better compliance</li> <li>create generic doit-runner for noxfile</li> <li>fix some type issues</li> <li>minor fixes from AppVeyor testing</li> <li>#38: reduce complexity</li> <li>minor cleanup to docs</li> <li>apply pre-commit autoformat</li> <li>auto-drop skipcq comment</li> <li>format with VSCode</li> <li>fix lint errors in YAML files</li> <li>move find file paths to DG.meta</li> <li>move if_found_unlink to file_helpers</li> <li>fix formatting with pre-commit</li> <li>fix attribute names for path types (1/2)</li> <li>use calcipy:skip-tags</li> <li>fix minor code tags</li> <li>move __temp_chdir and improve fix_dg</li> <li>narrow type ignore use</li> <li>use path_file of file_path</li> <li>apply auto-fixes from pre-commit</li> <li>replace all glob-search with find_files</li> <li>remove find_files from code_tag script</li> <li>update isort for trailing-comma</li> <li>move excluded lint rules to DG</li> <li>apply PEP585 and add pre-commit hook</li> <li>fix capitalization for doit (one word, all lowercase)</li> <li>improve activate_debug_logging</li> <li>try to replace Any with BaseAction</li> <li>apply 0.0.2 minor fixes</li> <li>apply 0.0.1 version of calcipy_template</li> <li>minor renaming for _MarkdownMachine</li> <li>fix lock file and line length</li> <li>run more pre-commit checks on commit</li> <li>standardize on code tags and cleanup</li> </ul>"},{"location":"docs/CHANGELOG/#perf_1","title":"Perf","text":"<ul> <li>combine autopep8 paths into single command</li> <li>combine files for linting in one command</li> </ul>"},{"location":"docs/CHANGELOG/#020a0-2022-08-04","title":"0.2.0a0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_29","title":"Feat","text":"<ul> <li>push tags with no pre-commit hooks on pre</li> <li>use Interactive instead of \u2014yes for cl_bump*</li> <li>remove tag create/remove tasks</li> <li>new task cl_bump_pre</li> <li>replace MIT license with Unlicense</li> <li>use cz_legacy to generate changelogs</li> <li>remove task in anticipation of copier #26</li> <li>improve git pre-commit hooks</li> <li>new add-trailing-comma and pyupgrade hooks</li> <li>new mkdocs tasks and improvements</li> <li>new optional preconvert to serialize logs</li> <li>move logger configuration to log_helpers</li> <li>new cl_bump task. Closes #21</li> </ul>"},{"location":"docs/CHANGELOG/#fix_60","title":"Fix","text":"<ul> <li>do not pass filenames to pre-commit</li> <li>#43: add year to version for pseudo-calver</li> <li>prevent legacy types for new commits</li> <li>prevent circular import in doit_tasks</li> <li>extras need to be defined as optional</li> <li>rollback hook changes as they are not working</li> <li>install hooks for push</li> <li>LongRunning passed tasks that should fail</li> <li>yesqa removed necessary noqa (H303, etc)</li> <li>incorrect output paths</li> <li>reduce false tags found (WIP). Fix #24</li> <li>regression in lint_project tasks</li> <li>unincremented version in toml</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_27","title":"Refactor","text":"<ul> <li>#22: restore MIT license</li> <li>copy+paste unmodified labels workflow</li> <li>update local TODO notes</li> <li>make toml an optional import</li> <li>rename path_source to path_project</li> <li>rename DIG_CWD as PATH_TEST_PROJECT</li> <li>rename test file</li> <li>doit is lowercase (CC looks like Dolt)</li> <li>replace sh with subprocess-tee</li> <li>reduce excess logging</li> <li>move DOIT_CONFIG to import</li> <li>move dig test to dig test file</li> </ul>"},{"location":"docs/CHANGELOG/#010-2020-12-19","title":"0.1.0 (2020-12-19)","text":""},{"location":"docs/CHANGELOG/#feat_30","title":"Feat","text":"<ul> <li>new write_cl task utilizing comittizen</li> <li>new task, pre_commit_hooks</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_28","title":"Refactor","text":"<ul> <li>show STDOUT formatting in DoIt task</li> <li>remove archived code</li> </ul>"},{"location":"docs/CHANGELOG/#003-2020-12-10","title":"0.0.3 (2020-12-10)","text":""},{"location":"docs/CHANGELOG/#002-2020-11-14","title":"0.0.2 (2020-11-14)","text":""},{"location":"docs/CHANGELOG/#001-2020-11-14","title":"0.0.1 (2020-11-14)","text":""},{"location":"docs/CODE_TAG_SUMMARY/","title":"Collected Code Tags","text":"Type Comment Last Edit Source File TODO If no stale, write out five oldest? 2023-05-13 calcipy/check_for_stale_packages/_check_for_stale_packages.py:209 TODO Consider adding a configuration item for ignore_patterns 2023-02-19 calcipy/file_search.py:82 TODO Look into running tasks from within other tasks to support \u2018\u2013continue\u2019 and more readable logs \u2013&gt; 2023-02-19 docs/docs/MIGRATION.md:112 TODO Capture logging output and check\u2026 2023-02-19 tests/check_for_stale_packages/test_check_for_stale_packages.py:64 TODO Capture logging output and check\u2026 2023-02-19 tests/check_for_stale_packages/test_check_for_stale_packages.py:88 TODO Is there an easier way to maintain pytest parameter IDs? 2023-02-17 tests/tasks/test_test.py:14 PLANNED Convert to hypothesis test! 2023-02-19 tests/test_dot_dict.py:9 <p>Found code tags for TODO (6), PLANNED (1)</p>"},{"location":"docs/DEVELOPER_GUIDE/","title":"Developer Notes","text":""},{"location":"docs/DEVELOPER_GUIDE/#local-development","title":"Local Development","text":"<pre><code>git clone https://github.com/kyleking/calcipy.git\ncd calcipy\npoetry install --sync\npoetry run calcipy-pack pack.install-extras\n\n# See the available tasks\npoetry run calcipy\n# Or use a local 'run' file (so that 'calcipy' can be extended)\n./run\n\n# Run the default task list (lint, auto-format, test coverage, etc.)\n./run main\n\n# Make code changes and run specific tasks as needed:\n./run lint.fix test\n</code></pre>"},{"location":"docs/DEVELOPER_GUIDE/#publishing","title":"Publishing","text":"<p>For testing, create an account on TestPyPi. Replace <code>...</code> with the API token generated on TestPyPi or PyPi respectively</p> <pre><code>poetry config repositories.testpypi https://test.pypi.org/legacy/\npoetry config pypi-token.testpypi ...\n\n./run main pack.publish --to-test-pypi\n# If you didn't configure a token, you will need to provide your username and password to publish\n</code></pre> <p>To publish to the real PyPi</p> <pre><code>poetry config pypi-token.pypi ...\n./run release\n\n# Or for a pre-release\n./run release --suffix=rc\n</code></pre>"},{"location":"docs/DEVELOPER_GUIDE/#current-status","title":"Current Status","text":"File Statements Missing Excluded Coverage <code>calcipy/__init__.py</code> 17 0 17 100.0% <code>calcipy/can_skip.py</code> 17 1 0 89.3% <code>calcipy/check_for_stale_packages/__init__.py</code> 4 2 0 50.0% <code>calcipy/check_for_stale_packages/_check_for_stale_packages.py</code> 117 8 3 87.2% <code>calcipy/cli.py</code> 37 1 36 93.3% <code>calcipy/code_tag_collector/__init__.py</code> 4 2 0 50.0% <code>calcipy/code_tag_collector/_collector.py</code> 142 2 0 94.0% <code>calcipy/dot_dict/__init__.py</code> 4 2 0 50.0% <code>calcipy/dot_dict/_dot_dict.py</code> 8 0 0 100.0% <code>calcipy/experiments/__init__.py</code> 0 0 0 100.0% <code>calcipy/experiments/bump_programmatically.py</code> 24 16 0 33.3% <code>calcipy/experiments/check_duplicate_test_names.py</code> 36 0 2 95.0% <code>calcipy/file_search.py</code> 38 0 2 91.8% <code>calcipy/invoke_helpers.py</code> 30 2 0 81.8% <code>calcipy/md_writer/__init__.py</code> 4 2 0 50.0% <code>calcipy/md_writer/_writer.py</code> 95 6 0 88.9% <code>calcipy/noxfile/__init__.py</code> 4 2 0 50.0% <code>calcipy/noxfile/_noxfile.py</code> 48 2 32 83.8% <code>calcipy/scripts.py</code> 5 0 35 100.0% <code>calcipy/tasks/__init__.py</code> 0 0 0 100.0% <code>calcipy/tasks/_invoke.py</code> 37 0 45 97.7% <code>calcipy/tasks/all_tasks.py</code> 48 0 0 95.5% <code>calcipy/tasks/cl.py</code> 28 5 0 75.0% <code>calcipy/tasks/defaults.py</code> 20 0 0 89.3% <code>calcipy/tasks/doc.py</code> 45 0 8 90.5% <code>calcipy/tasks/executable_utils.py</code> 28 0 0 87.5% <code>calcipy/tasks/lint.py</code> 58 1 0 84.1% <code>calcipy/tasks/nox.py</code> 8 0 0 100.0% <code>calcipy/tasks/pack.py</code> 42 10 0 65.6% <code>calcipy/tasks/stale.py</code> 9 1 0 90.9% <code>calcipy/tasks/tags.py</code> 15 0 0 100.0% <code>calcipy/tasks/test.py</code> 45 1 2 89.2% <code>calcipy/tasks/types.py</code> 17 0 0 91.3% Totals 1034 66 182 87.3% <p>Generated on: 2023-11-08</p>"},{"location":"docs/MIGRATION/","title":"Migration Guide","text":""},{"location":"docs/MIGRATION/#calcipy-100","title":"<code>calcipy 1.0.0</code>","text":""},{"location":"docs/MIGRATION/#background","title":"Background","text":"<p>calcipy <code>v1</code> was a complete rewrite to switch from <code>doit</code> to <code>invoke</code>:</p> <ul> <li>with <code>invoke</code>, tasks can be run from anywhere without a <code>dodo.py</code> file</li> <li>tasks can be loaded lazily, which means that some performance gains are possible</li> <li>since there is no shared state file, tasks can be more easily run from pre-commit or generally in parallel</li> </ul> <p><code>doit</code> excelled at clearly delineated task output and run summary, but <code>invoke</code> isn\u2019t designed that way. I would like to improve the CLI output, but the benefits are worth this tradeoff.</p> <p>calcipy <code>v0</code> was built on doit and thus required a <code>dodo.py</code> file. I began adding <code>cement</code> to support a separate CLI for <code>calcipy</code> installed with <code>pipx</code>, but that required a lot of boilerplate code. With <code>doit</code>, the string command needed to be complete at task evaluation rather than runtime, so globbing files couldn\u2019t be resolved lazily.</p>"},{"location":"docs/MIGRATION/#migration","title":"Migration","text":"<p>While refactoring, the global configuration was mostly removed (<code>DoitGlobals</code>) along with a few tasks, but the main functionality is still present. Any project dependent on <code>calcipy</code> will need substantial changes. The easiest way to start migrating is to run <code>copier copy gh:KyleKing/calcipy_template .</code> for calcipy_template</p>"},{"location":"docs/MIGRATION/#speed-test","title":"Speed Test","text":"<p>It turns out that switching to <code>invoke</code> appears to have only saved 100ms</p> <pre><code>&gt; hyperfine -m 20 --warmup 5 \"poetry run python -c 'print(1)'\"\nBenchmark 1: poetry run python -c 'print(1)'\nTime (mean \u00b1 \u03c3):     377.9 ms \u00b1   3.1 ms    [User: 235.0 ms, System: 61.8 ms]\nRange (min \u2026 max):   372.7 ms \u2026 384.0 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 ./run\nBenchmark 1: ./run\nTime (mean \u00b1 \u03c3):     936.0 ms \u00b1  26.9 ms    [User: 1548.2 ms, System: 1687.7 ms]\nRange (min \u2026 max):   896.4 ms \u2026 1009.4 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 \"poetry run calcipy_tags\"\nBenchmark 1: poetry run calcipy_tags\nTime (mean \u00b1 \u03c3):     618.5 ms \u00b1  29.7 ms    [User: 1536.8 ms, System: 1066.2 ms]\nRange (min \u2026 max):   578.2 ms \u2026 694.9 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 \"poetry run doit list\"\nBenchmark 1: poetry run doit list\nTime (mean \u00b1 \u03c3):      1.002 s \u00b1  0.015 s    [User: 1.643 s, System: 1.682 s]\nRange (min \u2026 max):    0.974 s \u2026  1.023 s    20 runs\n</code></pre> <p>Additionally, the major decrease in dependencies will make install and update actions much faster. With the recommended extras installed, <code>calcipy-v1</code> has 124 dependencies (with all extras, 164) vs. <code>calcipy-v0</code>\u2019s 259. Counted with: <code>cat .calcipy_packaging.lock | jq 'keys' | wc -l</code></p>"},{"location":"docs/MIGRATION/#code-comparison","title":"Code Comparison","text":"<p>Accounting for code extracted to <code>corallium</code>, the overall number of lines decreased from 1772 to 1550 or only 12%, while increasing the CLI and <code>pre-commit</code> capabilities.</p> <pre><code>~/calcipy-v0 &gt; cloc calcipy\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                          26            942           1075           1772\n-------------------------------------------------------------------------------\nSUM:                            26            942           1075           1772\n-------------------------------------------------------------------------------\n~/calcipy &gt; cloc calcipy\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                          27            454            438           1185\n-------------------------------------------------------------------------------\nSUM:                            27            454            438           1185\n-------------------------------------------------------------------------------\n~/corallium &gt; cloc corallium\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                           7            176            149            365\n-------------------------------------------------------------------------------\nSUM:                             7            176            149            365\n-------------------------------------------------------------------------------\n\n~/calcipy &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nYAML                             2              0              0            580\nPython                          19            176             68            578\nJSON                             2              0              0             60\nMarkdown                         3              9             10              8\nText                             1              0              0              2\n-------------------------------------------------------------------------------\nSUM:                            27            185             78           1228\n-------------------------------------------------------------------------------\n~/calcipy-v0 &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nJSON                            30              0              0            762\nYAML                             2              0              0            580\nPython                          24            314            186            578\nMarkdown                         3              9             10              8\n-------------------------------------------------------------------------------\nSUM:                            59            323            196           1928\n-------------------------------------------------------------------------------\n~/corallium &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                           6             36             15             69\nMarkdown                         1              1              0              2\n-------------------------------------------------------------------------------\nSUM:                             7             37             15             71\n-------------------------------------------------------------------------------\n</code></pre>"},{"location":"docs/MIGRATION/#doit-output","title":"doit output","text":"<p>I would like to restore the <code>doit</code> task summary, but <code>invoke</code>\u2019s architecture doesn\u2019t really make this possible. The <code>--continue</code> option was extremely useful, but that also might not be achievable.</p> <pre><code>&gt; poetry run doit run\n.  format_recipes &gt; [\n        Python: function format_recipes\n]\n\n2023-02-19 10:40:23.954 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/breakfast\n2023-02-19 10:40:23.957 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/rice\n2023-02-19 10:40:23.959 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/meals\n2023-02-19 10:40:23.964 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/seafood\n2023-02-19 10:40:23.967 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/pizza\n2023-02-19 10:40:23.969 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/poultry\n2023-02-19 10:40:23.972 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/sushi\n.  collect_code_tags &gt; [\n        Python: function write_code_tag_file\n]\n\n.  cl_write &gt; [\n        Cmd: poetry run cz changelog\n        Python: function _move_cl\n]\n\n.  lock &gt; [\n        Cmd: poetry lock --no-update\n]\n\nResolving dependencies...\n.  nox_coverage &gt; [\n        Cmd: poetry run nox --error-on-missing-interpreters --session coverage\n]\n\n...\n\ndoit&gt; Summary:\ndoit&gt; format_recipes was successful\ndoit&gt; collect_code_tags was successful\ndoit&gt; cl_write was successful\ndoit&gt; lock was successful\ndoit&gt; nox_coverage was successful\ndoit&gt; auto_format was successful\ndoit&gt; document was successful\ndoit&gt; check_for_stale_packages was successful\ndoit&gt; pre_commit_hooks failed (red)\ndoit&gt; lint_project was not run\ndoit&gt; static_checks was not run\ndoit&gt; security_checks was not run\ndoit&gt; check_types was not run\n</code></pre>"},{"location":"docs/STYLE_GUIDE/","title":"Personal Style Guides","text":""},{"location":"docs/STYLE_GUIDE/#git","title":"Git","text":"<p>We use Commitizen to manage both an auto-generated Changelog and incrementing the release version following semver. For both of these automated outputs to work well, please follow the Conventional Commits style, which is described in more detail below.</p>"},{"location":"docs/STYLE_GUIDE/#commitizen-types-and-scopes","title":"Commitizen Types and Scopes","text":"<p><code>type(scope): description</code></p> <ul> <li>Types</li> <li>fix: A bug fix</li> <li>feat: A new feature</li> <li>docs: Documentation-only changes (code comments, separate docs)</li> <li>style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)</li> <li>perf: A code change that improves performance</li> <li>refactor: A change to production code that is not a fix, feat, or perf</li> <li>test: Adding missing or correcting existing tests</li> <li>build: Changes that affect the build system or external dependencies</li> <li>ci: Changes to our CI configuration files and scripts</li> <li>A <code>!</code> can be used to indicate a breaking change (<code>refactor!: drop support for Node 6</code>)</li> <li>SemVer Rules<ul> <li>Based on commit type, the version will be auto-incremented: <code>fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR</code></li> </ul> </li> <li>Scopes</li> <li>A Class, File name, Issue Number, other appropriate noun. As examples: <code>build(poetry): bump requests to v3</code> or <code>style(#32): add missing type annotations</code></li> <li>Tips</li> <li>What if a commit fits multiple types?<ul> <li>Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes</li> </ul> </li> <li>Use <code>git rebase -i</code> to fix commit names prior to merging if incorrect types/scopes are used</li> </ul>"},{"location":"docs/STYLE_GUIDE/#git-description-guidelines","title":"Git Description Guidelines","text":"<ul> <li>Commit message guidelines</li> <li>Full sentence with verb (lowercase) and concise description. Below are modified examples for Conventional Commits<ul> <li><code>fix(roles): bug in admin role permissions</code></li> <li><code>feat(ui): implement new button design</code></li> <li><code>build(pip): upgrade package to remove vulnerabilities</code></li> <li><code>refactor: file structure to improve code readability</code></li> <li><code>perf(cli): rewrite methods</code></li> <li><code>feat(api): endpoints to implement new customer dashboard</code></li> </ul> </li> <li>How to write a good commit message</li> <li>A diff will tell you what changed, but only the commit message can properly tell you why.</li> <li>Keep in mind: This has all been said before.</li> <li>From the seven rules of a great Git commit message:<ul> <li> <ol> <li>Try for 50 characters, but consider 72 the hard limit</li> </ol> </li> <li> <ol> <li>Use the body to explain what and why vs. how</li> </ol> </li> </ul> </li> </ul>"},{"location":"docs/STYLE_GUIDE/#issue-labels-and-milestones","title":"Issue Labels and Milestones","text":"<p>Personal Guide</p> <ul> <li>For Issue Labels, see labels.yml</li> <li>Milestones</li> <li>Current Tasks: main milestone (name could change based on a specific project, sprint, or month)</li> <li>Next Tasks</li> <li>Blue Sky</li> </ul> Research <ul> <li>[Sane GitHub Labels](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63) and see [sensible-github-labels](https://github.com/Relequestual/sensible-github-labels) for full descriptions of each</li> <ul> <li>\u201cit is much more helpful to see the status and type of all issues at a glance.\u201d</li> <li>One of each:</li> <ul> <li>Status: \u2026</li> <ul><li>Abandoned, Accepted, Available, Blocked, Completed, In Progress, On Hold, Pending, Review Needed, Revision Needed</li></ul> <li>Type: \u2026</li> <ul><li>Bug, Maintenance, Question, Enhancement</li></ul> <li>Priority: \u2026</li> <ul><li>Critical, High, Medium, Low</li></ul> </ul> </ul> <li>[Britecharts](https://britecharts.github.io/britecharts/github-labels.html)</li> <ul> <li>Status: \u2026</li> <ul> <li>On Review \u2013 Request that we are pondering if including or not</li> <li>Needs Reproducing \u2013 For bugs that need to be reproduced in order to get fixed</li> <li>Needs Design \u2013 Feature that needs a design</li> <li>Ready to Go \u2013 Issue that has been defined and is ready to get started with</li> <li>In Progress \u2013 Issue that is being worked on right now.</li> <li>Completed \u2013 Finished feature or fix</li> </ul> <li>Type: \u2026</li> <ul> <li>Bug \u2013 An unexpected problem or unintended behavior</li> <li>Feature \u2013 A new feature request</li> <li>Maintenance \u2013 A regular maintenance chore or task, including refactors, build system, CI, performance improvements</li> <li>Documentation \u2013 A documentation improvement task</li> <li>Question \u2013 An issue or PR that needs more information or a user question</li> </ul> <li>Not Included</li> <ul> <li>Priority: They would add complexity and overhead due to the discussions, but could help with the roadmap</li> <li>Technology Labels: It can create too much overhead, as properly tag with technologies all the issues could be time consuming</li> </ul> </ul> </ul> <li>[Ian Bicking Blog](https://www.ianbicking.org/blog/2014/03/use-github-issues-to-organize-a-project.html)</li> <ul> <li>Milestone Overview</li> <ul> <li>What are we doing right now?</li> <li>What aren\u2019t we doing right now?</li> <ul> <li>2a. Stuff we\u2019ll probably do soon</li> <li>2b. Stuff we probably won\u2019t do soon</li> </ul> <li>What aren\u2019t we sure about?</li> </ul> <li>Milestone Descriptions</li> <ul> <li>Stuff we are doing right now: this is the \u201cmain\u201d milestone. We give it a name (like Alpha 2 or Strawberry Rhubarb Pie) and we write down what we are trying to accomplish with the milestone. We create a new milestone when we are ready for the next iteration.</li> <li>Stuff we\u2019ll probably do soon: this is a standing \u201c**Next Tasks**\u201d milestone. We never change or rename this milestone.</li> <ul><li>We use a permanent \u201cNext Tasks\u201d milestone (as opposed to renaming it to \u201cAlpha 3\u201d or actual-next-iteration milestone) because we don\u2019t want to presume or default to including something in the real next iteration. When we\u2019re ready to start planning the next iteration we\u2019ll create a new milestone, and only deliberately move things into that milestone.</li></ul> <li>Stuff we probably won\u2019t do soon: this is a standing \u201c**Blue Sky**\u201d milestone. We refer to these tickets and sometimes look through them, but they are easy to ignore, somewhat intentionally ignored.</li> <li>What aren\u2019t we sure about?: issues with no milestone.</li> </ul> <li>Label: \u201cNeeds Discussion\u201d - (addressed in a triage meeting) - use liberally for either big or small tickets</li> <li>\u201cIt\u2019s better to give people more power: it\u2019s actually helpful if people can overreach because it is an opportunity to establish where the limits really are and what purpose those limits have\u201d</li> </ul>"},{"location":"docs/STYLE_GUIDE/#external-links","title":"External Links","text":"<ul> <li>Git: The Simple Guide</li> <li>Commit Messages and why use the present tense</li> <li>GitHub\u2019s Advice on GitHub</li> <li>Most Comprehensive Guide</li> <li>Git Pro Book (free)</li> <li>Bash Tab-Completion Snippet</li> </ul>"},{"location":"docs/STYLE_GUIDE/#python","title":"Python","text":"<ul> <li>Python Style Guides</li> <li>https://gist.github.com/sloria/7001839</li> <li>http://www.nilunder.com/blog/2013/08/03/pythonic-sensibilities/</li> <li>https://innoq.github.io/cards42org_en/</li> <li>https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide</li> <li>https://www.python.org/doc/humor/</li> <li>https://docs.python-guide.org/writing/reading/</li> <li>https://realpython.com/python-refactoring/</li> </ul>"},{"location":"docs/STYLE_GUIDE/#adrs","title":"ADRs","text":"<ul> <li>ADR Approaches<ul> <li>https://infraeng.dev/tech-spec Template (And associated review) vs. https://infraeng.dev/decision-log/</li> <li>Y-Statements: abbreviated shorthand. Add this as a one-line decision option if a full ADR isn\u2019t needed (or when referencing an existing ADR) (https://scribe.rip/@docsoc/y-statements-10eb07b5a177)</li> <li>https://adr.github.io</li> <li>More formal implementation of ADRs (MADR) that this is based on. Template: https://github.com/adr/madr/blob/97fb8edec60b8dc70b8166ef62de34c4e26b46c0/template/adr-template.md</li> <li>https://github.com/ethereum/EIPs/blob/confluenceuser/EIPS/eip-5639.md</li> </ul> </li> <li>Examples<ul> <li>https://github.com/pawamoy/mkdocstrings/issues/28</li> <li>https://github.com/arachne-framework/architecture/blob/060a956277a5ad71df93da49fee52463408841af/adr-002-configuration.md</li> <li>https://github.com/arachne-framework/architecture/tree/060a956277a5ad71df93da49fee52463408841af</li> <li>https://github.com/ethereum/EIPs/blob/confluenceuser/EIPS/eip-1010.md</li> <li>https://docs-v1.prefect.io/core/pins/pin-01-introduce-pins.html</li> <li>https://peps.python.org/pep-0387/</li> <li>https://github.com/AICoE/aicoe-ci/blob/39de02af86a0d1f9dcd395fa88b858f1c6880411/docs/adr/0000-use-markdown-architectural-decision-records.md</li> <li>And many others!</li> </ul> </li> </ul> <p>&lt;\u2013 Links \u2013&gt;</p>"},{"location":"modules/calcipy/_code_diagrams/","title":"Code Diagrams","text":"<p>Auto-generated with <code>pylint-pyreverse</code></p>"},{"location":"modules/calcipy/_code_diagrams/#packages","title":"Packages","text":"<p>Full Size</p>"},{"location":"modules/calcipy/_code_diagrams/#classes","title":"Classes","text":"<p>Full Size</p>"},{"location":"reference/SUMMARY/","title":"SUMMARY","text":"<ul> <li>calcipy<ul> <li>can_skip</li> <li>check_for_stale_packages<ul> <li>_check_for_stale_packages</li> </ul> </li> <li>cli</li> <li>code_tag_collector<ul> <li>_collector</li> </ul> </li> <li>dot_dict<ul> <li>_dot_dict</li> </ul> </li> <li>experiments<ul> <li>bump_programmatically</li> <li>check_duplicate_test_names</li> </ul> </li> <li>file_search</li> <li>invoke_helpers</li> <li>md_writer<ul> <li>_writer</li> </ul> </li> <li>noxfile<ul> <li>_noxfile</li> </ul> </li> <li>scripts</li> <li>tasks<ul> <li>_invoke</li> <li>all_tasks</li> <li>cl</li> <li>defaults</li> <li>doc</li> <li>executable_utils</li> <li>lint</li> <li>nox</li> <li>pack</li> <li>stale</li> <li>tags</li> <li>test</li> <li>types</li> </ul> </li> </ul> </li> </ul>"},{"location":"reference/calcipy/","title":"calcipy","text":"<p>calcipy.</p>"},{"location":"reference/calcipy/#calcipy-functions","title":"Functions","text":""},{"location":"reference/calcipy/#calcipy.configure_runtime_type_checking_mode","title":"configure_runtime_type_checking_mode","text":"<pre><code>configure_runtime_type_checking_mode()\n</code></pre> <p>Optionally configure runtime type checking mode globally.</p> Source code in <code>calcipy/__init__.py</code> <pre><code>def configure_runtime_type_checking_mode() -&gt; None:  # pragma: no cover\n    \"\"\"Optionally configure runtime type checking mode globally.\"\"\"\n    rtc_mode = _RuntimeTypeCheckingModes.from_environment()\n\n    if rtc_mode is not _RuntimeTypeCheckingModes.OFF:\n        from beartype.roar import BeartypeClawDecorWarning  # noqa: PLC0415\n\n        beartype_this_package(conf=BeartypeConf(\n            warning_cls_on_decorator_exception=(\n                None if rtc_mode is _RuntimeTypeCheckingModes.ERROR else BeartypeClawDecorWarning\n            ),\n        ))\n</code></pre>"},{"location":"reference/calcipy/can_skip/","title":"can_skip","text":"<p>Support can-skip logic from Make.</p>"},{"location":"reference/calcipy/can_skip/#calcipy.can_skip-functions","title":"Functions","text":""},{"location":"reference/calcipy/can_skip/#calcipy.can_skip.can_skip","title":"can_skip","text":"<pre><code>can_skip(*, prerequisites, targets)\n</code></pre> <p>Generic make-style task skipping logic based on file <code>mtime</code>.</p> <p>Example use with Invoke, but can be used anywhere:</p> <pre><code>@task\ndef test(ctx: Context) -&gt; None:\n    if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):\n        return  # Exit early\n\n    ...  # Task code\n</code></pre> Source code in <code>calcipy/can_skip.py</code> <pre><code>@beartype\ndef can_skip(*, prerequisites: List[Path], targets: List[Path]) -&gt; bool:\n    \"\"\"Generic make-style task skipping logic based on file `mtime`.\n\n    Example use with Invoke, but can be used anywhere:\n\n    ```py\n    @task\n    def test(ctx: Context) -&gt; None:\n        if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):\n            return  # Exit early\n\n        ...  # Task code\n    ```\n\n    \"\"\"\n    if not (ts_prerequisites := [pth.stat().st_mtime for pth in prerequisites]):\n        raise ValueError('Required files do not exist', prerequisites)\n\n    ts_targets = [pth.stat().st_mtime for pth in targets]\n    if ts_targets and min(ts_targets) &gt; max(ts_prerequisites):\n        logger.warning('Skipping because targets are newer', targets=targets)\n        return True\n    return False\n</code></pre>"},{"location":"reference/calcipy/can_skip/#calcipy.can_skip.dont_skip","title":"dont_skip","text":"<pre><code>dont_skip(*, prerequisites, targets)\n</code></pre> <p>To use for testing with mock; always returns False.</p> Source code in <code>calcipy/can_skip.py</code> <pre><code>@beartype\ndef dont_skip(*, prerequisites: List[Path], targets: List[Path]) -&gt; bool:\n    \"\"\"To use for testing with mock; always returns False.\"\"\"\n    logger.debug('Mocking can_skip', prerequisites=prerequisites, targets=targets)\n    return False\n</code></pre>"},{"location":"reference/calcipy/cli/","title":"cli","text":"<p>Extend Invoke for Calcipy.</p>"},{"location":"reference/calcipy/cli/#calcipy.cli-classes","title":"Classes","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig","title":"CalcipyConfig","text":"<p>             Bases: <code>Config</code></p> <p>Opinionated Config with better defaults.</p> Source code in <code>calcipy/cli.py</code> <pre><code>class CalcipyConfig(Config):\n    \"\"\"Opinionated Config with better defaults.\"\"\"\n\n    @staticmethod\n    def global_defaults() -&gt; Dict:  # type: ignore[type-arg]  # pragma: no cover\n        \"\"\"Override the global defaults.\"\"\"\n        invoke_defaults = Config.global_defaults()\n        calcipy_defaults = {\n            'run': {\n                'echo': True,\n                'echo_format': '\\033[2;3;37mRunning: {command}\\033[0m',\n                'pty': use_pty(),\n            },\n        }\n        return merge_dicts(invoke_defaults, calcipy_defaults)\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig-functions","title":"Functions","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig.global_defaults","title":"global_defaults  <code>staticmethod</code>","text":"<pre><code>global_defaults()\n</code></pre> <p>Override the global defaults.</p> Source code in <code>calcipy/cli.py</code> <pre><code>@staticmethod\ndef global_defaults() -&gt; Dict:  # type: ignore[type-arg]  # pragma: no cover\n    \"\"\"Override the global defaults.\"\"\"\n    invoke_defaults = Config.global_defaults()\n    calcipy_defaults = {\n        'run': {\n            'echo': True,\n            'echo_format': '\\033[2;3;37mRunning: {command}\\033[0m',\n            'pty': use_pty(),\n        },\n    }\n    return merge_dicts(invoke_defaults, calcipy_defaults)\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli-functions","title":"Functions","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.start_program","title":"start_program","text":"<pre><code>start_program(pkg_name, pkg_version, module=None, collection=None)\n</code></pre> <p>Run the customized Invoke Program.</p> <p>FYI: recommendation is to extend the <code>core_args</code> method, but this won\u2019t parse positional arguments: https://docs.pyinvoke.org/en/stable/concepts/library.html#modifying-core-parser-arguments</p> Source code in <code>calcipy/cli.py</code> <pre><code>@beartype\ndef start_program(  # noqa: CAC001\n    pkg_name: str,\n    pkg_version: str,\n    module: Optional[ModuleType] = None,\n    collection: Optional[Union[Collection, InvokeCollection]] = None,\n) -&gt; None:  # pragma: no cover\n    \"\"\"Run the customized Invoke Program.\n\n    FYI: recommendation is to extend the `core_args` method, but this won't parse positional arguments:\n    https://docs.pyinvoke.org/en/stable/concepts/library.html#modifying-core-parser-arguments\n\n    \"\"\"\n    # Manipulate 'sys.argv' to hide arguments that invoke can't parse\n    _gto = GlobalTaskOptions()\n    sys_argv: List[str] = sys.argv[:1]\n    last_argv = ''\n    for argv in sys.argv[1:]:\n        if not last_argv.startswith('-') and Path(argv).is_file():\n            _gto.file_args.append(Path(argv))\n        # Check for CLI flags\n        elif argv in {'-v', '-vv', '-vvv', '--verbose'}:\n            _gto.verbose = argv.count('v')\n        elif argv == '--keep-going':\n            _gto.keep_going = True\n        # Check for CLI arguments with values\n        elif last_argv == '--working-dir':\n            _gto.working_dir = Path(argv).resolve()\n        elif argv != '--working-dir':\n            sys_argv.append(argv)\n        last_argv = argv\n    _gto.file_args = [\n        _f if _f.is_absolute() else Path.cwd() / _f\n        for _f in _gto.file_args\n    ]\n    sys.argv = sys_argv\n\n    class _CalcipyConfig(CalcipyConfig):\n\n        gto: GlobalTaskOptions = _gto\n\n    if module and collection:\n        raise ValueError('Only one of collection or module can be specified')\n\n    _CalcipyProgram(\n        name=pkg_name,\n        version=pkg_version,\n        namespace=Collection.from_module(module) if module else collection,\n        config_class=_CalcipyConfig,\n    ).run()\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli.task","title":"task","text":"<pre><code>task(*dec_args, **dec_kwargs)\n</code></pre> <p>Marks wrapped callable object as a valid Invoke task.</p> Source code in <code>calcipy/cli.py</code> <pre><code>def task(*dec_args: Any, **dec_kwargs: Any) -&gt; Callable:  # type: ignore[type-arg]\n    \"\"\"Marks wrapped callable object as a valid Invoke task.\"\"\"\n    def wrapper(func: Any) -&gt; Callable:  # type: ignore[type-arg]\n        # Attach arguments for Task\n        setattr(func, TASK_ARGS_ATTR, dec_args)\n        setattr(func, TASK_KWARGS_ATTR, dec_kwargs)\n        # Attach public attributes from invoke that are expected\n        func.help = dec_kwargs.pop('help', {})\n\n        def _with_kwargs(**extra_kwargs: Any) -&gt; Callable:  # type: ignore[type-arg] # nosem\n            \"\"\"Support building partial tasks.\"\"\"\n            if extra_kwargs:\n                # Set a unique name when 'extra_kwargs' was provided\n                # https://github.com/pyinvoke/invoke/blob/07b836f2663bb073a7bcef3d6c454e1dc6b867ae/invoke/tasks.py#L81-L104\n                encoded = b64encode(str(extra_kwargs).encode())\n                func.__name__ = f'{func.__name__}_{encoded.decode().rstrip(\"=\")}'\n\n            @wraps(func)  # nosem\n            def _with_kwargs_inner(*args: Any, **kwargs: Any) -&gt; Any:\n                return func(*args, **kwargs, **extra_kwargs)\n            return _with_kwargs_inner\n\n        func.with_kwargs = _with_kwargs\n\n        @wraps(func)  # nosem\n        def _inner(*args: Any, **kwargs: Any) -&gt; Any:\n            return func(*args, **kwargs)\n\n        return _inner\n\n    # Handle the case when the decorator is called without arguments\n    if (\n        len(dec_args) == 1\n        and callable(dec_args[0])\n        and not hasattr(dec_args[0], TASK_ARGS_ATTR)\n    ):\n        return wrapper(dec_args[0])\n\n    return wrapper\n</code></pre>"},{"location":"reference/calcipy/file_search/","title":"file_search","text":"<p>Find Files.</p>"},{"location":"reference/calcipy/file_search/#calcipy.file_search-functions","title":"Functions","text":""},{"location":"reference/calcipy/file_search/#calcipy.file_search.find_project_files","title":"find_project_files","text":"<pre><code>find_project_files(path_project, ignore_patterns)\n</code></pre> <p>Find project files in git version control.</p> <p>Note: uses the relative project directory and verifies that each file exists</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory</p> <p> TYPE: <code>Path</code> </p> <code>ignore_patterns</code> <p>glob ignore patterns</p> <p> TYPE: <code>List[str]</code> </p> RETURNS DESCRIPTION <code>List[Path]</code> <p>Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths</p> Source code in <code>calcipy/file_search.py</code> <pre><code>@beartype\ndef find_project_files(path_project: Path, ignore_patterns: List[str]) -&gt; List[Path]:\n    \"\"\"Find project files in git version control.\n\n    &gt; Note: uses the relative project directory and verifies that each file exists\n\n    Args:\n        path_project: Path to the project directory\n        ignore_patterns: glob ignore patterns\n\n    Returns:\n        Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths\n\n    \"\"\"\n    file_paths = []\n    rel_filepaths = _get_all_files(cwd=path_project)\n    filtered_rel_files = _filter_files(rel_filepaths=rel_filepaths, ignore_patterns=ignore_patterns)\n    for rel_file in filtered_rel_files:\n        path_file = path_project / rel_file\n        if path_file.is_file():\n            file_paths.append(path_file)\n        else:  # pragma: no cover\n            logger.warning('Could not find the specified file', path_file=path_file)\n    return file_paths\n</code></pre>"},{"location":"reference/calcipy/file_search/#calcipy.file_search.find_project_files_by_suffix","title":"find_project_files_by_suffix","text":"<pre><code>find_project_files_by_suffix(path_project, *, ignore_patterns=None)\n</code></pre> <p>Find project files in git version control.</p> <p>Note: uses the relative project directory and verifies that each file exists</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory</p> <p> TYPE: <code>Path</code> </p> <code>ignore_patterns</code> <p>glob ignore patterns</p> <p> TYPE: <code>Optional[List[str]]</code> DEFAULT: <code>None</code> </p> RETURNS DESCRIPTION <code>Dict[str, List[Path]]</code> <p>Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths</p> Source code in <code>calcipy/file_search.py</code> <pre><code>@beartype\ndef find_project_files_by_suffix(\n    path_project: Path, *, ignore_patterns: Optional[List[str]] = None,\n) -&gt; Dict[str, List[Path]]:\n    \"\"\"Find project files in git version control.\n\n    &gt; Note: uses the relative project directory and verifies that each file exists\n\n    Args:\n        path_project: Path to the project directory\n        ignore_patterns: glob ignore patterns\n\n    Returns:\n        Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths\n\n    \"\"\"\n    file_lookup: Dict[str, List[Path]] = defaultdict(list)\n    for path_file in find_project_files(path_project, ignore_patterns or []):\n        file_lookup[path_file.suffix.lstrip('.')].append(path_file)\n    return dict(file_lookup)\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/","title":"invoke_helpers","text":"<p>Invoke Helpers.</p>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers-functions","title":"Functions","text":""},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.get_doc_subdir","title":"get_doc_subdir","text":"<pre><code>get_doc_subdir(path_project=None)\n</code></pre> <p>Retrieve the documentation directory from the copier answer file.</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory with contains <code>.copier-answers.yml</code></p> <p> TYPE: <code>Optional[Path]</code> DEFAULT: <code>None</code> </p> RETURNS DESCRIPTION <code>Path</code> <p>to the source documentation directory</p> <p> TYPE: <code>Path</code> </p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@beartype\ndef get_doc_subdir(path_project: Optional[Path] = None) -&gt; Path:\n    \"\"\"Retrieve the documentation directory from the copier answer file.\n\n    Args:\n        path_project: Path to the project directory with contains `.copier-answers.yml`\n\n    Returns:\n        Path: to the source documentation directory\n\n    \"\"\"\n    path_copier = (path_project or get_project_path()) / COPIER_ANSWERS\n    doc_dir = read_yaml_file(path_copier).get('doc_dir', 'docs')\n    return path_copier.parent / doc_dir / 'docs'  # type: ignore[no-any-return]\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.get_project_path","title":"get_project_path  <code>cached</code>","text":"<pre><code>get_project_path()\n</code></pre> <p>Retrieve the <code>cwd</code>.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@lru_cache(maxsize=1)\ndef get_project_path() -&gt; Path:\n    \"\"\"Retrieve the `cwd`.\"\"\"\n    return Path.cwd()\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.run","title":"run","text":"<pre><code>run(ctx, *run_args, **run_kwargs)\n</code></pre> <p>Wrap invoke.run to run within the <code>working_dir</code>.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@beartype\ndef run(ctx: Context, *run_args: Any, **run_kwargs: Any) -&gt; Optional[Result]:\n    \"\"\"Wrap invoke.run to run within the `working_dir`.\"\"\"\n    working_dir = '.'\n    with suppress(AttributeError):\n        working_dir = ctx.config.gto.working_dir\n\n    with ctx.cd(working_dir):\n        return ctx.run(*run_args, **run_kwargs)\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.use_pty","title":"use_pty  <code>cached</code>","text":"<pre><code>use_pty()\n</code></pre> <p>Returns False on Windows and some CI environments.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@lru_cache(maxsize=1)\ndef use_pty() -&gt; bool:\n    \"\"\"Returns False on Windows and some CI environments.\"\"\"\n    if platform.system() == 'Windows':\n        return False\n    return not environ.get('GITHUB_ACTION')\n</code></pre>"},{"location":"reference/calcipy/scripts/","title":"scripts","text":"<p>Start the command line program.</p>"},{"location":"reference/calcipy/scripts/#calcipy.scripts-classes","title":"Classes","text":""},{"location":"reference/calcipy/scripts/#calcipy.scripts-functions","title":"Functions","text":""},{"location":"reference/calcipy/scripts/#calcipy.scripts.start","title":"start","text":"<pre><code>start()\n</code></pre> <p>Run the customized Invoke Program.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start() -&gt; None:  # pragma: no cover\n    \"\"\"Run the customized Invoke Program.\"\"\"\n    from .tasks import all_tasks  # noqa: PLC0415\n    start_program(__pkg_name__, __version__, all_tasks)\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_docs","title":"start_docs","text":"<pre><code>start_docs()\n</code></pre> <p>Run CLI with only the cl and doc namespaces.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_docs() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the cl and doc namespaces.\"\"\"\n    from .tasks import cl, doc  # noqa: PLC0415\n    _start_subset([cl, doc])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_lint","title":"start_lint","text":"<pre><code>start_lint()\n</code></pre> <p>Run CLI with only the lint namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_lint() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the lint namespace.\"\"\"\n    from .tasks import lint  # noqa: PLC0415\n    _start_subset([lint])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_pack","title":"start_pack","text":"<pre><code>start_pack()\n</code></pre> <p>Run CLI with only the pack namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_pack() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the pack namespace.\"\"\"\n    from .tasks import pack  # noqa: PLC0415\n    _start_subset([pack])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_tags","title":"start_tags","text":"<pre><code>start_tags()\n</code></pre> <p>Run CLI with only the tags namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_tags() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the tags namespace.\"\"\"\n    from .tasks import tags  # noqa: PLC0415\n    _start_subset([tags])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_test","title":"start_test","text":"<pre><code>start_test()\n</code></pre> <p>Run CLI with only the test namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_test() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the test namespace.\"\"\"\n    from .tasks import test  # noqa: PLC0415\n    _start_subset([test])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_types","title":"start_types","text":"<pre><code>start_types()\n</code></pre> <p>Run CLI with only the types namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_types() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the types namespace.\"\"\"\n    from .tasks import types  # noqa: PLC0415\n    _start_subset([types])\n</code></pre>"},{"location":"reference/calcipy/check_for_stale_packages/","title":"check_for_stale_packages","text":""},{"location":"reference/calcipy/check_for_stale_packages/#calcipy.check_for_stale_packages-functions","title":"Functions","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/","title":"_check_for_stale_packages","text":"<p>Check for stale packages.</p>"},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages.CALCIPY_CACHE","title":"CALCIPY_CACHE  <code>module-attribute</code>","text":"<pre><code>CALCIPY_CACHE = Path('.calcipy_packaging.lock')\n</code></pre> <p>Path to the packaging lock file.</p>"},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages-functions","title":"Functions","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages.check_for_stale_packages","title":"check_for_stale_packages","text":"<pre><code>check_for_stale_packages(*, stale_months, path_lock=LOCK, path_cache=CALCIPY_CACHE)\n</code></pre> <p>Read the cached packaging information.</p> PARAMETER  DESCRIPTION <code>stale_months</code> <p>cutoff in months for when a package might be stale enough to be a risk</p> <p> TYPE: <code>int</code> </p> Source code in <code>calcipy/check_for_stale_packages/_check_for_stale_packages.py</code> <pre><code>@beartype\ndef check_for_stale_packages(*, stale_months: int, path_lock: Path = LOCK, path_cache: Path = CALCIPY_CACHE) -&gt; bool:\n    \"\"\"Read the cached packaging information.\n\n    Args:\n        stale_months: cutoff in months for when a package might be stale enough to be a risk\n\n    \"\"\"\n    packages = _read_packages(path_lock)\n    cached_packages = _read_cache(path_cache)\n    if cached_packages and can_skip.can_skip(prerequisites=[path_lock], targets=[path_cache]):\n        packages = [*cached_packages.values()]\n    else:\n        packages = _collect_release_dates(packages, cached_packages)\n        _write_cache(packages, path_cache)\n    return _packages_are_stale(packages, stale_months=stale_months)\n</code></pre>"},{"location":"reference/calcipy/code_tag_collector/","title":"code_tag_collector","text":""},{"location":"reference/calcipy/code_tag_collector/#calcipy.code_tag_collector-functions","title":"Functions","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/","title":"_collector","text":"<p>Collect code tags and output for review in a single location.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.CODE_TAG_RE","title":"CODE_TAG_RE  <code>module-attribute</code>","text":"<pre><code>CODE_TAG_RE = '((^|\\\\s|\\\\(|\"|\\\\\\')(?P&lt;tag&gt;{tag})(:| -)([^\\\\r\\\\n]))(?P&lt;text&gt;.+)'\n</code></pre> <p>Default code tag regex with <code>tag</code> and <code>text</code> matching groups.</p> <p>Requires formatting with list of tags: <code>CODE_TAG_RE.format(tag='|'.join(tag_list))</code></p> <p>Commonly, the <code>tag_list</code> could be <code>COMMON_CODE_TAGS</code></p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.COMMON_CODE_TAGS","title":"COMMON_CODE_TAGS  <code>module-attribute</code>","text":"<pre><code>COMMON_CODE_TAGS = ['FIXME', 'TODO', 'PLANNED', 'HACK', 'REVIEW', 'TBD', 'DEBUG']\n</code></pre> <p>Most common code tags.</p> <p>FYI and NOTE are excluded to not be tracked in the Code Summary.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.SKIP_PHRASE","title":"SKIP_PHRASE  <code>module-attribute</code>","text":"<pre><code>SKIP_PHRASE = 'calcipy_skip_tags'\n</code></pre> <p>String that indicates the file should be excluded from the tag search.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector-functions","title":"Functions","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.github_blame_url","title":"github_blame_url","text":"<pre><code>github_blame_url(clone_uri)\n</code></pre> <p>Format the blame URL.</p> PARAMETER  DESCRIPTION <code>clone_uri</code> <p>git remote URI</p> <p> TYPE: <code>str</code> </p> RETURNS DESCRIPTION <code>str</code> <p><code>repo_url</code></p> <p> TYPE: <code>str</code> </p> Source code in <code>calcipy/code_tag_collector/_collector.py</code> <pre><code>@beartype\ndef github_blame_url(clone_uri: str) -&gt; str:\n    \"\"\"Format the blame URL.\n\n    Args:\n        clone_uri: git remote URI\n\n    Returns:\n       str: `repo_url`\n\n    \"\"\"\n    # Could be ssh or http (with or without .git)\n    # &gt; git@github.com:KyleKing/calcipy.git\n    # &gt; https://github.com/KyleKing/calcipy.git\n    if matches := re.compile(_GITHUB_ORIGIN).match(clone_uri):\n        github_url = 'https://github.com/'\n        return f\"{github_url}{matches['owner']}/{matches['repository']}\"\n    return ''\n</code></pre>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.write_code_tag_file","title":"write_code_tag_file","text":"<pre><code>write_code_tag_file(\n    path_tag_summary, paths_source, base_dir, regex=\"\", tags=\"\", header=\"# Task Summary\\n\\nAuto-Generated by `calcipy`\"\n)\n</code></pre> <p>Create the code tag summary file.</p> PARAMETER  DESCRIPTION <code>path_tag_summary</code> <p>Path to the output file</p> <p> TYPE: <code>Path</code> </p> <code>paths_source</code> <p>list of source files to parse</p> <p> TYPE: <code>List[Path]</code> </p> <code>base_dir</code> <p>base directory relative to the searched files</p> <p> TYPE: <code>Path</code> </p> <code>regex</code> <p>compiled regular expression. Expected to have matching groups <code>(tag, text)</code>. Default is CODE_TAG_RE with tags from tag_order</p> <p> TYPE: <code>str</code> DEFAULT: <code>''</code> </p> <code>tags</code> <p>subset of all tags to include in the report and specified order. Default is COMMON_CODE_TAGS</p> <p> TYPE: <code>str</code> DEFAULT: <code>''</code> </p> <code>header</code> <p>header text</p> <p> TYPE: <code>str</code> DEFAULT: <code>'# Task Summary\\n\\nAuto-Generated by `calcipy`'</code> </p> Source code in <code>calcipy/code_tag_collector/_collector.py</code> <pre><code>@beartype\ndef write_code_tag_file(\n    path_tag_summary: Path,\n    paths_source: List[Path],\n    base_dir: Path,\n    regex: str = '',\n    tags: str = '',\n    header: str = '# Task Summary\\n\\nAuto-Generated by `calcipy`',\n) -&gt; None:\n    \"\"\"Create the code tag summary file.\n\n    Args:\n        path_tag_summary: Path to the output file\n        paths_source: list of source files to parse\n        base_dir: base directory relative to the searched files\n        regex: compiled regular expression. Expected to have matching groups `(tag, text)`.\n            Default is CODE_TAG_RE with tags from tag_order\n        tags: subset of all tags to include in the report and specified order. Default is COMMON_CODE_TAGS\n        header: header text\n\n    \"\"\"\n    tag_order = [_t.strip() for _t in tags.split(',') if _t] or COMMON_CODE_TAGS\n    matcher = (regex or CODE_TAG_RE).format(tag='|'.join(tag_order))\n\n    matches = _search_files(paths_source, re.compile(matcher))\n    if report := _format_report(\n        base_dir, matches, tag_order=tag_order,\n    ).strip():\n        path_tag_summary.write_text(f'{header}\\n\\n{report}\\n\\n&lt;!-- {SKIP_PHRASE} --&gt;\\n')\n        logger.text('Created Code Tag Summary', path_tag_summary=path_tag_summary)\n    elif path_tag_summary.is_file():\n        path_tag_summary.unlink()\n</code></pre>"},{"location":"reference/calcipy/dot_dict/","title":"dot_dict","text":""},{"location":"reference/calcipy/dot_dict/#calcipy.dot_dict-functions","title":"Functions","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/","title":"_dot_dict","text":"<p>Dotted dictionary for consistent interface.</p> <p>Consider moving to Corallium, but I don\u2019t have any uses for it yet.</p>"},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict.DdictType","title":"DdictType  <code>module-attribute</code>","text":"<pre><code>DdictType = Union[Dict[str, Any], Box]\n</code></pre> <p>Return type from <code>ddict()</code>.</p>"},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict-functions","title":"Functions","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict.ddict","title":"ddict","text":"<pre><code>ddict(**kwargs)\n</code></pre> <p>Return a dotted dictionary that can also be accessed normally.</p> <ul> <li>Currently uses <code>python-box</code></li> <li>Could consider <code>cleverdict</code> which had updates as recently as 2022</li> <li>There are numerous other variations that haven\u2019t been updated since 2020, such as <code>munch</code>, <code>bunch</code>, <code>ddict</code></li> </ul> PARAMETER  DESCRIPTION <code>**kwargs</code> <p>keyword arguments formatted into dictionary</p> <p> TYPE: <code>Dict[str, Any]</code> DEFAULT: <code>{}</code> </p> RETURNS DESCRIPTION <code>DdictType</code> <p>dotted dictionary</p> <p> TYPE: <code>DdictType</code> </p> Source code in <code>calcipy/dot_dict/_dot_dict.py</code> <pre><code>@beartype\ndef ddict(**kwargs: Dict[str, Any]) -&gt; DdictType:\n    \"\"\"Return a dotted dictionary that can also be accessed normally.\n\n    - Currently uses `python-box`\n    - Could consider `cleverdict` which had updates as recently as 2022\n    - There are numerous other variations that haven't been updated since 2020, such as `munch`, `bunch`, `ddict`\n\n    Args:\n        **kwargs: keyword arguments formatted into dictionary\n\n    Returns:\n        DdictType: dotted dictionary\n\n    \"\"\"\n    return Box(kwargs)\n</code></pre>"},{"location":"reference/calcipy/experiments/","title":"experiments","text":""},{"location":"reference/calcipy/experiments/bump_programmatically/","title":"bump_programmatically","text":"<p>Experiment with bumping the git tag using <code>griffe</code>.</p>"},{"location":"reference/calcipy/experiments/bump_programmatically/#calcipy.experiments.bump_programmatically-functions","title":"Functions","text":""},{"location":"reference/calcipy/experiments/bump_programmatically/#calcipy.experiments.bump_programmatically.bump_tag","title":"bump_tag","text":"<pre><code>bump_tag(*, pkg_name, tag, tag_prefix)\n</code></pre> <p>Make a SemVer minor bump using <code>griffe</code> if there were any breaking changes.</p> <p>Major versions must be bumped manually</p> Source code in <code>calcipy/experiments/bump_programmatically.py</code> <pre><code>@beartype\ndef bump_tag(*, pkg_name: str, tag: str, tag_prefix: str) -&gt; str:\n    \"\"\"Make a SemVer minor bump using `griffe` if there were any breaking changes.\n\n    Major versions must be bumped manually\n\n    \"\"\"\n    previous = griffe.load_git(pkg_name, ref=tag)\n    current = griffe.load(pkg_name)\n\n    breakages = [*griffe.find_breaking_changes(previous, current)]\n    for breakage in breakages:\n        try:\n            logger.text(breakage._explain_oneline())  # noqa: SLF001\n        except BuiltinModuleError:  # noqa: PERF203\n            logger.warning(str(breakage))\n        except Exception:\n            logger.exception(str(breakage))\n\n    try:\n        ver = semver.Version.parse(tag.replace(tag_prefix, ''))\n    except ValueError:\n        logger.exception('Failed to parse tag', tag=tag)\n        return ''\n    new_ver = ver.bump_minor() if any(breakages) else ver.bump_patch()\n    return f'{tag_prefix}{new_ver}'\n</code></pre>"},{"location":"reference/calcipy/experiments/check_duplicate_test_names/","title":"check_duplicate_test_names","text":"<p>Experiment with checking for duplicate test names.</p>"},{"location":"reference/calcipy/experiments/check_duplicate_test_names/#calcipy.experiments.check_duplicate_test_names-functions","title":"Functions","text":""},{"location":"reference/calcipy/experiments/check_duplicate_test_names/#calcipy.experiments.check_duplicate_test_names.run","title":"run","text":"<pre><code>run(test_path)\n</code></pre> <p>Check for duplicates in the test suite.</p> <p>Inspired by: https://stackoverflow.com/a/67840804/3219667</p> Source code in <code>calcipy/experiments/check_duplicate_test_names.py</code> <pre><code>@beartype\ndef run(test_path: Path) -&gt; List[str]:  # noqa: C901,CAC001  # pylint: disable=too-complex\n    \"\"\"Check for duplicates in the test suite.\n\n    Inspired by: https://stackoverflow.com/a/67840804/3219667\n\n    \"\"\"\n    summary = set()\n    duplicates = []\n\n    for path_test in test_path.rglob('test_*.py'):  # pylint: disable=too-many-nested-blocks\n        logger.info(path_test.as_posix())\n        parsed_ast = ast.parse(path_test.read_text())\n\n        for node in parsed_ast.body:\n            if isinstance(node, ast.FunctionDef):\n                if node.name in summary and node.name.startswith('test_'):\n                    duplicates.append(node.name)\n                summary.add(node.name)\n                _show_info(node)\n            elif isinstance(node, ast.ClassDef):\n                logger.info('Class name', name=node.name)\n                for method in node.body:\n                    if isinstance(method, ast.FunctionDef):\n                        _show_info(method)\n\n        for node in ast.walk(parsed_ast):  # type: ignore[assignment]\n            if (\n                isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))\n                and node.name not in summary\n            ):\n                logger.info('Found new function(s) through walking')\n                _show_info(node)\n                summary.add(node.name)\n\n    if duplicates:\n        logger.error('Found Duplicates', duplicates=duplicates)\n    return duplicates\n</code></pre>"},{"location":"reference/calcipy/md_writer/","title":"md_writer","text":""},{"location":"reference/calcipy/md_writer/#calcipy.md_writer-functions","title":"Functions","text":""},{"location":"reference/calcipy/md_writer/_writer/","title":"_writer","text":"<p>Markdown Machine.</p>"},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer.HandlerLookupT","title":"HandlerLookupT  <code>module-attribute</code>","text":"<pre><code>HandlerLookupT = Dict[str, Callable[[str, Path], List[str]]]\n</code></pre> <p>Handler Lookup.</p>"},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer-functions","title":"Functions","text":""},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer.write_autoformatted_md_sections","title":"write_autoformatted_md_sections","text":"<pre><code>write_autoformatted_md_sections(handler_lookup=None, paths_md=None)\n</code></pre> <p>Populate the auto-formatted sections of markdown files with user-configured logic.</p> Source code in <code>calcipy/md_writer/_writer.py</code> <pre><code>@beartype\ndef write_autoformatted_md_sections(\n    handler_lookup: Optional[HandlerLookupT] = None,\n    paths_md: Optional[List[Path]] = None,\n) -&gt; None:\n    \"\"\"Populate the auto-formatted sections of markdown files with user-configured logic.\"\"\"\n    _lookup: HandlerLookupT = handler_lookup or {\n        'COVERAGE ': _handle_coverage,\n        'SOURCE_FILE=': _handle_source_file,\n    }\n\n    paths = paths_md or find_project_files_by_suffix(get_project_path()).get('md') or []\n    for path_md in paths:\n        logger.text_debug('Processing', path_md=path_md)\n        if md_lines := _ReplacementMachine().parse(read_lines(path_md), _lookup, path_md):\n            path_md.write_text('\\n'.join(md_lines) + '\\n', encoding='utf-8')\n</code></pre>"},{"location":"reference/calcipy/noxfile/","title":"noxfile","text":""},{"location":"reference/calcipy/noxfile/#calcipy.noxfile-functions","title":"Functions","text":""},{"location":"reference/calcipy/noxfile/_noxfile/","title":"_noxfile","text":"<p>nox-poetry configuration file.</p> <p>Useful snippets from docs</p> <pre><code>poetry run nox -l\npoetry run nox --list-sessions\n\npoetry run nox -s build_check-3.8 build_dist-3.8 tests-3.8\npoetry run nox --session tests-3.11\n\npoetry run nox --python 3.8\n\npoetry run nox -k \"not build_check and not build_dist\"\n</code></pre> <p>Useful nox snippets</p> <pre><code># Example conditionally skipping a session\nif not session.interactive:\n    session.skip('Cannot run detect-secrets audit in non-interactive shell')\n\n# Install pinned version\nsession.install('detect-secrets==1.0.3')\n\n# Example capturing STDOUT into a file (could do the same for stderr)\npath_stdout = Path('.stdout.txt').resolve()\nwith open(path_stdout, 'w') as out:\n    session.run(*shlex.split('echo Hello World!'), stdout=out)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile-functions","title":"Functions","text":""},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.build_check","title":"build_check","text":"<pre><code>build_check(session)\n</code></pre> <p>Check that the built output meets all checks.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_poetry_session(python=_get_pythons()[-1:], reuse_venv=True)\ndef build_check(session: NPSession) -&gt; None:  # pragma: no cover\n    \"\"\"Check that the built output meets all checks.\"\"\"\n    # Build sdist and fix return URI, which will have file://...#egg=calcipy\n    sdist_uri = session.poetry.build_package(distribution_format=DistributionFormat.SDIST)\n    path_sdist = Path(url2pathname(urlparse(sdist_uri).path))\n    logger.text_debug('Fixed sdist URI', sdist_uri=sdist_uri, path_sdist=path_sdist)\n    # Check with pyroma\n    session.install('pyroma&gt;=4.0', '--upgrade')\n    # required for \"poetry.core.masonry.api\" build backend\n    session.run('python', '-m', 'pip', 'install', 'poetry&gt;=1.3', stdout=True)\n    session.run('pyroma', '--file', path_sdist.as_posix(), '--min=9', stdout=True)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.build_dist","title":"build_dist","text":"<pre><code>build_dist(session)\n</code></pre> <p>Build and test the project files within a controlled environment for repeatability.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_session(python=_get_pythons()[-1:], reuse_venv=False)\ndef build_dist(session: Union[NoxSession, NPSession]) -&gt; None:  # pragma: no cover\n    \"\"\"Build and test the project files within a controlled environment for repeatability.\"\"\"\n    dist_path = Path('dist')\n    if_found_unlink(dist_path)\n\n    # Support 'corallium' by re-implementing \"session.poetry.build_package()\", from:\n    # https://github.com/cjolowicz/nox-poetry/blob/5772b66ebff8d5a3351a08ed402d3d31e48be5f8/src/nox_poetry/sessions.py#L233-L255\n    # https://github.com/cjolowicz/nox-poetry/blob/5772b66ebff8d5a3351a08ed402d3d31e48be5f8/src/nox_poetry/poetry.py#L111-L154\n    output = session.run(*shlex.split('poetry build --format=wheel --no-ansi'),\n                         external=True, silent=True, stderr=None)\n    output = cast(str, output)\n    wheel = dist_path / output.split()[-1]\n    path_wheel = wheel.resolve().as_uri()\n\n    logger.text('Created wheel', path_wheel=path_wheel)\n    # Install the wheel and check that imports without any of the optional dependencies\n    session.install(path_wheel)\n    session.run(*shlex.split('python scripts/check_imports.py'), stdout=True)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.tests","title":"tests","text":"<pre><code>tests(session)\n</code></pre> <p>Run doit test task for specified python versions.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_session(python=_get_pythons(), reuse_venv=True)\ndef tests(session: Union[NoxSession, NPSession]) -&gt; None:  # pragma: no cover\n    \"\"\"Run doit test task for specified python versions.\"\"\"\n    _install_local(session, ['ddict', 'doc', 'lint', 'nox', 'stale', 'tags', 'test'])\n    session.run(*shlex.split('pytest ./tests'), stdout=True, env={'RUNTIME_TYPE_CHECKING_MODE': 'WARNING'})\n</code></pre>"},{"location":"reference/calcipy/tasks/","title":"tasks","text":""},{"location":"reference/calcipy/tasks/_invoke/","title":"_invoke","text":"<p>Extend Invoke for Calcipy.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection","title":"Collection","text":"<p>             Bases: <code>Collection</code></p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>class Collection(InvokeCollection):\n\n    @classmethod\n    def from_module(\n        cls,\n        module: ModuleType,\n        name: Optional[str] = None,\n        config: Optional[Dict[str, Any]] = None,\n        loaded_from: Optional[str] = None,\n        auto_dash_names: Optional[bool] = None,\n    ) -&gt; 'InvokeCollection':\n        \"\"\"Extend search for a namespace, Task, or deferred task.\"\"\"\n        collection = super().from_module(\n            module=module,\n            name=name,\n            config=config,\n            loaded_from=loaded_from,\n            auto_dash_names=auto_dash_names,\n        )\n\n        # If tasks were not loaded from a namespace or otherwise found\n        if not collection.task_names:\n            # Look for any decorated, but deferred \"Tasks\"\n            for task in (fxn for fxn in vars(module).values() if hasattr(fxn, TASK_ARGS_ATTR)):\n                collection.add_task(task)\n\n        return collection\n\n    def add_task(\n        self,\n        task: DeferedTask,\n        name: Optional[str] = None,\n        aliases: Optional[Tuple[str, ...]] = None,\n        default: Optional[bool] = None,\n    ) -&gt; None:\n        \"\"\"Extend for deferred tasks.\"\"\"\n        super().add_task(task=_build_task(task), name=name, aliases=aliases, default=default)\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection.add_task","title":"add_task","text":"<pre><code>add_task(task, name=None, aliases=None, default=None)\n</code></pre> <p>Extend for deferred tasks.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>def add_task(\n    self,\n    task: DeferedTask,\n    name: Optional[str] = None,\n    aliases: Optional[Tuple[str, ...]] = None,\n    default: Optional[bool] = None,\n) -&gt; None:\n    \"\"\"Extend for deferred tasks.\"\"\"\n    super().add_task(task=_build_task(task), name=name, aliases=aliases, default=default)\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection.from_module","title":"from_module  <code>classmethod</code>","text":"<pre><code>from_module(module, name=None, config=None, loaded_from=None, auto_dash_names=None)\n</code></pre> <p>Extend search for a namespace, Task, or deferred task.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>@classmethod\ndef from_module(\n    cls,\n    module: ModuleType,\n    name: Optional[str] = None,\n    config: Optional[Dict[str, Any]] = None,\n    loaded_from: Optional[str] = None,\n    auto_dash_names: Optional[bool] = None,\n) -&gt; 'InvokeCollection':\n    \"\"\"Extend search for a namespace, Task, or deferred task.\"\"\"\n    collection = super().from_module(\n        module=module,\n        name=name,\n        config=config,\n        loaded_from=loaded_from,\n        auto_dash_names=auto_dash_names,\n    )\n\n    # If tasks were not loaded from a namespace or otherwise found\n    if not collection.task_names:\n        # Look for any decorated, but deferred \"Tasks\"\n        for task in (fxn for fxn in vars(module).values() if hasattr(fxn, TASK_ARGS_ATTR)):\n            collection.add_task(task)\n\n    return collection\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions","title":"GlobalTaskOptions","text":"<p>             Bases: <code>BaseModel</code></p> <p>Global Task Options.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>class GlobalTaskOptions(BaseModel):\n    \"\"\"Global Task Options.\"\"\"\n\n    working_dir: Path = Field(default_factory=Path.cwd)\n    \"\"\"Working directory for the program to use globally.\"\"\"\n\n    file_args: List[Path] = Field(default_factory=list)\n    \"\"\"List of Paths to modify.\"\"\"\n\n    verbose: PositiveInt = Field(default=0, le=3)\n    \"\"\"Verbosity level.\"\"\"\n\n    keep_going: bool = False\n    \"\"\"Continue task execution regardless of failure.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.file_args","title":"file_args  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>file_args = Field(default_factory=list)\n</code></pre> <p>List of Paths to modify.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.keep_going","title":"keep_going  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>keep_going = False\n</code></pre> <p>Continue task execution regardless of failure.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.verbose","title":"verbose  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>verbose = Field(default=0, le=3)\n</code></pre> <p>Verbosity level.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.working_dir","title":"working_dir  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>working_dir = Field(default_factory=Path.cwd)\n</code></pre> <p>Working directory for the program to use globally.</p>"},{"location":"reference/calcipy/tasks/all_tasks/","title":"all_tasks","text":"<p>Tasks can be imported piecemeal or imported in their entirety from here.</p>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.TaskList","title":"TaskList  <code>module-attribute</code>","text":"<pre><code>TaskList = List[Union[Call, DeferedTask]]\n</code></pre> <p>List of wrapped or normal task functions.</p>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.main","title":"main","text":"<pre><code>main(_ctx)\n</code></pre> <p>Main task pipeline.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(post=with_progress(_MAIN_TASKS))\ndef main(_ctx: Context) -&gt; None:\n    \"\"\"Main task pipeline.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.other","title":"other","text":"<pre><code>other(_ctx)\n</code></pre> <p>Run tasks that are otherwise not exercised in main.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(post=with_progress(_OTHER_TASKS))  # pyright: ignore[reportGeneralTypeIssues]\ndef other(_ctx: Context) -&gt; None:\n    \"\"\"Run tasks that are otherwise not exercised in main.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.progress","title":"progress","text":"<pre><code>progress(_ctx, *, index, total)\n</code></pre> <p>Progress Task.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help={\n        'index': 'Current index (0-indexed)',\n        'total': 'Total steps',\n    },\n    show_task_info=False,\n)\ndef progress(_ctx: Context, *, index: int, total: int) -&gt; None:\n    \"\"\"Progress Task.\"\"\"\n    logger.text('Progress', is_header=True, index=index + 1, total=total)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.release","title":"release","text":"<pre><code>release(ctx, *, suffix=None)\n</code></pre> <p>Release pipeline.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help=cl.bump.help,\n    post=with_progress(\n        [  # pyright: ignore[reportGeneralTypeIssues]\n            pack.lock,\n            doc.build,\n            doc.deploy,\n            pack.publish,\n        ],\n        offset=1,\n    ),\n)\ndef release(ctx: Context, *, suffix: cl.SuffixT = None) -&gt; None:\n    \"\"\"Release pipeline.\"\"\"\n    cl.bumpz(ctx, suffix=suffix)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.summary","title":"summary","text":"<pre><code>summary(_ctx, *, message)\n</code></pre> <p>Summary Task.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help={\n        'message': 'String message to display',\n    },\n    show_task_info=False,\n)\ndef summary(_ctx: Context, *, message: str) -&gt; None:\n    \"\"\"Summary Task.\"\"\"\n    logger.text(message, is_header=True)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.with_progress","title":"with_progress","text":"<pre><code>with_progress(items, offset=0)\n</code></pre> <p>Inject intermediary \u2018progress\u2019 tasks.</p> PARAMETER  DESCRIPTION <code>items</code> <p>list of tasks</p> <p> TYPE: <code>Any</code> </p> <code>offset</code> <p>Optional offset to shift counters</p> <p> TYPE: <code>int</code> DEFAULT: <code>0</code> </p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@beartype\ndef with_progress(items: Any, offset: int = 0) -&gt; TaskList:\n    \"\"\"Inject intermediary 'progress' tasks.\n\n    Args:\n        items: list of tasks\n        offset: Optional offset to shift counters\n\n    \"\"\"\n    task_items = [_build_task(_t) for _t in items]\n    message = 'Running tasks: ' + ', '.join([str(_t.__name__) for _t in task_items])\n    tasks: TaskList = [summary.with_kwargs(message=message)]\n\n    total = len(task_items) + offset\n    for idx, item in enumerate(task_items):\n        tasks += [progress.with_kwargs(index=idx + offset, total=total), item]\n    return tasks\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/","title":"cl","text":"<p>Changelog CLI.</p>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.SuffixT","title":"SuffixT  <code>module-attribute</code>","text":"<pre><code>SuffixT = Optional[Literal['alpha', 'beta', 'rc']]\n</code></pre> <p>Prerelease Suffix Type.</p>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.bump","title":"bump","text":"<pre><code>bump(ctx, *, suffix=None)\n</code></pre> <p>Bumps project version based on commits &amp; settings in pyproject.toml.</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@task(\n    pre=[write],\n    help={\n        'suffix': 'Specify prerelease suffix for version bump (alpha, beta, rc)',\n    },\n)\ndef bump(ctx: Context, *, suffix: SuffixT = None) -&gt; None:\n    \"\"\"Bumps project version based on commits &amp; settings in pyproject.toml.\"\"\"\n    bumpz(ctx, suffix=suffix)\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.bumpz","title":"bumpz","text":"<pre><code>bumpz(ctx, *, suffix=None)\n</code></pre> <p>Bumps project version based on commits &amp; settings in pyproject.toml.</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@beartype\ndef bumpz(ctx: Context, *, suffix: SuffixT = None) -&gt; None:\n    \"\"\"Bumps project version based on commits &amp; settings in pyproject.toml.\"\"\"\n    check_installed(ctx, executable='gh', message=GH_MESSAGE)\n\n    opt_cz_args = f' --prerelease={suffix}' if suffix else ''\n    run(ctx, f'{python_dir()}/cz bump{opt_cz_args} --annotated-tag --no-verify --gpg-sign')\n\n    run(ctx, 'git push origin --tags --no-verify')\n\n    get_last_tag = 'git tag --list --sort=-creatordate | head -n 1'\n    opt_gh_args = ' --prerelease' if suffix else ''\n    run(ctx, f'gh release create --generate-notes $({get_last_tag}){opt_gh_args}')\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.write","title":"write","text":"<pre><code>write(ctx)\n</code></pre> <p>Write a Changelog file with the raw Git history.</p> <p>Resources:</p> <ul> <li>https://keepachangelog.com/en/1.0.0/</li> <li>https://www.conventionalcommits.org/en/v1.0.0/</li> <li>https://writingfordevelopers.substack.com/p/how-to-write-a-commit-message</li> <li>https://chris.beams.io/posts/git-commit/</li> <li>https://semver.org/</li> <li>https://calver.org/</li> </ul> RETURNS DESCRIPTION <code>None</code> <p>List[DoitAction]: doit actions</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@task()\ndef write(ctx: Context) -&gt; None:\n    \"\"\"Write a Changelog file with the raw Git history.\n\n    Resources:\n\n    - https://keepachangelog.com/en/1.0.0/\n    - https://www.conventionalcommits.org/en/v1.0.0/\n    - https://writingfordevelopers.substack.com/p/how-to-write-a-commit-message\n    - https://chris.beams.io/posts/git-commit/\n    - https://semver.org/\n    - https://calver.org/\n\n    Returns:\n        List[DoitAction]: doit actions\n\n    \"\"\"\n    run(ctx, f'{python_dir()}/cz changelog')\n    path_cl = get_project_path() / 'CHANGELOG.md'\n    if not path_cl.is_file():\n        msg = f'Could not locate the changelog at: {path_cl}'\n        raise FileNotFoundError(msg)\n    path_cl.replace(get_doc_subdir() / path_cl.name)\n</code></pre>"},{"location":"reference/calcipy/tasks/defaults/","title":"defaults","text":"<p>Calcipy-Invoke Defaults.</p>"},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults.from_ctx","title":"from_ctx","text":"<pre><code>from_ctx(ctx, group, key)\n</code></pre> <p>Safely extract the value from the context or the defaults.</p> <p>Instead of <code>ctx.tests.out_dir</code> use <code>from_ctx(ctx, 'test', 'out_dir')</code></p> Source code in <code>calcipy/tasks/defaults.py</code> <pre><code>@beartype\ndef from_ctx(ctx: Context, group: str, key: str) -&gt; str:\n    \"\"\"Safely extract the value from the context or the defaults.\n\n    Instead of `ctx.tests.out_dir` use `from_ctx(ctx, 'test', 'out_dir')`\n\n    \"\"\"\n    with suppress(KeyError):\n        return str(ctx.config[group][key])\n    return str(DEFAULTS[group][key])\n</code></pre>"},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults.new_collection","title":"new_collection","text":"<pre><code>new_collection()\n</code></pre> <p>Initialize a collection with the combination of merged and project-specific defaults.</p> Source code in <code>calcipy/tasks/defaults.py</code> <pre><code>@beartype\ndef new_collection() -&gt; Collection:\n    \"\"\"Initialize a collection with the combination of merged and project-specific defaults.\"\"\"\n    ns = Collection('')\n\n    # Merge default and user configuration\n    ns.configure(DEFAULTS)\n    config_path = Path('.calcipy.json')\n    if config_path.is_file():\n        ns.configure(json.loads(config_path.read_text(encoding='utf-8')))\n\n    return ns\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/","title":"doc","text":"<p>Document CLI.</p>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.build","title":"build","text":"<pre><code>build(ctx)\n</code></pre> <p>Build documentation with mkdocs.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef build(ctx: Context) -&gt; None:\n    \"\"\"Build documentation with mkdocs.\"\"\"\n    auto_doc_path = get_doc_subdir().parent / 'modules'\n    write_autoformatted_md_sections()\n    delete_dir(auto_doc_path)\n    _diagram_task(ctx, auto_doc_path)\n\n    # Find and trim trailing whitespace\n    for path_md in auto_doc_path.rglob('*.md'):\n        trim_trailing_whitespace(path_md)\n\n    run(ctx, f'{python_dir()}/mkdocs build --site-dir {get_out_dir()}')\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.deploy","title":"deploy","text":"<pre><code>deploy(ctx)\n</code></pre> <p>Deploy docs to the Github <code>gh-pages</code> branch.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef deploy(ctx: Context) -&gt; None:\n    \"\"\"Deploy docs to the Github `gh-pages` branch.\"\"\"\n    if _is_mkdocs_local():  # pragma: no cover\n        raise NotImplementedError('Not yet configured to deploy documentation without \"use_directory_urls\"')\n\n    with suppress(UnexpectedExit):\n        run(ctx, 'pre-commit uninstall')  # To prevent pre-commit failures when mkdocs calls push\n    run(ctx, f'{python_dir()}/mkdocs gh-deploy --force')\n    with suppress(UnexpectedExit):\n        run(ctx, 'pre-commit install')  # Restore pre-commit\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.get_out_dir","title":"get_out_dir","text":"<pre><code>get_out_dir()\n</code></pre> <p>Retrieve the mkdocs-specified site directory.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@beartype\ndef get_out_dir() -&gt; Path:\n    \"\"\"Retrieve the mkdocs-specified site directory.\"\"\"\n    mkdocs_config = read_yaml_file(get_project_path() / MKDOCS_CONFIG)\n    return Path(mkdocs_config.get('site_dir', 'releases/site'))\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.watch","title":"watch","text":"<pre><code>watch(ctx)\n</code></pre> <p>Serve local documentation for local editing.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef watch(ctx: Context) -&gt; None:\n    \"\"\"Serve local documentation for local editing.\"\"\"\n    if _is_mkdocs_local():  # pragma: no cover\n        path_doc_index = get_out_dir() / 'index.html'\n        open_in_browser(path_doc_index)\n    else:  # pragma: no cover\n        webbrowser.open('http://localhost:8000')\n        run(ctx, f'{python_dir()}/mkdocs serve --dirtyreload')\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/","title":"executable_utils","text":"<p>Utilities for working in calcipy\u2019s python environment.</p>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.check_installed","title":"check_installed","text":"<pre><code>check_installed(ctx, executable, message)\n</code></pre> <p>If the required executable isn\u2019t present, raise a clear user error.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@beartype\ndef check_installed(ctx: Context, executable: str, message: str) -&gt; None:\n    \"\"\"If the required executable isn't present, raise a clear user error.\"\"\"\n    res = run(ctx, f'which {executable}', warn=True, hide=True)\n    if not res or res.exited == 1:\n        raise RuntimeError(message)\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.python_dir","title":"python_dir  <code>cached</code>","text":"<pre><code>python_dir()\n</code></pre> <p>Runs an executable from the currently active Python directory.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef python_dir() -&gt; str:\n    \"\"\"Runs an executable from the currently active Python directory.\"\"\"\n    return str(resolve_python().parent)\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.python_m","title":"python_m  <code>cached</code>","text":"<pre><code>python_m()\n</code></pre> <p>Return the active python path and <code>-m</code> flag.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef python_m() -&gt; str:\n    \"\"\"Return the active python path and `-m` flag.\"\"\"\n    return f'{resolve_python()} -m'\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.resolve_python","title":"resolve_python  <code>cached</code>","text":"<pre><code>resolve_python()\n</code></pre> <p>Resolve the user\u2019s Python path based on <code>sys</code>.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef resolve_python() -&gt; Path:\n    \"\"\"Resolve the user's Python path based on `sys`.\"\"\"\n    python_path = Path(sys.executable)\n    with suppress(ValueError):\n        return python_path.relative_to(Path.cwd())\n    return python_path\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/","title":"lint","text":"<p>Lint CLI.</p>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.autopep8","title":"autopep8","text":"<pre><code>autopep8(ctx)\n</code></pre> <p>Run autopep8.</p> <p>FYI: This is temporary until ruff implements white space rules https://github.com/charliermarsh/ruff/issues/970</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef autopep8(ctx: Context) -&gt; None:\n    \"\"\"Run autopep8.\n\n    FYI: This is temporary until ruff implements white space rules\n    https://github.com/charliermarsh/ruff/issues/970\n\n    \"\"\"\n    cli_args = '--aggressive --recursive --in-place --max-line-length=120'\n    _inner_task(ctx, command='autopep8', cli_args=cli_args)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.check","title":"check","text":"<pre><code>check(ctx)\n</code></pre> <p>Run ruff as check-only.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(default=True)\ndef check(ctx: Context) -&gt; None:\n    \"\"\"Run ruff as check-only.\"\"\"\n    _inner_task(ctx, command='ruff check')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.fix","title":"fix","text":"<pre><code>fix(ctx)\n</code></pre> <p>Run ruff and apply fixes.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(pre=[autopep8])\ndef fix(ctx: Context) -&gt; None:\n    \"\"\"Run ruff and apply fixes.\"\"\"\n    _inner_task(ctx, command='ruff check', cli_args='--fix')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.flake8","title":"flake8","text":"<pre><code>flake8(ctx)\n</code></pre> <p>Run flake8.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef flake8(ctx: Context) -&gt; None:\n    \"\"\"Run flake8.\"\"\"\n    _inner_task(ctx, command='flake8', run_as_module=False)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.pre_commit","title":"pre_commit","text":"<pre><code>pre_commit(ctx, *, no_update=False)\n</code></pre> <p>Run pre-commit.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(\n    help={\n        'no_update': 'Skip updating the pre-commit hooks',\n    },\n)\ndef pre_commit(ctx: Context, *, no_update: bool = False) -&gt; None:\n    \"\"\"Run pre-commit.\"\"\"\n    check_installed(ctx, executable='pre-commit', message=PRE_COMMIT_MESSAGE)\n\n    run(ctx, 'pre-commit install')\n    if not no_update:\n        run(ctx, 'pre-commit autoupdate')\n\n    all_hook_stages = [\n        'commit', 'merge-commit', 'push', 'prepare-commit-msg', 'commit-msg', 'post-checkout',\n        'post-commit', 'post-merge', 'post-rewrite', 'manual',\n    ]\n    stages_cli = ' '.join(f'--hook-stage {stg}' for stg in all_hook_stages)\n    run(ctx, f'pre-commit run --all-files {stages_cli}')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.pylint","title":"pylint","text":"<pre><code>pylint(ctx, *, report=False)\n</code></pre> <p>Run pylint.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(\n    help={\n        'report': 'if provided, show the pylint summary report',\n    },\n)\ndef pylint(ctx: Context, *, report: bool = False) -&gt; None:\n    \"\"\"Run pylint.\"\"\"\n    cli_args = '--report=y' if report else ''\n    _inner_task(ctx, command='pylint', cli_args=cli_args)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.security","title":"security","text":"<pre><code>security(ctx)\n</code></pre> <p>Attempt to identify possible security vulnerabilities.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef security(ctx: Context) -&gt; None:\n    \"\"\"Attempt to identify possible security vulnerabilities.\"\"\"\n    logger.warning('Note: Selectively override bandit with \"# nosec\"', is_header=True)\n    pkg_name = read_package_name()\n    run(ctx, f'{python_dir()}/bandit --recursive {pkg_name} -s B101')\n\n    check_installed(ctx, executable='semgrep', message=SEMGREP_MESSAGE)\n    logger.warning('Note: Selectively override semgrep with \"# nosem\"', is_header=True)\n    # See additional semgrep rules at:\n    #   https://semgrep.dev/explore\n    #   https://github.com/returntocorp/semgrep-rules/tree/develop/python\n    #   https://awesomeopensource.com/project/returntocorp/semgrep-rules?categorypage=45\n    semgrep_configs = ' '.join([  # noqa: FLY002\n        '--config=p/ci',\n        '--config=p/default',\n        '--config=p/security-audit',\n        '--config=r/bash',\n        '--config=r/contrib',\n        '--config=r/fingerprints',\n        '--config=r/generic',\n        '--config=r/json',\n        '--config=r/python',\n        '--config=r/terraform',\n        '--config=r/yaml',\n        '--exclude-rule=yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha.third-party-action-not-pinned-to-commit-sha',\n    ])\n    run(ctx, f'semgrep ci --autofix {semgrep_configs}')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.watch","title":"watch","text":"<pre><code>watch(ctx)\n</code></pre> <p>Run ruff as check-only.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef watch(ctx: Context) -&gt; None:\n    \"\"\"Run ruff as check-only.\"\"\"\n    _inner_task(ctx, command='ruff check', cli_args='--watch --show-source')\n</code></pre>"},{"location":"reference/calcipy/tasks/nox/","title":"nox","text":"<p>Nox CLI.</p>"},{"location":"reference/calcipy/tasks/nox/#calcipy.tasks.nox-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/nox/#calcipy.tasks.nox.noxfile","title":"noxfile","text":"<pre><code>noxfile(ctx, *, session='')\n</code></pre> <p>Run nox from the local noxfile.</p> Source code in <code>calcipy/tasks/nox.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'session': 'Optional session to run',\n    },\n)\ndef noxfile(ctx: Context, *, session: str = '') -&gt; None:\n    \"\"\"Run nox from the local noxfile.\"\"\"\n    cli_args = ['--session', session] if session else []\n    run(ctx, f'{python_dir()}/nox --error-on-missing-interpreters {\" \".join(cli_args)}')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/","title":"pack","text":"<p>Packaging CLI.</p>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.bump_tag","title":"bump_tag","text":"<pre><code>bump_tag(ctx, *, tag, tag_prefix='', pkg_name='')\n</code></pre> <p>Experiment with bumping the git tag using <code>griffe</code>.</p> <p>Example for <code>calcipy</code>:</p> <pre><code>./run pack.bump-tag --tag=\"$(git tag -l \"*\" | sort | head -n 5 | tail -n 1)\" --tag-prefix=\"\"\n</code></pre> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task(\n    help={\n        'tag': 'Last tag, can be provided with `--tag=\"$(git tag -l \"v*\" | sort | tail -n 1)\"`',\n        'tag_prefix': 'Optional tag prefix, such as \"v\"',\n        'pkg_name': 'Optional package name. If not provided, will read the poetry pyproject.toml file',\n    },\n)\ndef bump_tag(ctx: Context, *, tag: str, tag_prefix: str = '', pkg_name: str = '') -&gt; None:  # noqa: ARG001\n    \"\"\"Experiment with bumping the git tag using `griffe`.\n\n    Example for `calcipy`:\n\n    ```sh\n    ./run pack.bump-tag --tag=\"$(git tag -l \"*\" | sort | head -n 5 | tail -n 1)\" --tag-prefix=\"\"\n    ```\n\n    \"\"\"\n    if not tag:\n        raise ValueError('tag must not be empty')\n    if not pkg_name:\n        poetry_config = file_helpers.read_pyproject()['tool']['poetry']\n        pkg_name = poetry_config['name']\n\n    new_version = bump_programmatically.bump_tag(\n        pkg_name=pkg_name,\n        tag=tag,\n        tag_prefix=tag_prefix,\n    )\n    logger.text(new_version)\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.check_licenses","title":"check_licenses","text":"<pre><code>check_licenses(ctx)\n</code></pre> <p>Check licenses for compatibility with <code>licensecheck</code>.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef check_licenses(ctx: Context) -&gt; None:\n    \"\"\"Check licenses for compatibility with `licensecheck`.\"\"\"\n    res = run(ctx, 'which licensecheck', warn=True, hide=True)\n    if not res or res.exited == 1:\n        logger.warning('`licensecheck` not found. installing with pipx')\n        run(ctx, 'pipx install licensecheck')\n    run(ctx, 'licensecheck')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.install_extras","title":"install_extras","text":"<pre><code>install_extras(ctx)\n</code></pre> <p>Run poetry install with all extras.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef install_extras(ctx: Context) -&gt; None:\n    \"\"\"Run poetry install with all extras.\"\"\"\n    poetry_config = file_helpers.read_pyproject()['tool']['poetry']\n    extras = (poetry_config.get('extras') or {}).keys()\n    run(ctx, ' '.join(['poetry install --sync', *[f'--extras={ex}' for ex in extras]]))\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.lock","title":"lock","text":"<pre><code>lock(ctx)\n</code></pre> <p>Ensure poetry.lock is  up-to-date.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef lock(ctx: Context) -&gt; None:\n    \"\"\"Ensure poetry.lock is  up-to-date.\"\"\"\n    if can_skip.can_skip(prerequisites=[PROJECT_TOML], targets=[LOCK]):\n        return  # Exit early\n\n    run(ctx, 'poetry lock --no-update')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.publish","title":"publish","text":"<pre><code>publish(ctx, *, to_test_pypi=False)\n</code></pre> <p>Build the distributed format(s) and publish.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task(\n    help={\n        'to_test_pypi': 'Publish to the TestPyPi repository',\n    },\n)\ndef publish(ctx: Context, *, to_test_pypi: bool = False) -&gt; None:\n    \"\"\"Build the distributed format(s) and publish.\"\"\"\n    run(ctx, f'{python_dir()}/nox --error-on-missing-interpreters --session build_dist build_check')\n\n    cmd = 'poetry publish'\n    if to_test_pypi:\n        cmd += ' --repository testpypi'\n    run(ctx, cmd)\n</code></pre>"},{"location":"reference/calcipy/tasks/stale/","title":"stale","text":"<p>Stale Packages CLI.</p>"},{"location":"reference/calcipy/tasks/stale/#calcipy.tasks.stale-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/stale/#calcipy.tasks.stale.check_for_stale_packages","title":"check_for_stale_packages","text":"<pre><code>check_for_stale_packages(ctx, *, stale_months=48)\n</code></pre> <p>Identify stale dependencies.</p> Source code in <code>calcipy/tasks/stale.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'stale_months': 'Cutoff in months for when a package may be stale enough to be a risk',\n    },\n)\ndef check_for_stale_packages(ctx: Context, *, stale_months: int = 48) -&gt; None:\n    \"\"\"Identify stale dependencies.\"\"\"\n    cfsp(stale_months=stale_months)\n    run(ctx, f'{python_dir()}/pip-check --cmd=\"poetry run pip\" --hide-unchanged')\n</code></pre>"},{"location":"reference/calcipy/tasks/tags/","title":"tags","text":"<p>Code Tag Collector CLI.</p>"},{"location":"reference/calcipy/tasks/tags/#calcipy.tasks.tags-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/tags/#calcipy.tasks.tags.collect_code_tags","title":"collect_code_tags","text":"<pre><code>collect_code_tags(ctx, base_dir='.', filename=None, tag_order='', regex='', ignore_patterns='')\n</code></pre> <p>Create a <code>CODE_TAG_SUMMARY.md</code> with a table for TODO- and FIXME-style code comments.</p> Source code in <code>calcipy/tasks/tags.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'base_dir': 'Working Directory',\n        'filename': 'Code Tag Summary Filename',\n        'tag_order': 'Ordered list of code tags to locate (Comma-separated)',\n        'regex': 'Custom Code Tag Regex. Must contain \"{tag}\"',\n        'ignore_patterns': 'Glob patterns to ignore files and directories when searching (Comma-separated)',\n    },\n)\ndef collect_code_tags(\n    ctx: Context,\n    base_dir: str = '.',\n    filename: Optional[str] = None,\n    tag_order: str = '',\n    regex: str = '',\n    ignore_patterns: str = '',\n) -&gt; None:\n    \"\"\"Create a `CODE_TAG_SUMMARY.md` with a table for TODO- and FIXME-style code comments.\"\"\"\n    pth_base_dir = Path(base_dir).resolve()\n    path_tag_summary = get_doc_subdir() / (filename or from_ctx(ctx, 'tags', 'filename'))\n    patterns = (ignore_patterns or from_ctx(ctx, 'tags', 'ignore_patterns')).split(',')\n    paths_source = find_project_files(pth_base_dir, ignore_patterns=[*filter(lambda item: item, patterns)])\n\n    write_code_tag_file(\n        path_tag_summary=path_tag_summary,\n        paths_source=paths_source,\n        base_dir=pth_base_dir,\n        regex=regex,\n        tags=tag_order,\n        header='# Collected Code Tags',\n    )\n</code></pre>"},{"location":"reference/calcipy/tasks/test/","title":"test","text":"<p>Test CLI.</p>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.check","title":"check","text":"<pre><code>check(_ctx)\n</code></pre> <p>Run pytest checks, such as identifying .</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task()\ndef check(_ctx: Context) -&gt; None:\n    \"\"\"Run pytest checks, such as identifying .\"\"\"\n    if duplciates := check_duplicate_test_names.run(Path('tests')):\n        raise RuntimeError(f'Duplicate test names found ({duplciates}). See above for details.')  # noqa: EM102\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.coverage","title":"coverage","text":"<pre><code>coverage(ctx, *, min_cover=0, out_dir=None, view=False)\n</code></pre> <p>Generate useful coverage outputs after running pytest.</p> <p>Creates <code>coverage.json</code> used in <code>doc.build</code></p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(\n    help={\n        'min_cover': 'Fail if coverage less than threshold',\n        'out_dir': 'Optional path to coverage directory. Typically \".cover\" or \"releases/tests\"',\n        'view': 'If True, open the created files',\n    },\n)\ndef coverage(ctx: Context, *, min_cover: int = 0, out_dir: Optional[str] = None, view: bool = False) -&gt; None:\n    \"\"\"Generate useful coverage outputs after running pytest.\n\n    Creates `coverage.json` used in `doc.build`\n\n    \"\"\"\n    pkg_name = read_package_name()\n    _inner_task(ctx, cli_args='', min_cover=min_cover,\n                command=f'coverage run --branch --source={pkg_name} --module pytest')\n\n    cov_dir = Path(out_dir or from_ctx(ctx, 'test', 'out_dir'))\n    cov_dir.mkdir(exist_ok=True, parents=True)\n    print()  # noqa: T201\n    for cli_args in (\n        'report --show-missing',  # Write to STDOUT\n        f'html --directory={cov_dir}',  # Write to HTML\n        'json',  # Create coverage.json file for \"_handle_coverage\"\n    ):\n        run(ctx, f'{python_dir()}/coverage {cli_args}')\n\n    if view:  # pragma: no cover\n        open_in_browser(cov_dir / 'index.html')\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.pytest","title":"pytest","text":"<pre><code>pytest(ctx, *, keyword='', marker='', min_cover=0)\n</code></pre> <p>Run pytest with default arguments.</p> <p>Additional arguments can be set in the environment variable \u2018PYTEST_ADDOPTS\u2019</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'min_cover': 'Fail if coverage less than threshold',\n        **KM_HELP,\n    },\n)\ndef pytest(ctx: Context, *, keyword: str = '', marker: str = '', min_cover: int = 0) -&gt; None:\n    \"\"\"Run pytest with default arguments.\n\n    Additional arguments can be set in the environment variable 'PYTEST_ADDOPTS'\n\n    \"\"\"\n    pkg_name = read_package_name()\n    durations = '--durations=25 --durations-min=\"0.1\"'\n    _inner_task(ctx,\n                cli_args=f' --cov={pkg_name} --cov-branch --cov-report=term-missing {durations}',\n                keyword=keyword, marker=marker, min_cover=min_cover)\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.step","title":"step","text":"<pre><code>step(ctx, *, keyword='', marker='')\n</code></pre> <p>Run pytest optimized to stop on first error.</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(help=KM_HELP)\ndef step(ctx: Context, *, keyword: str = '', marker: str = '') -&gt; None:\n    \"\"\"Run pytest optimized to stop on first error.\"\"\"\n    _inner_task(ctx, cli_args=_STEPWISE_ARGS, keyword=keyword, marker=marker)\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.watch","title":"watch","text":"<pre><code>watch(ctx, *, keyword='', marker='')\n</code></pre> <p>Run pytest with polling and optimized to stop on first error.</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(help=KM_HELP)\ndef watch(ctx: Context, *, keyword: str = '', marker: str = '') -&gt; None:\n    \"\"\"Run pytest with polling and optimized to stop on first error.\"\"\"\n    _inner_task(ctx, cli_args=_STEPWISE_ARGS, keyword=keyword, marker=marker, command='ptw . --now')\n</code></pre>"},{"location":"reference/calcipy/tasks/types/","title":"types","text":"<p>Types CLI.</p>"},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types.mypy","title":"mypy","text":"<pre><code>mypy(ctx)\n</code></pre> <p>Run mypy.</p> Source code in <code>calcipy/tasks/types.py</code> <pre><code>@task()\ndef mypy(ctx: Context) -&gt; None:\n    \"\"\"Run mypy.\"\"\"\n    _inner_task(ctx, command=f'{python_dir()}/mypy')\n</code></pre>"},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types.pyright","title":"pyright","text":"<pre><code>pyright(ctx)\n</code></pre> <p>Run pyright.</p> Source code in <code>calcipy/tasks/types.py</code> <pre><code>@task()\ndef pyright(ctx: Context) -&gt; None:\n    \"\"\"Run pyright.\"\"\"\n    check_installed(ctx, executable='pyright', message=PYRIGHT_MESSAGE)\n    _inner_task(ctx, command='pyright')\n</code></pre>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"calcipy","text":"<p><code>calcipy</code> is a Python package that implements best practices such as code style (linting, auto-fixes), documentation, CI/CD, and logging. Like the calcium carbonate in hard coral, packages can be built on the <code>calcipy</code> foundation.</p> <p><code>calcipy</code> has some configurability, but is tailored for my particular use cases. If you want the same sort of functionality, there are a number of alternatives to consider:</p> <ul> <li>pyscaffold is a much more mature project that aims for the same goals, but with a slightly different approach and tech stack (tox vs. nox, cookiecutter vs. copier, etc.)</li> <li>tidypy, pylama, and codecheck offer similar functionality of bundling and running static checkers, but makes far fewer assumptions</li> <li>pytoil is a general CLI tool for developer automation</li> <li>And many more such as pyta, prospector, wemake-python-styleguide / cjolowicz/cookiecutter-hypermodern-python, formate, johnthagen/python-blueprint, oxsecurity/megalinter, etc.</li> </ul>"},{"location":"#installation","title":"Installation","text":"<p>Calcipy needs a few static files managed using copier and a template project: kyleking/calcipy_template</p> <p>You can quickly use the template to create a new project or add calcipy to an existing one:</p> <pre><code># Install copier. pipx is recommended\npipx install copier\n\n# To create a new project\ncopier copy gh:KyleKing/calcipy_template new_project\ncd new_project\n\n# Or convert/update an existing one\ncd my_project\ncopier copy gh:KyleKing/calcipy_template .\ncopier update\n</code></pre>"},{"location":"#calcipy-cli","title":"Calcipy CLI","text":"<p>Additionally, <code>calcipy</code> can be run as a CLI application without adding the package as a dependency.</p> <p>Quick Start:</p> <pre><code># For the CLI, only install a few of the extras which can be used from a few different CLI commands\npipx install 'calcipy[flake8,lint,tags]'\n\n# Use 'tags' to create a CODE_TAG_SUMMARY of the specified directory\ncalcipy-tags tags --help\ncalcipy-tags tags --base-dir=~/path/to/my_project\n\n# You can list all provided CLI commands with\npipx list\n</code></pre> <pre><code>venvs are in ~/.local/pipx/venvs\napps are exposed on your $PATH at ~/.local/bin\n   package calcipy 1.4.0, installed using Python 3.11.4\n    - calcipy\n    - calcipy-lint\n    - calcipy-pack\n    - calcipy-tags\n    - calcipy-types\n</code></pre> <p>Note: the CLI output below is compressed for readability, but you can try running each of these commands locally to see the most up-to-date documentation and the full set of options. The \u201cUsage\u201d, \u201cCore options\u201d, and \u201cGlobal Task Options\u201d are the same for each subsequent command, so they are excluded for brevity.</p> <pre><code>&gt; calcipy-lint\nUsage: calcipy-lint [--core-opts] &lt;subcommand&gt; [--subcommand-opts] ...\n\nCore options:\n\n  --complete                         Print tab-completion candidates for given parse remainder.\n  --hide=STRING                      Set default value of run()'s 'hide' kwarg.\n  --print-completion-script=STRING   Print the tab-completion script for your preferred shell (bash|zsh|fish).\n  --prompt-for-sudo-password         Prompt user at start of session for the sudo.password config value.\n  --write-pyc                        Enable creation of .pyc files.\n  -d, --debug                        Enable debug output.\n  -D INT, --list-depth=INT           When listing tasks, only show the first INT levels.\n  -e, --echo                         Echo executed commands before running.\n  -f STRING, --config=STRING         Runtime configuration file to use.\n  -F STRING, --list-format=STRING    Change the display format used when listing tasks. Should be one of: flat (default), nested, json.\n  -h [STRING], --help[=STRING]       Show core or per-task help and exit.\n  -l [STRING], --list[=STRING]       List available tasks, optionally limited to a namespace.\n  -p, --pty                          Use a pty when executing shell commands.\n  -R, --dry                          Echo commands instead of running.\n  -T INT, --command-timeout=INT      Specify a global command execution timeout, in seconds.\n  -V, --version                      Show version and exit.\n  -w, --warn-only                    Warn, instead of failing, when shell commands fail.\n\nSubcommands:\n\n  lint.autopep8       Run autopep8.\n  lint.check (lint)   Run ruff as check-only.\n  lint.fix            Run ruff and apply fixes.\n  lint.flake8         Run flake8.\n  lint.pre-commit     Run pre-commit.\n  lint.pylint         Run pylint.\n  lint.security       Attempt to identify possible security vulnerabilities.\n  lint.watch          Run ruff as check-only.\n\nGlobal Task Options:\n\n  *file_args             List of Paths available globally to all tasks. Will resolve paths with working_dir\n  --keep-going           Continue running tasks even on failure\n  --working_dir=STRING   Set the cwd for the program. Example: \"../run --working-dir .. lint test\"\n  -v,-vv,-vvv            Globally configure logger verbosity (-vvv for most verbose)\n\n&gt; calcipy-pack\n\nSubcommands:\n\n  pack.check-licenses   Check licenses for compatibility with `licensecheck`.\n  pack.install-extras   Run poetry install with all extras.\n  pack.lock             Ensure poetry.lock is  up-to-date.\n  pack.publish          Build the distributed format(s) and publish.\n\n&gt; calcipy-tags\n\nSubcommands:\n\n  tags.collect-code-tags (tags)   Create a `CODE_TAG_SUMMARY.md` with a table          for TODO- and FIXME-style code comments.\n\n&gt; calcipy-types\n\nSubcommands:\n\n  types.mypy      Run mypy.\n  types.pyright   Run pyright.\n</code></pre>"},{"location":"#calcipy-pre-commit","title":"Calcipy Pre-Commit","text":"<p><code>calcipy</code> can also be used as a <code>pre-commit</code> task by adding the below snippet to your <code>pre-commit</code> file:</p> <pre><code>repos:\n  - repo: https://github.com/KyleKing/calcipy\n    rev: main\n    hooks:\n      - id: tags\n      - id: lint-fix\n      - id: types\n</code></pre>"},{"location":"#project-status","title":"Project Status","text":"<p>See the <code>Open Issues</code> and/or the CODE_TAG_SUMMARY. For release history, see the CHANGELOG.</p>"},{"location":"#contributing","title":"Contributing","text":"<p>We welcome pull requests! For your pull request to be accepted smoothly, we suggest that you first open a GitHub issue to discuss your idea. For resources on getting started with the code base, see the below documentation:</p> <ul> <li>DEVELOPER_GUIDE</li> <li>STYLE_GUIDE</li> </ul>"},{"location":"#code-of-conduct","title":"Code of Conduct","text":"<p>We follow the Contributor Covenant Code of Conduct.</p>"},{"location":"#open-source-status","title":"Open Source Status","text":"<p>We try to reasonably meet most aspects of the \u201cOpenSSF scorecard\u201d from Open Source Insights</p>"},{"location":"#responsible-disclosure","title":"Responsible Disclosure","text":"<p>If you have any security issue to report, please contact the project maintainers privately. You can reach us at dev.act.kyle@gmail.com.</p>"},{"location":"#license","title":"License","text":"<p>LICENSE</p>"},{"location":"docs/CHANGELOG/","title":"Docs","text":""},{"location":"docs/CHANGELOG/#unreleased","title":"Unreleased","text":""},{"location":"docs/CHANGELOG/#202-2023-11-08","title":"2.0.2 (2023-11-08)","text":""},{"location":"docs/CHANGELOG/#refactor","title":"Refactor","text":"<ul> <li>copier-auto-update</li> </ul>"},{"location":"docs/CHANGELOG/#201-2023-09-08","title":"2.0.1 (2023-09-08)","text":""},{"location":"docs/CHANGELOG/#fix","title":"Fix","text":"<ul> <li>add missing setuptools for some mkdocs dependencies</li> <li>add calcipy-docs and restore missing extras for type checking</li> <li>add scoped \u2018calcipy-test\u2019</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_1","title":"Refactor","text":"<ul> <li>really move nox</li> <li>use ruff.external to allow list flake8 rules</li> </ul>"},{"location":"docs/CHANGELOG/#200-2023-09-02","title":"2.0.0 (2023-09-02)","text":""},{"location":"docs/CHANGELOG/#feat","title":"Feat","text":"<ul> <li>drop Python 3.8</li> </ul>"},{"location":"docs/CHANGELOG/#fix_1","title":"Fix","text":"<ul> <li>specify a unique name when binding new kwargs</li> </ul>"},{"location":"docs/CHANGELOG/#164-2023-08-28","title":"1.6.4 (2023-08-28)","text":""},{"location":"docs/CHANGELOG/#fix_2","title":"Fix","text":"<ul> <li>update pyrate-limiter</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_2","title":"Refactor","text":"<ul> <li>address pydantic v2 migration warnings</li> </ul>"},{"location":"docs/CHANGELOG/#163-2023-08-13","title":"1.6.3 (2023-08-13)","text":""},{"location":"docs/CHANGELOG/#fix_3","title":"Fix","text":"<ul> <li>remove redundant beartype to lru_cache</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_3","title":"Refactor","text":"<ul> <li>resolve asdf</li> <li>tried get_env_vars</li> </ul>"},{"location":"docs/CHANGELOG/#162-2023-08-12","title":"1.6.2 (2023-08-12)","text":""},{"location":"docs/CHANGELOG/#161rc0-2023-08-12","title":"1.6.1rc0 (2023-08-12)","text":""},{"location":"docs/CHANGELOG/#fix_4","title":"Fix","text":"<ul> <li>support partial kwargs for pre/post</li> <li>defer Task to support decorator chaining</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_4","title":"Refactor","text":"<ul> <li>setup for deferred task refactor</li> <li>update dependency versions</li> <li>update copier for a more generic environment variable</li> </ul>"},{"location":"docs/CHANGELOG/#160-2023-07-23","title":"1.6.0 (2023-07-23)","text":""},{"location":"docs/CHANGELOG/#feat_1","title":"Feat","text":"<ul> <li>experiment with griffe for version bumping</li> </ul>"},{"location":"docs/CHANGELOG/#fix_5","title":"Fix","text":"<ul> <li>resolve minor bugs in griffe experiment</li> <li>remove dependency on flake8-beartype</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_5","title":"Refactor","text":"<ul> <li>downgrade replacement machine error to warning</li> </ul>"},{"location":"docs/CHANGELOG/#150-2023-07-22","title":"1.5.0 (2023-07-22)","text":""},{"location":"docs/CHANGELOG/#feat_2","title":"Feat","text":"<ul> <li>add configurable ignore patterns for tags</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_6","title":"Refactor","text":"<ul> <li>resolve pylint warnings</li> <li>run bump-pydantic</li> </ul>"},{"location":"docs/CHANGELOG/#142-2023-07-16","title":"1.4.2 (2023-07-16)","text":""},{"location":"docs/CHANGELOG/#fix_6","title":"Fix","text":"<ul> <li>use the correct exclude rule for semgrep</li> <li>support pydantic v2 serialization</li> <li>skip SemGrep rule to pin GitHub Actions to commit IDs</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_7","title":"Refactor","text":"<ul> <li>resolve local test suite problems</li> </ul>"},{"location":"docs/CHANGELOG/#141-2023-07-07","title":"1.4.1 (2023-07-07)","text":""},{"location":"docs/CHANGELOG/#fix_7","title":"Fix","text":"<ul> <li>retrieve only unique python versions from .tool-versions</li> </ul>"},{"location":"docs/CHANGELOG/#140-2023-06-25","title":"1.4.0 (2023-06-25)","text":""},{"location":"docs/CHANGELOG/#feat_3","title":"Feat","text":"<ul> <li>add calcipy-pack to use install-extras without the extras</li> </ul>"},{"location":"docs/CHANGELOG/#fix_8","title":"Fix","text":"<ul> <li>show a readable warning when gh, pyright, and/or pre-commit are not installed</li> <li>use calcipy\u2019s python environment when installed with pipx</li> </ul>"},{"location":"docs/CHANGELOG/#130-2023-06-21","title":"1.3.0 (2023-06-21)","text":""},{"location":"docs/CHANGELOG/#feat_4","title":"Feat","text":"<ul> <li>switch to httpx for async requests</li> </ul>"},{"location":"docs/CHANGELOG/#perf","title":"Perf","text":"<ul> <li>lazy cache compiling the regex</li> </ul>"},{"location":"docs/CHANGELOG/#126-2023-06-17","title":"1.2.6 (2023-06-17)","text":""},{"location":"docs/CHANGELOG/#fix_9","title":"Fix","text":"<ul> <li>handle missing git remotes in code tag collection</li> <li>always re-cache packages if empty</li> <li>ignore new TD002 &amp; TD003 linting rules</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_8","title":"Refactor","text":"<ul> <li>try to handle exceptions when no git origin URL</li> </ul>"},{"location":"docs/CHANGELOG/#125-2023-05-23","title":"1.2.5 (2023-05-23)","text":""},{"location":"docs/CHANGELOG/#fix_10","title":"Fix","text":"<ul> <li>resolve typing and import errors</li> <li>upgrade to invoke 2.1.2</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_9","title":"Refactor","text":"<ul> <li>suppress ruff autofix</li> </ul>"},{"location":"docs/CHANGELOG/#124-2023-05-16","title":"1.2.4 (2023-05-16)","text":""},{"location":"docs/CHANGELOG/#fix_11","title":"Fix","text":"<ul> <li>add pack.install-extras</li> <li>bump minimum pymdown dependency</li> <li>pydantic alias doesn\u2019t work like that</li> <li>refactor for higher pylint quality</li> <li>update the help string to include \u2013keep-going</li> <li>support branch coverage</li> <li>move pyright to \u2018main\u2019 tasks</li> </ul>"},{"location":"docs/CHANGELOG/#123-2023-04-08","title":"1.2.3 (2023-04-08)","text":""},{"location":"docs/CHANGELOG/#fix_12","title":"Fix","text":"<ul> <li>handle dev installs when only calcipy</li> </ul>"},{"location":"docs/CHANGELOG/#122-2023-04-08","title":"1.2.2 (2023-04-08)","text":""},{"location":"docs/CHANGELOG/#fix_13","title":"Fix","text":"<ul> <li>add preview of \u2013keep-going</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_10","title":"Refactor","text":"<ul> <li>extract task logic from wrapper</li> </ul>"},{"location":"docs/CHANGELOG/#121-2023-04-07","title":"1.2.1 (2023-04-07)","text":""},{"location":"docs/CHANGELOG/#fix_14","title":"Fix","text":"<ul> <li>skip assert_used in bandit</li> </ul>"},{"location":"docs/CHANGELOG/#120-2023-04-06","title":"1.2.0 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#feat_5","title":"Feat","text":"<ul> <li>add test.check with duplicate name logic</li> </ul>"},{"location":"docs/CHANGELOG/#fix_15","title":"Fix","text":"<ul> <li>remove lru_cache, which was causing mypy errors</li> </ul>"},{"location":"docs/CHANGELOG/#111-2023-04-06","title":"1.1.1 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#fix_16","title":"Fix","text":"<ul> <li>resolve linting errors</li> <li>use copier copy</li> </ul>"},{"location":"docs/CHANGELOG/#110-2023-04-06","title":"1.1.0 (2023-04-06)","text":""},{"location":"docs/CHANGELOG/#feat_6","title":"Feat","text":"<ul> <li>add experimental check duplicate test names</li> </ul>"},{"location":"docs/CHANGELOG/#fix_17","title":"Fix","text":"<ul> <li>suppress unexpected exit errors in update docs</li> <li>skip pre-commit uninstall for doc.deploy when pre-commit not available</li> <li>skip pre-commit on doc.deploy</li> </ul>"},{"location":"docs/CHANGELOG/#101-2023-03-01","title":"1.0.1 (2023-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_18","title":"Fix","text":"<ul> <li>bump minimum ruff version</li> </ul>"},{"location":"docs/CHANGELOG/#100-2023-02-25","title":"1.0.0 (2023-02-25)","text":""},{"location":"docs/CHANGELOG/#fix_19","title":"Fix","text":"<ul> <li>lower default logging level</li> </ul>"},{"location":"docs/CHANGELOG/#100rc7-2023-02-23","title":"1.0.0rc7 (2023-02-23)","text":""},{"location":"docs/CHANGELOG/#feat_7","title":"Feat","text":"<ul> <li>add lint.security to pre-commit lint-fix hook</li> </ul>"},{"location":"docs/CHANGELOG/#fix_20","title":"Fix","text":"<ul> <li>remove types hook, which doesn\u2019t work when not local</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_11","title":"Refactor","text":"<ul> <li>make task summary optional</li> <li>configure start program inline</li> </ul>"},{"location":"docs/CHANGELOG/#100rc6-2023-02-22","title":"1.0.0rc6 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_21","title":"Fix","text":"<ul> <li>provide subcommands to support pre-commit</li> </ul>"},{"location":"docs/CHANGELOG/#100rc5-2023-02-22","title":"1.0.0rc5 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#feat_8","title":"Feat","text":"<ul> <li>add pre-commit hooks and update docs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_22","title":"Fix","text":"<ul> <li>handle KeyError when not yet on PyPi\u2019s JSON API</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_12","title":"Refactor","text":"<ul> <li>sync with corallium ruff and remove flake8 class-attr-order</li> </ul>"},{"location":"docs/CHANGELOG/#100rc4-2023-02-22","title":"1.0.0rc4 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_23","title":"Fix","text":"<ul> <li>fully support nox and corallium</li> </ul>"},{"location":"docs/CHANGELOG/#100rc3-2023-02-22","title":"1.0.0rc3 (2023-02-22)","text":""},{"location":"docs/CHANGELOG/#fix_24","title":"Fix","text":"<ul> <li>add depedency on corallium</li> </ul>"},{"location":"docs/CHANGELOG/#100rc2-2023-02-21","title":"1.0.0rc2 (2023-02-21)","text":""},{"location":"docs/CHANGELOG/#feat_9","title":"Feat","text":"<ul> <li>merge shoal source code into calcipy</li> </ul>"},{"location":"docs/CHANGELOG/#100rc1-2023-02-21","title":"1.0.0rc1 (2023-02-21)","text":""},{"location":"docs/CHANGELOG/#fix_25","title":"Fix","text":"<ul> <li>upgrade shoal dependency and add summary</li> <li>add pylint to document</li> <li>move autopep8 to the lint extras</li> </ul>"},{"location":"docs/CHANGELOG/#100rc0-2023-02-20","title":"1.0.0rc0 (2023-02-20)","text":""},{"location":"docs/CHANGELOG/#feat_10","title":"Feat","text":"<ul> <li>fully support working-dir by wrapping ctx.run</li> <li>recursively find the tool versions file</li> <li>add dont_skip for testing</li> <li>add tests for code tag collector</li> <li>replace dg with user configuration file</li> <li>better support min-cover</li> <li>unit test write_autoformatted_md_sections</li> <li>start using check_imports</li> <li>support prereleases and add autopep8</li> <li>introduce cl namespace</li> <li>run lint on file_args and use absolufy</li> <li>add initial version of doc namespace</li> <li>remove pre-commit; add doc and ddict extras</li> <li>add progress indicator to tasks</li> <li>add lint.security</li> <li>add ./run to generlize local entrypoint</li> <li>add lint.pre-commit</li> <li>restore most of noxfile</li> <li>run mypy-silent and add main task</li> <li>use can_skip for the package_lock file</li> <li>start manually fixing lint issues</li> <li>add linting</li> <li>migrate over stale package logic</li> <li>add pyright, mypy, and DEFAULTS</li> <li>add write_json and cached pyproject reader</li> <li>add pytest-based tasks and first unit tests</li> <li>experiment with parallel processing</li> <li>init placeholders for new namespaces</li> <li>add can_skip</li> <li>add initial nox task to invoke</li> <li>switch to invoke</li> <li>start restoring files and switching to shoal</li> <li>add shoal</li> </ul>"},{"location":"docs/CHANGELOG/#fix_26","title":"Fix","text":"<ul> <li>correct ignore pattern logic and expand task tests</li> <li>get doc and cl tasks working</li> <li>code tag summary and rename default tasks</li> <li>properly map CLI arguments to code tag collector</li> <li>show all URLs on the same line in CTC</li> <li>write Code Tags to docs/docs</li> <li>resolve issues with test.watch-json</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_13","title":"Refactor","text":"<ul> <li>update Progress task</li> <li>extract use_pty to a default in shoal</li> <li>generlize find_in_parents for pyproject.toml as well</li> <li>introduce logger.print and print_debug</li> <li>drop absolufy-imports task</li> <li>simplify configuration</li> <li>fix remaining pyright and flake8 errors</li> <li>rename write-json to coverage</li> <li>resolve pylint issues</li> <li>reorder main tasks</li> <li>resolve flake8 warnings and better manage filenames</li> <li>apply autopep8 to fix whitespace issues</li> <li>import initialized logger directly</li> <li>try to wrap running tasks programmatically\u2026</li> <li>run prc main</li> <li>move log configuration to shoal.cli.task</li> <li>resolve typecheck errors</li> <li>manually resolve additional linting errors</li> <li>make lint.check default</li> <li>extract start program to shoal</li> <li>another round of manual lint corrections</li> <li>move can_skip to shoal</li> <li> <p>nest invoke-specific code in tasks/</p> </li> <li> <p>drop pytest-html and conftest completely</p> </li> </ul>"},{"location":"docs/CHANGELOG/#0216-2023-01-31","title":"0.21.6 (2023-01-31)","text":""},{"location":"docs/CHANGELOG/#feat_11","title":"Feat","text":"<ul> <li>use the \u2013now flag for ptw!</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_14","title":"Refactor","text":"<ul> <li>remove autoflake in favor of unimport</li> </ul>"},{"location":"docs/CHANGELOG/#0215-2022-11-27","title":"0.21.5 (2022-11-27)","text":""},{"location":"docs/CHANGELOG/#fix_27","title":"Fix","text":"<ul> <li>escape % in yaml files as well</li> </ul>"},{"location":"docs/CHANGELOG/#0214-2022-11-20","title":"0.21.4 (2022-11-20)","text":""},{"location":"docs/CHANGELOG/#fix_28","title":"Fix","text":"<ul> <li>handle % in path names for ctt</li> <li>suppress code tag failures when not a git directory</li> <li>add support for tomllib in Python 3.11!</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_15","title":"Refactor","text":"<ul> <li>copier update</li> </ul>"},{"location":"docs/CHANGELOG/#0213-2022-11-13","title":"0.21.3 (2022-11-13)","text":""},{"location":"docs/CHANGELOG/#fix_29","title":"Fix","text":"<ul> <li>remove unimplemented diff-cover</li> <li>exit 1 on semgrep errors</li> </ul>"},{"location":"docs/CHANGELOG/#0212-2022-11-12","title":"0.21.2 (2022-11-12)","text":""},{"location":"docs/CHANGELOG/#fix_30","title":"Fix","text":"<ul> <li>add relative path prefix for linting \u2018./\u2019</li> <li>ensure that cz bump doesn\u2019t break the requirements file</li> <li>bump minimum pip-check</li> </ul>"},{"location":"docs/CHANGELOG/#0211-2022-11-05","title":"0.21.1 (2022-11-05)","text":""},{"location":"docs/CHANGELOG/#fix_31","title":"Fix","text":"<ul> <li>install poetry for \u2018doit publish\u2019</li> <li>bump minimum mkdocs for deploy_docs</li> </ul>"},{"location":"docs/CHANGELOG/#0210-2022-11-05","title":"0.21.0 (2022-11-05)","text":""},{"location":"docs/CHANGELOG/#feat_12","title":"Feat","text":"<ul> <li>remove if-expr and other unnecessary new flake8 plugins</li> <li>merge extra flake8 packages based on flake8-aggressive</li> </ul>"},{"location":"docs/CHANGELOG/#fix_32","title":"Fix","text":"<ul> <li>prevent line break in table for Code Tag summary</li> <li>add pdbr with rich to replace pdbpp</li> </ul>"},{"location":"docs/CHANGELOG/#0201-2022-10-19","title":"0.20.1 (2022-10-19)","text":""},{"location":"docs/CHANGELOG/#fix_33","title":"Fix","text":"<ul> <li>drop pdbpp and add flake8-fine-pytest</li> </ul>"},{"location":"docs/CHANGELOG/#0200-2022-10-16","title":"0.20.0 (2022-10-16)","text":""},{"location":"docs/CHANGELOG/#feat_13","title":"Feat","text":"<ul> <li>sign commitizen tags</li> <li>add plantuml generation to mkdocs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_34","title":"Fix","text":"<ul> <li>remove version conflict with flake8-simplify and cl_bump</li> </ul>"},{"location":"docs/CHANGELOG/#0191-2022-10-13","title":"0.19.1 (2022-10-13)","text":""},{"location":"docs/CHANGELOG/#fix_35","title":"Fix","text":"<ul> <li>don\u2019t auto-install types</li> </ul>"},{"location":"docs/CHANGELOG/#0190-2022-10-06","title":"0.19.0 (2022-10-06)","text":""},{"location":"docs/CHANGELOG/#feat_14","title":"Feat","text":"<ul> <li>support optional logging of arguments</li> </ul>"},{"location":"docs/CHANGELOG/#fix_36","title":"Fix","text":"<ul> <li>split mypy install from mypy run</li> </ul>"},{"location":"docs/CHANGELOG/#0180-2022-09-27","title":"0.18.0 (2022-09-27)","text":""},{"location":"docs/CHANGELOG/#feat_15","title":"Feat","text":"<ul> <li>support Arrow in pydantic and mypy (ArrowType was causing errors)</li> <li>remove pdoc(s) from document task</li> <li>add gen_ref_nav!</li> <li>tried pybetter, but too focused on adding all</li> <li>#102: sort-of-replace pdocs, but pdoc only shows one function</li> <li>add mypy install argument</li> <li>expand flake8 and reduce tests</li> </ul>"},{"location":"docs/CHANGELOG/#fix_37","title":"Fix","text":"<ul> <li>re-run prdc</li> <li>lower fail-under for diff. Raise for regular test</li> <li>standardize on a single doit task list</li> <li>Pathlib.absolute is not documented. Use .resolve</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_16","title":"Refactor","text":"<ul> <li>add type hints and minor changes for mypy</li> <li>make python files non-executable (chmod -x)</li> </ul>"},{"location":"docs/CHANGELOG/#0171-2022-09-22","title":"0.17.1 (2022-09-22)","text":""},{"location":"docs/CHANGELOG/#fix_38","title":"Fix","text":"<ul> <li>pytest cache assert circular reference</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_17","title":"Refactor","text":"<ul> <li>move check_security from nox into doit</li> </ul>"},{"location":"docs/CHANGELOG/#0170-2022-09-17","title":"0.17.0 (2022-09-17)","text":""},{"location":"docs/CHANGELOG/#feat_16","title":"Feat","text":"<ul> <li>add docformat</li> <li>make pyupgrade flag configurable based on minimum python version</li> <li>replace pendulum with arrow</li> <li>update to latest copier</li> </ul>"},{"location":"docs/CHANGELOG/#fix_39","title":"Fix","text":"<ul> <li>move yamllint configuration to project-specific config</li> <li>naive datetimes can\u2019t be subtracted on Windows</li> <li>hack together a dictionary instead of punq</li> <li>drop safety because of false positives on Calcipy CalVer</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_18","title":"Refactor","text":"<ul> <li>experiment with custom semgrep rules</li> <li>formalize solution from last commit</li> <li>try to fix punq by switching to functions</li> <li>fix one test, refactor a little, but punq is still not working</li> <li>begin replacing attrs with pydantic</li> <li>update semgrep nox task</li> <li>upgrade copier with linting fixes</li> </ul>"},{"location":"docs/CHANGELOG/#0160-2022-08-04","title":"0.16.0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_17","title":"Feat","text":"<ul> <li>add flake8-simplify</li> </ul>"},{"location":"docs/CHANGELOG/#fix_40","title":"Fix","text":"<ul> <li>show only date in coverage table</li> </ul>"},{"location":"docs/CHANGELOG/#0150-2022-08-03","title":"0.15.0 (2022-08-03)","text":""},{"location":"docs/CHANGELOG/#fix_41","title":"Fix","text":"<ul> <li>resolve pyroma errors by installing poetry as a module</li> </ul>"},{"location":"docs/CHANGELOG/#0150rc0-2022-07-24","title":"0.15.0rc0 (2022-07-24)","text":""},{"location":"docs/CHANGELOG/#feat_18","title":"Feat","text":"<ul> <li>init update workflow and toml sorter</li> <li>create script to bump toml minimum requirements</li> </ul>"},{"location":"docs/CHANGELOG/#fix_42","title":"Fix","text":"<ul> <li>properly handle missing datetime</li> <li>try to use separate sqlite files for pre-commit and doit</li> <li>correct safety arguments</li> <li>use the unversioned API for releases</li> <li>try to handle pypi response when no \u201creleases\u201d</li> <li>handle prefix of \u201c*\u201d</li> <li>improve error message when \u201creleases\u201d not present</li> <li> <p>use sqlite3 for pre-commit concurrent doit access</p> </li> <li> <p>bump Python to 3.8.4 and drop 3.7</p> </li> </ul>"},{"location":"docs/CHANGELOG/#0145-2022-03-05","title":"0.14.5 (2022-03-05)","text":""},{"location":"docs/CHANGELOG/#fix_43","title":"Fix","text":"<ul> <li>#91: prevent minified files from appearing in Code Tag Summary</li> </ul>"},{"location":"docs/CHANGELOG/#0144-2022-03-01","title":"0.14.4 (2022-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_44","title":"Fix","text":"<ul> <li>set upper limit to fix flake8-bandit compat</li> </ul>"},{"location":"docs/CHANGELOG/#0143-2022-03-01","title":"0.14.3 (2022-03-01)","text":""},{"location":"docs/CHANGELOG/#fix_45","title":"Fix","text":"<ul> <li>suppress only known git blame errors</li> <li>use Github tables to prevent multi-line rows in Code Tag Summary</li> </ul>"},{"location":"docs/CHANGELOG/#0142-2022-02-27","title":"0.14.2 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#fix_46","title":"Fix","text":"<ul> <li>don\u2019t allow multi-line tables</li> </ul>"},{"location":"docs/CHANGELOG/#0141-2022-02-27","title":"0.14.1 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#fix_47","title":"Fix","text":"<ul> <li>lower pandas constraint for better 3.7 support</li> <li>drop generation of requirements.txt</li> </ul>"},{"location":"docs/CHANGELOG/#0140-2022-02-27","title":"0.14.0 (2022-02-27)","text":""},{"location":"docs/CHANGELOG/#feat_19","title":"Feat","text":"<ul> <li>use next-gen attrs syntax</li> <li>improve code tag regex</li> </ul>"},{"location":"docs/CHANGELOG/#fix_48","title":"Fix","text":"<ul> <li>correct type annotations</li> <li>undo silent nox step</li> <li>make coverage.json optional for task_doc</li> </ul>"},{"location":"docs/CHANGELOG/#0130-2022-02-23","title":"0.13.0 (2022-02-23)","text":""},{"location":"docs/CHANGELOG/#feat_20","title":"Feat","text":"<ul> <li>drop AppVeyor and update with copier</li> <li>#67: initialize GH CI Action</li> </ul>"},{"location":"docs/CHANGELOG/#fix_49","title":"Fix","text":"<ul> <li>drop appveyor from cz version files</li> <li>attempt to resolve UnicodeError on Windows action</li> <li>address more minor CI errors</li> <li>make yamllint more relaxed</li> <li>attempt to resolve CI issues</li> <li>remove diff-quality check until fixed for CI</li> <li>always use Interactive when using /dev/null</li> <li>run push hook stage and format subproject</li> <li>support Python 3.7.12</li> <li>don\u2019t suppress nox missing interpreter errors</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_19","title":"Refactor","text":"<ul> <li>pre-commit can be run in one command</li> <li>resolve LGTM error</li> </ul>"},{"location":"docs/CHANGELOG/#0122-2022-02-21","title":"0.12.2 (2022-02-21)","text":""},{"location":"docs/CHANGELOG/#fix_50","title":"Fix","text":"<ul> <li>skip cassette files</li> </ul>"},{"location":"docs/CHANGELOG/#0121-2022-02-18","title":"0.12.1 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#fix_51","title":"Fix","text":"<ul> <li>always return 0 to complete format task</li> <li>use short paths when formatting Python code if available</li> </ul>"},{"location":"docs/CHANGELOG/#0120-2022-02-18","title":"0.12.0 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#feat_21","title":"Feat","text":"<ul> <li>initialize calcipy pre-commit hook</li> </ul>"},{"location":"docs/CHANGELOG/#0110-2022-02-18","title":"0.11.0 (2022-02-18)","text":""},{"location":"docs/CHANGELOG/#feat_22","title":"Feat","text":"<ul> <li>don\u2019t verify on cz_bump</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_20","title":"Refactor","text":"<ul> <li>format fixes</li> <li>reduce noise on matched vulnerabilities</li> <li>make run_cmd public</li> <li>remove jsonlint action</li> <li>use beartype typing</li> <li>move pre-commit hooks into doit</li> </ul>"},{"location":"docs/CHANGELOG/#0100-2022-01-19","title":"0.10.0 (2022-01-19)","text":""},{"location":"docs/CHANGELOG/#feat_23","title":"Feat","text":"<ul> <li>create Github release if gh CLI is installed</li> </ul>"},{"location":"docs/CHANGELOG/#091-2022-01-17","title":"0.9.1 (2022-01-17)","text":""},{"location":"docs/CHANGELOG/#fix_52","title":"Fix","text":"<ul> <li>correct code-tag-collector for CLI use</li> <li>use target file\u2019s directory for git info</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_21","title":"Refactor","text":"<ul> <li>drop template echo command</li> </ul>"},{"location":"docs/CHANGELOG/#090-2022-01-17","title":"0.9.0 (2022-01-17)","text":""},{"location":"docs/CHANGELOG/#feat_24","title":"Feat","text":"<ul> <li>show code tag summary as a table</li> <li>add date of last blame to code tag summary</li> <li>only link code tag from line number</li> <li>use revision-specific commit hashes</li> <li>add git links to code tag summary</li> <li>add python format pre-commit hook</li> <li>add support for TOML formatting with taplo</li> </ul>"},{"location":"docs/CHANGELOG/#fix_53","title":"Fix","text":"<ul> <li>handle \u201c0000..\u201d hash by using branch name</li> <li>handle non-git directories</li> <li>use correct line number for pinned hash</li> <li>handle git dependencies when checking stale packages</li> <li>use positional arguments for pre-commit commands</li> <li>correct syntax error in pre-commit command</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_22","title":"Refactor","text":"<ul> <li>make slow python pre-commit push-only</li> <li>apply auto-format tools to test project</li> </ul>"},{"location":"docs/CHANGELOG/#082-2022-01-16","title":"0.8.2 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#fix_54","title":"Fix","text":"<ul> <li>drop all references to CalVer</li> </ul>"},{"location":"docs/CHANGELOG/#081-2022-01-16","title":"0.8.1 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#refactor_23","title":"Refactor","text":"<ul> <li>drop tag_format and use semver-only</li> </ul>"},{"location":"docs/CHANGELOG/#080-2022-01-16","title":"0.8.0 (2022-01-16)","text":""},{"location":"docs/CHANGELOG/#feat_25","title":"Feat","text":"<ul> <li>add pip-check for prettier outdated</li> <li>add cct command</li> <li>initialize the cement CLI application</li> <li>replace toml with tomli (#74)</li> <li>move wily to nox to reduce version conflicts</li> <li>add pip-audit</li> <li>add attrs_strict</li> <li>trim trailing whitespace from doc output</li> </ul>"},{"location":"docs/CHANGELOG/#fix_55","title":"Fix","text":"<ul> <li>bump year to 2022</li> <li>code_tag_collector must return doit-compliant value (None)</li> <li>only run pre-commit once</li> <li>Code Tag Collector cannot return a Path for DoIt tasks</li> <li>cct was not being created as an alias. Use full command</li> <li>wily</li> <li>properly exclude auto-generated doc files from code tag collector</li> <li>run ptw on whole directory, not just test files</li> <li>drop FYI and NOTE from Code Tags</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_24","title":"Refactor","text":"<ul> <li>fix PY-W2000 by using all</li> <li>move file_search to top-level</li> <li>just run pre-commit install</li> <li>replace pass with \u2026 to keep it from being removed</li> </ul>"},{"location":"docs/CHANGELOG/#060rc2-2022-08-04","title":"0.6.0rc2 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_26","title":"Feat","text":"<ul> <li>drop pytest-cov and run coverage directly</li> </ul>"},{"location":"docs/CHANGELOG/#fix_56","title":"Fix","text":"<ul> <li>swap pytest-watch(er) and other version bumps</li> <li>pin min-version (xenon) &amp; drop preconvert and flake8-mock</li> </ul>"},{"location":"docs/CHANGELOG/#060rc1-2022-08-04","title":"0.6.0rc1 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#fix_57","title":"Fix","text":"<ul> <li>bug in noxfile and code tags reading doc output files</li> </ul>"},{"location":"docs/CHANGELOG/#060rc0-2022-08-04","title":"0.6.0rc0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_27","title":"Feat","text":"<ul> <li>implement pylint rules</li> <li>add xenon (wraps radon)</li> <li>condense doit output in show_cmd</li> <li>initial semgrep implementation</li> <li>add code diagrams to doc-site</li> <li>add notes on wily and pylint</li> <li>add vulture</li> <li>diff-quality (lint)</li> <li>add it</li> <li>add output if no stale packages found</li> <li>add autoflake</li> </ul>"},{"location":"docs/CHANGELOG/#fix_58","title":"Fix","text":"<ul> <li>try to fix issues found with pytest_cache_assert</li> <li>drop unused Python2 demjson</li> <li>error in noxfile with poetry install</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_25","title":"Refactor","text":"<ul> <li>decouple code tag collector from DG</li> <li>improve lint_py and the return type check is working</li> <li>zip release task</li> <li>cleanup a few minor errors</li> <li>use Interactive instead of Chrome</li> <li>apply fixes found from semgrep</li> <li>rename \u201cwrappers\u201d to \u201cdot_dict\u201d</li> <li>prevent mutation in DG.set_paths</li> </ul>"},{"location":"docs/CHANGELOG/#031rc0-2022-08-04","title":"0.3.1rc0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_28","title":"Feat","text":"<ul> <li>add task to zip artifacts from testing</li> <li>implement pandas.to_markdown for cov table</li> <li>#58: implement doc task and merge serve_docs</li> <li>make loading YAML files more generic</li> <li>create doit summary report</li> <li>add task to check license compliance</li> <li>move lock into doit tasks with file-dependency</li> <li>#38: re-implement coverage and write source</li> <li>drop subprocess-tee</li> <li>#36: WIP implementation of doc formatting</li> <li>implement publish tasks</li> <li>add pip outdated to stale check</li> <li>implement check for stale packages</li> <li>begin implementing stale package check</li> <li>smart default tasks for CI vs. local</li> <li>make nox imports optional</li> <li>try doit rather than CWD for initial path</li> <li>move noxfile into calcipy</li> <li>integrate nox to doit tasks</li> <li>WIP check for stale dep &amp; placeholder publish</li> <li>add additional configuration options</li> <li>add nox tasks</li> <li>add detect-secrets as pre-commit</li> <li>lint non-Python files</li> <li>read doc_dir from copier file</li> <li>make most settings configurable</li> <li>added dotted-dict wrapper of Box</li> <li>delete old files rather than full directory</li> <li>filter with glob-like ignore_patterns (2/2)</li> <li>add security check task</li> <li>add skip_phrase for code tag skipping</li> <li>beartype - roar!</li> <li>optionally clear log directory. Move file_helpers from base</li> <li>new tail-like reverse read_lines</li> <li>rename DIG to DG because doit is one word</li> <li>retrieve doc_dir from copier</li> <li>add log-setup fun for doit</li> <li>make (source) doc_dir configurable</li> <li>add sanitizer</li> <li>add pytype</li> <li>#36: start WIP ReadMeMachine</li> <li>#36: merge logic of markdown auto-formatters</li> <li>make code tag partially configurable</li> <li>move check_types into calcipy</li> <li>import templates from pdocs</li> </ul>"},{"location":"docs/CHANGELOG/#fix_59","title":"Fix","text":"<ul> <li>install full dev-dep as temporary nox workaround</li> <li>prevent committing changelog at base dir</li> <li>remove type_name from docstring for Google-style</li> <li>run pytest as a module for nox</li> <li>resolve doc_dir and style errors</li> <li>#58: remove None from pdocs output</li> <li>deconflict doit/nox</li> <li>repair failing test</li> <li>packaging needed keyword argument</li> <li>import and nox syntax errors</li> <li>run push pre-commit hooks with doit</li> <li>show log warning instead of error for stale dep</li> <li>improve output from check_stale</li> <li>errors caught in testing</li> <li>suppress beartype warnings for now</li> <li>drop logger middleware</li> <li>catch most calcipy section typos in toml</li> <li>remove check-secrets but keep snippets</li> <li>errors in ignore patterns</li> <li>import doit and expand nox test file</li> <li>skip tags must be at bottom</li> <li>reset Lint paths instead of extend</li> <li>use find_files for code tag summary</li> <li>don\u2019t manually add the package source dir</li> <li>lint typing and improve tests</li> <li>create separate file_search file to fix imports</li> <li>#51: replace glob with git-based file identification</li> <li>#53: Use Interact instead of LongRunning</li> <li>undo PEP585 for runtime beartype</li> <li>resolve file explosion from _find_files</li> <li>import the loguru Logger class safely</li> <li>additional problems found with mypy</li> <li>fix Doit Types and start beartype</li> <li>add no-verify to cl_bump</li> <li>correct isort configuration</li> <li>restore ReadMeMachine</li> <li>repair small bugs found in tests</li> <li>make transitions optional</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_26","title":"Refactor","text":"<ul> <li>see if only one space is okay for skipcq</li> <li>fix anti-pattern with nox session decorator and arg</li> <li>improve code quality</li> <li>try to suppress deepsource errors</li> <li>address DeepSource issues</li> <li>split up set_paths from DG</li> <li>fix formatting error from pre-push</li> <li>rename doc_dir to doc_sub_dir for clarity</li> <li>apply 0.0.10 template</li> <li>move markdown to subdirectory for mkdocs</li> <li>move isort back to toml</li> <li>fix edge case in diff-cov failing and lint errors</li> <li>relicense with MIT for better compliance</li> <li>create generic doit-runner for noxfile</li> <li>fix some type issues</li> <li>minor fixes from AppVeyor testing</li> <li>#38: reduce complexity</li> <li>minor cleanup to docs</li> <li>apply pre-commit autoformat</li> <li>auto-drop skipcq comment</li> <li>format with VSCode</li> <li>fix lint errors in YAML files</li> <li>move find file paths to DG.meta</li> <li>move if_found_unlink to file_helpers</li> <li>fix formatting with pre-commit</li> <li>fix attribute names for path types (1/2)</li> <li>use calcipy:skip-tags</li> <li>fix minor code tags</li> <li>move __temp_chdir and improve fix_dg</li> <li>narrow type ignore use</li> <li>use path_file of file_path</li> <li>apply auto-fixes from pre-commit</li> <li>replace all glob-search with find_files</li> <li>remove find_files from code_tag script</li> <li>update isort for trailing-comma</li> <li>move excluded lint rules to DG</li> <li>apply PEP585 and add pre-commit hook</li> <li>fix capitalization for doit (one word, all lowercase)</li> <li>improve activate_debug_logging</li> <li>try to replace Any with BaseAction</li> <li>apply 0.0.2 minor fixes</li> <li>apply 0.0.1 version of calcipy_template</li> <li>minor renaming for _MarkdownMachine</li> <li>fix lock file and line length</li> <li>run more pre-commit checks on commit</li> <li>standardize on code tags and cleanup</li> </ul>"},{"location":"docs/CHANGELOG/#perf_1","title":"Perf","text":"<ul> <li>combine autopep8 paths into single command</li> <li>combine files for linting in one command</li> </ul>"},{"location":"docs/CHANGELOG/#020a0-2022-08-04","title":"0.2.0a0 (2022-08-04)","text":""},{"location":"docs/CHANGELOG/#feat_29","title":"Feat","text":"<ul> <li>push tags with no pre-commit hooks on pre</li> <li>use Interactive instead of \u2014yes for cl_bump*</li> <li>remove tag create/remove tasks</li> <li>new task cl_bump_pre</li> <li>replace MIT license with Unlicense</li> <li>use cz_legacy to generate changelogs</li> <li>remove task in anticipation of copier #26</li> <li>improve git pre-commit hooks</li> <li>new add-trailing-comma and pyupgrade hooks</li> <li>new mkdocs tasks and improvements</li> <li>new optional preconvert to serialize logs</li> <li>move logger configuration to log_helpers</li> <li>new cl_bump task. Closes #21</li> </ul>"},{"location":"docs/CHANGELOG/#fix_60","title":"Fix","text":"<ul> <li>do not pass filenames to pre-commit</li> <li>#43: add year to version for pseudo-calver</li> <li>prevent legacy types for new commits</li> <li>prevent circular import in doit_tasks</li> <li>extras need to be defined as optional</li> <li>rollback hook changes as they are not working</li> <li>install hooks for push</li> <li>LongRunning passed tasks that should fail</li> <li>yesqa removed necessary noqa (H303, etc)</li> <li>incorrect output paths</li> <li>reduce false tags found (WIP). Fix #24</li> <li>regression in lint_project tasks</li> <li>unincremented version in toml</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_27","title":"Refactor","text":"<ul> <li>#22: restore MIT license</li> <li>copy+paste unmodified labels workflow</li> <li>update local TODO notes</li> <li>make toml an optional import</li> <li>rename path_source to path_project</li> <li>rename DIG_CWD as PATH_TEST_PROJECT</li> <li>rename test file</li> <li>doit is lowercase (CC looks like Dolt)</li> <li>replace sh with subprocess-tee</li> <li>reduce excess logging</li> <li>move DOIT_CONFIG to import</li> <li>move dig test to dig test file</li> </ul>"},{"location":"docs/CHANGELOG/#010-2020-12-19","title":"0.1.0 (2020-12-19)","text":""},{"location":"docs/CHANGELOG/#feat_30","title":"Feat","text":"<ul> <li>new write_cl task utilizing comittizen</li> <li>new task, pre_commit_hooks</li> </ul>"},{"location":"docs/CHANGELOG/#refactor_28","title":"Refactor","text":"<ul> <li>show STDOUT formatting in DoIt task</li> <li>remove archived code</li> </ul>"},{"location":"docs/CHANGELOG/#003-2020-12-10","title":"0.0.3 (2020-12-10)","text":""},{"location":"docs/CHANGELOG/#002-2020-11-14","title":"0.0.2 (2020-11-14)","text":""},{"location":"docs/CHANGELOG/#001-2020-11-14","title":"0.0.1 (2020-11-14)","text":""},{"location":"docs/CODE_TAG_SUMMARY/","title":"Collected Code Tags","text":"Type Comment Last Edit Source File TODO If no stale, write out five oldest? 2023-05-13 calcipy/check_for_stale_packages/_check_for_stale_packages.py:209 TODO Consider adding a configuration item for ignore_patterns 2023-02-19 calcipy/file_search.py:82 TODO Look into running tasks from within other tasks to support \u2018\u2013continue\u2019 and more readable logs \u2013&gt; 2023-02-19 docs/docs/MIGRATION.md:112 TODO Capture logging output and check\u2026 2023-02-19 tests/check_for_stale_packages/test_check_for_stale_packages.py:64 TODO Capture logging output and check\u2026 2023-02-19 tests/check_for_stale_packages/test_check_for_stale_packages.py:88 TODO Is there an easier way to maintain pytest parameter IDs? 2023-02-17 tests/tasks/test_test.py:14 PLANNED Convert to hypothesis test! 2023-02-19 tests/test_dot_dict.py:9 <p>Found code tags for TODO (6), PLANNED (1)</p>"},{"location":"docs/DEVELOPER_GUIDE/","title":"Developer Notes","text":""},{"location":"docs/DEVELOPER_GUIDE/#local-development","title":"Local Development","text":"<pre><code>git clone https://github.com/kyleking/calcipy.git\ncd calcipy\npoetry install --sync\npoetry run calcipy-pack pack.install-extras\n\n# See the available tasks\npoetry run calcipy\n# Or use a local 'run' file (so that 'calcipy' can be extended)\n./run\n\n# Run the default task list (lint, auto-format, test coverage, etc.)\n./run main\n\n# Make code changes and run specific tasks as needed:\n./run lint.fix test\n</code></pre>"},{"location":"docs/DEVELOPER_GUIDE/#publishing","title":"Publishing","text":"<p>For testing, create an account on TestPyPi. Replace <code>...</code> with the API token generated on TestPyPi or PyPi respectively</p> <pre><code>poetry config repositories.testpypi https://test.pypi.org/legacy/\npoetry config pypi-token.testpypi ...\n\n./run main pack.publish --to-test-pypi\n# If you didn't configure a token, you will need to provide your username and password to publish\n</code></pre> <p>To publish to the real PyPi</p> <pre><code>poetry config pypi-token.pypi ...\n./run release\n\n# Or for a pre-release\n./run release --suffix=rc\n</code></pre>"},{"location":"docs/DEVELOPER_GUIDE/#current-status","title":"Current Status","text":"File Statements Missing Excluded Coverage <code>calcipy/__init__.py</code> 17 0 17 100.0% <code>calcipy/can_skip.py</code> 17 1 0 89.3% <code>calcipy/check_for_stale_packages/__init__.py</code> 4 2 0 50.0% <code>calcipy/check_for_stale_packages/_check_for_stale_packages.py</code> 117 8 3 87.2% <code>calcipy/cli.py</code> 37 1 36 93.3% <code>calcipy/code_tag_collector/__init__.py</code> 4 2 0 50.0% <code>calcipy/code_tag_collector/_collector.py</code> 142 2 0 94.0% <code>calcipy/dot_dict/__init__.py</code> 4 2 0 50.0% <code>calcipy/dot_dict/_dot_dict.py</code> 8 0 0 100.0% <code>calcipy/experiments/__init__.py</code> 0 0 0 100.0% <code>calcipy/experiments/bump_programmatically.py</code> 24 16 0 33.3% <code>calcipy/experiments/check_duplicate_test_names.py</code> 36 0 2 95.0% <code>calcipy/file_search.py</code> 38 0 2 91.8% <code>calcipy/invoke_helpers.py</code> 30 2 0 81.8% <code>calcipy/md_writer/__init__.py</code> 4 2 0 50.0% <code>calcipy/md_writer/_writer.py</code> 95 6 0 88.9% <code>calcipy/noxfile/__init__.py</code> 4 2 0 50.0% <code>calcipy/noxfile/_noxfile.py</code> 48 2 32 83.8% <code>calcipy/scripts.py</code> 5 0 35 100.0% <code>calcipy/tasks/__init__.py</code> 0 0 0 100.0% <code>calcipy/tasks/_invoke.py</code> 37 0 45 97.7% <code>calcipy/tasks/all_tasks.py</code> 48 0 0 95.5% <code>calcipy/tasks/cl.py</code> 28 5 0 75.0% <code>calcipy/tasks/defaults.py</code> 20 0 0 89.3% <code>calcipy/tasks/doc.py</code> 45 0 8 90.5% <code>calcipy/tasks/executable_utils.py</code> 28 0 0 87.5% <code>calcipy/tasks/lint.py</code> 58 1 0 84.1% <code>calcipy/tasks/nox.py</code> 8 0 0 100.0% <code>calcipy/tasks/pack.py</code> 42 10 0 65.6% <code>calcipy/tasks/stale.py</code> 9 1 0 90.9% <code>calcipy/tasks/tags.py</code> 15 0 0 100.0% <code>calcipy/tasks/test.py</code> 45 1 2 89.2% <code>calcipy/tasks/types.py</code> 17 0 0 91.3% Totals 1034 66 182 87.3% <p>Generated on: 2023-11-08</p>"},{"location":"docs/MIGRATION/","title":"Migration Guide","text":""},{"location":"docs/MIGRATION/#calcipy-100","title":"<code>calcipy 1.0.0</code>","text":""},{"location":"docs/MIGRATION/#background","title":"Background","text":"<p>calcipy <code>v1</code> was a complete rewrite to switch from <code>doit</code> to <code>invoke</code>:</p> <ul> <li>with <code>invoke</code>, tasks can be run from anywhere without a <code>dodo.py</code> file</li> <li>tasks can be loaded lazily, which means that some performance gains are possible</li> <li>since there is no shared state file, tasks can be more easily run from pre-commit or generally in parallel</li> </ul> <p><code>doit</code> excelled at clearly delineated task output and run summary, but <code>invoke</code> isn\u2019t designed that way. I would like to improve the CLI output, but the benefits are worth this tradeoff.</p> <p>calcipy <code>v0</code> was built on doit and thus required a <code>dodo.py</code> file. I began adding <code>cement</code> to support a separate CLI for <code>calcipy</code> installed with <code>pipx</code>, but that required a lot of boilerplate code. With <code>doit</code>, the string command needed to be complete at task evaluation rather than runtime, so globbing files couldn\u2019t be resolved lazily.</p>"},{"location":"docs/MIGRATION/#migration","title":"Migration","text":"<p>While refactoring, the global configuration was mostly removed (<code>DoitGlobals</code>) along with a few tasks, but the main functionality is still present. Any project dependent on <code>calcipy</code> will need substantial changes. The easiest way to start migrating is to run <code>copier copy gh:KyleKing/calcipy_template .</code> for calcipy_template</p>"},{"location":"docs/MIGRATION/#speed-test","title":"Speed Test","text":"<p>It turns out that switching to <code>invoke</code> appears to have only saved 100ms</p> <pre><code>&gt; hyperfine -m 20 --warmup 5 \"poetry run python -c 'print(1)'\"\nBenchmark 1: poetry run python -c 'print(1)'\nTime (mean \u00b1 \u03c3):     377.9 ms \u00b1   3.1 ms    [User: 235.0 ms, System: 61.8 ms]\nRange (min \u2026 max):   372.7 ms \u2026 384.0 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 ./run\nBenchmark 1: ./run\nTime (mean \u00b1 \u03c3):     936.0 ms \u00b1  26.9 ms    [User: 1548.2 ms, System: 1687.7 ms]\nRange (min \u2026 max):   896.4 ms \u2026 1009.4 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 \"poetry run calcipy_tags\"\nBenchmark 1: poetry run calcipy_tags\nTime (mean \u00b1 \u03c3):     618.5 ms \u00b1  29.7 ms    [User: 1536.8 ms, System: 1066.2 ms]\nRange (min \u2026 max):   578.2 ms \u2026 694.9 ms    20 runs\n&gt; hyperfine -m 20 --warmup 5 \"poetry run doit list\"\nBenchmark 1: poetry run doit list\nTime (mean \u00b1 \u03c3):      1.002 s \u00b1  0.015 s    [User: 1.643 s, System: 1.682 s]\nRange (min \u2026 max):    0.974 s \u2026  1.023 s    20 runs\n</code></pre> <p>Additionally, the major decrease in dependencies will make install and update actions much faster. With the recommended extras installed, <code>calcipy-v1</code> has 124 dependencies (with all extras, 164) vs. <code>calcipy-v0</code>\u2019s 259. Counted with: <code>cat .calcipy_packaging.lock | jq 'keys' | wc -l</code></p>"},{"location":"docs/MIGRATION/#code-comparison","title":"Code Comparison","text":"<p>Accounting for code extracted to <code>corallium</code>, the overall number of lines decreased from 1772 to 1550 or only 12%, while increasing the CLI and <code>pre-commit</code> capabilities.</p> <pre><code>~/calcipy-v0 &gt; cloc calcipy\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                          26            942           1075           1772\n-------------------------------------------------------------------------------\nSUM:                            26            942           1075           1772\n-------------------------------------------------------------------------------\n~/calcipy &gt; cloc calcipy\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                          27            454            438           1185\n-------------------------------------------------------------------------------\nSUM:                            27            454            438           1185\n-------------------------------------------------------------------------------\n~/corallium &gt; cloc corallium\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                           7            176            149            365\n-------------------------------------------------------------------------------\nSUM:                             7            176            149            365\n-------------------------------------------------------------------------------\n\n~/calcipy &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nYAML                             2              0              0            580\nPython                          19            176             68            578\nJSON                             2              0              0             60\nMarkdown                         3              9             10              8\nText                             1              0              0              2\n-------------------------------------------------------------------------------\nSUM:                            27            185             78           1228\n-------------------------------------------------------------------------------\n~/calcipy-v0 &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nJSON                            30              0              0            762\nYAML                             2              0              0            580\nPython                          24            314            186            578\nMarkdown                         3              9             10              8\n-------------------------------------------------------------------------------\nSUM:                            59            323            196           1928\n-------------------------------------------------------------------------------\n~/corallium &gt; cloc tests\n-------------------------------------------------------------------------------\nLanguage                     files          blank        comment           code\n-------------------------------------------------------------------------------\nPython                           6             36             15             69\nMarkdown                         1              1              0              2\n-------------------------------------------------------------------------------\nSUM:                             7             37             15             71\n-------------------------------------------------------------------------------\n</code></pre>"},{"location":"docs/MIGRATION/#doit-output","title":"doit output","text":"<p>I would like to restore the <code>doit</code> task summary, but <code>invoke</code>\u2019s architecture doesn\u2019t really make this possible. The <code>--continue</code> option was extremely useful, but that also might not be achievable.</p> <pre><code>&gt; poetry run doit run\n.  format_recipes &gt; [\n        Python: function format_recipes\n]\n\n2023-02-19 10:40:23.954 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/breakfast\n2023-02-19 10:40:23.957 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/rice\n2023-02-19 10:40:23.959 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/meals\n2023-02-19 10:40:23.964 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/seafood\n2023-02-19 10:40:23.967 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/pizza\n2023-02-19 10:40:23.969 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/poultry\n2023-02-19 10:40:23.972 | INFO     | recipes.formatter:_write_toc:287 - Creating TOC for: ./recipes/docs/sushi\n.  collect_code_tags &gt; [\n        Python: function write_code_tag_file\n]\n\n.  cl_write &gt; [\n        Cmd: poetry run cz changelog\n        Python: function _move_cl\n]\n\n.  lock &gt; [\n        Cmd: poetry lock --no-update\n]\n\nResolving dependencies...\n.  nox_coverage &gt; [\n        Cmd: poetry run nox --error-on-missing-interpreters --session coverage\n]\n\n...\n\ndoit&gt; Summary:\ndoit&gt; format_recipes was successful\ndoit&gt; collect_code_tags was successful\ndoit&gt; cl_write was successful\ndoit&gt; lock was successful\ndoit&gt; nox_coverage was successful\ndoit&gt; auto_format was successful\ndoit&gt; document was successful\ndoit&gt; check_for_stale_packages was successful\ndoit&gt; pre_commit_hooks failed (red)\ndoit&gt; lint_project was not run\ndoit&gt; static_checks was not run\ndoit&gt; security_checks was not run\ndoit&gt; check_types was not run\n</code></pre>"},{"location":"docs/STYLE_GUIDE/","title":"Personal Style Guides","text":""},{"location":"docs/STYLE_GUIDE/#git","title":"Git","text":"<p>We use Commitizen to manage both an auto-generated Changelog and incrementing the release version following semver. For both of these automated outputs to work well, please follow the Conventional Commits style, which is described in more detail below.</p>"},{"location":"docs/STYLE_GUIDE/#commitizen-types-and-scopes","title":"Commitizen Types and Scopes","text":"<p><code>type(scope): description</code></p> <ul> <li>Types</li> <li>fix: A bug fix</li> <li>feat: A new feature</li> <li>docs: Documentation-only changes (code comments, separate docs)</li> <li>style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons)</li> <li>perf: A code change that improves performance</li> <li>refactor: A change to production code that is not a fix, feat, or perf</li> <li>test: Adding missing or correcting existing tests</li> <li>build: Changes that affect the build system or external dependencies</li> <li>ci: Changes to our CI configuration files and scripts</li> <li>A <code>!</code> can be used to indicate a breaking change (<code>refactor!: drop support for Node 6</code>)</li> <li>SemVer Rules<ul> <li>Based on commit type, the version will be auto-incremented: <code>fix : PATCH // feat : MINOR // BREAKING CHANGE : MAJOR</code></li> </ul> </li> <li>Scopes</li> <li>A Class, File name, Issue Number, other appropriate noun. As examples: <code>build(poetry): bump requests to v3</code> or <code>style(#32): add missing type annotations</code></li> <li>Tips</li> <li>What if a commit fits multiple types?<ul> <li>Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is the focus on more organized and intentional changes</li> </ul> </li> <li>Use <code>git rebase -i</code> to fix commit names prior to merging if incorrect types/scopes are used</li> </ul>"},{"location":"docs/STYLE_GUIDE/#git-description-guidelines","title":"Git Description Guidelines","text":"<ul> <li>Commit message guidelines</li> <li>Full sentence with verb (lowercase) and concise description. Below are modified examples for Conventional Commits<ul> <li><code>fix(roles): bug in admin role permissions</code></li> <li><code>feat(ui): implement new button design</code></li> <li><code>build(pip): upgrade package to remove vulnerabilities</code></li> <li><code>refactor: file structure to improve code readability</code></li> <li><code>perf(cli): rewrite methods</code></li> <li><code>feat(api): endpoints to implement new customer dashboard</code></li> </ul> </li> <li>How to write a good commit message</li> <li>A diff will tell you what changed, but only the commit message can properly tell you why.</li> <li>Keep in mind: This has all been said before.</li> <li>From the seven rules of a great Git commit message:<ul> <li> <ol> <li>Try for 50 characters, but consider 72 the hard limit</li> </ol> </li> <li> <ol> <li>Use the body to explain what and why vs. how</li> </ol> </li> </ul> </li> </ul>"},{"location":"docs/STYLE_GUIDE/#issue-labels-and-milestones","title":"Issue Labels and Milestones","text":"<p>Personal Guide</p> <ul> <li>For Issue Labels, see labels.yml</li> <li>Milestones</li> <li>Current Tasks: main milestone (name could change based on a specific project, sprint, or month)</li> <li>Next Tasks</li> <li>Blue Sky</li> </ul> Research <ul> <li>[Sane GitHub Labels](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63) and see [sensible-github-labels](https://github.com/Relequestual/sensible-github-labels) for full descriptions of each</li> <ul> <li>\u201cit is much more helpful to see the status and type of all issues at a glance.\u201d</li> <li>One of each:</li> <ul> <li>Status: \u2026</li> <ul><li>Abandoned, Accepted, Available, Blocked, Completed, In Progress, On Hold, Pending, Review Needed, Revision Needed</li></ul> <li>Type: \u2026</li> <ul><li>Bug, Maintenance, Question, Enhancement</li></ul> <li>Priority: \u2026</li> <ul><li>Critical, High, Medium, Low</li></ul> </ul> </ul> <li>[Britecharts](https://britecharts.github.io/britecharts/github-labels.html)</li> <ul> <li>Status: \u2026</li> <ul> <li>On Review \u2013 Request that we are pondering if including or not</li> <li>Needs Reproducing \u2013 For bugs that need to be reproduced in order to get fixed</li> <li>Needs Design \u2013 Feature that needs a design</li> <li>Ready to Go \u2013 Issue that has been defined and is ready to get started with</li> <li>In Progress \u2013 Issue that is being worked on right now.</li> <li>Completed \u2013 Finished feature or fix</li> </ul> <li>Type: \u2026</li> <ul> <li>Bug \u2013 An unexpected problem or unintended behavior</li> <li>Feature \u2013 A new feature request</li> <li>Maintenance \u2013 A regular maintenance chore or task, including refactors, build system, CI, performance improvements</li> <li>Documentation \u2013 A documentation improvement task</li> <li>Question \u2013 An issue or PR that needs more information or a user question</li> </ul> <li>Not Included</li> <ul> <li>Priority: They would add complexity and overhead due to the discussions, but could help with the roadmap</li> <li>Technology Labels: It can create too much overhead, as properly tag with technologies all the issues could be time consuming</li> </ul> </ul> </ul> <li>[Ian Bicking Blog](https://www.ianbicking.org/blog/2014/03/use-github-issues-to-organize-a-project.html)</li> <ul> <li>Milestone Overview</li> <ul> <li>What are we doing right now?</li> <li>What aren\u2019t we doing right now?</li> <ul> <li>2a. Stuff we\u2019ll probably do soon</li> <li>2b. Stuff we probably won\u2019t do soon</li> </ul> <li>What aren\u2019t we sure about?</li> </ul> <li>Milestone Descriptions</li> <ul> <li>Stuff we are doing right now: this is the \u201cmain\u201d milestone. We give it a name (like Alpha 2 or Strawberry Rhubarb Pie) and we write down what we are trying to accomplish with the milestone. We create a new milestone when we are ready for the next iteration.</li> <li>Stuff we\u2019ll probably do soon: this is a standing \u201c**Next Tasks**\u201d milestone. We never change or rename this milestone.</li> <ul><li>We use a permanent \u201cNext Tasks\u201d milestone (as opposed to renaming it to \u201cAlpha 3\u201d or actual-next-iteration milestone) because we don\u2019t want to presume or default to including something in the real next iteration. When we\u2019re ready to start planning the next iteration we\u2019ll create a new milestone, and only deliberately move things into that milestone.</li></ul> <li>Stuff we probably won\u2019t do soon: this is a standing \u201c**Blue Sky**\u201d milestone. We refer to these tickets and sometimes look through them, but they are easy to ignore, somewhat intentionally ignored.</li> <li>What aren\u2019t we sure about?: issues with no milestone.</li> </ul> <li>Label: \u201cNeeds Discussion\u201d - (addressed in a triage meeting) - use liberally for either big or small tickets</li> <li>\u201cIt\u2019s better to give people more power: it\u2019s actually helpful if people can overreach because it is an opportunity to establish where the limits really are and what purpose those limits have\u201d</li> </ul>"},{"location":"docs/STYLE_GUIDE/#external-links","title":"External Links","text":"<ul> <li>Git: The Simple Guide</li> <li>Commit Messages and why use the present tense</li> <li>GitHub\u2019s Advice on GitHub</li> <li>Most Comprehensive Guide</li> <li>Git Pro Book (free)</li> <li>Bash Tab-Completion Snippet</li> </ul>"},{"location":"docs/STYLE_GUIDE/#python","title":"Python","text":"<ul> <li>Python Style Guides</li> <li>https://gist.github.com/sloria/7001839</li> <li>http://www.nilunder.com/blog/2013/08/03/pythonic-sensibilities/</li> <li>https://innoq.github.io/cards42org_en/</li> <li>https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide</li> <li>https://www.python.org/doc/humor/</li> <li>https://docs.python-guide.org/writing/reading/</li> <li>https://realpython.com/python-refactoring/</li> </ul>"},{"location":"docs/STYLE_GUIDE/#adrs","title":"ADRs","text":"<ul> <li>ADR Approaches<ul> <li>https://infraeng.dev/tech-spec Template (And associated review) vs. https://infraeng.dev/decision-log/</li> <li>Y-Statements: abbreviated shorthand. Add this as a one-line decision option if a full ADR isn\u2019t needed (or when referencing an existing ADR) (https://scribe.rip/@docsoc/y-statements-10eb07b5a177)</li> <li>https://adr.github.io</li> <li>More formal implementation of ADRs (MADR) that this is based on. Template: https://github.com/adr/madr/blob/97fb8edec60b8dc70b8166ef62de34c4e26b46c0/template/adr-template.md</li> <li>https://github.com/ethereum/EIPs/blob/confluenceuser/EIPS/eip-5639.md</li> </ul> </li> <li>Examples<ul> <li>https://github.com/pawamoy/mkdocstrings/issues/28</li> <li>https://github.com/arachne-framework/architecture/blob/060a956277a5ad71df93da49fee52463408841af/adr-002-configuration.md</li> <li>https://github.com/arachne-framework/architecture/tree/060a956277a5ad71df93da49fee52463408841af</li> <li>https://github.com/ethereum/EIPs/blob/confluenceuser/EIPS/eip-1010.md</li> <li>https://docs-v1.prefect.io/core/pins/pin-01-introduce-pins.html</li> <li>https://peps.python.org/pep-0387/</li> <li>https://github.com/AICoE/aicoe-ci/blob/39de02af86a0d1f9dcd395fa88b858f1c6880411/docs/adr/0000-use-markdown-architectural-decision-records.md</li> <li>And many others!</li> </ul> </li> </ul> <p>&lt;\u2013 Links \u2013&gt;</p>"},{"location":"modules/calcipy/_code_diagrams/","title":"Code Diagrams","text":"<p>Auto-generated with <code>pylint-pyreverse</code></p>"},{"location":"modules/calcipy/_code_diagrams/#packages","title":"Packages","text":"<p>Full Size</p>"},{"location":"modules/calcipy/_code_diagrams/#classes","title":"Classes","text":"<p>Full Size</p>"},{"location":"reference/SUMMARY/","title":"SUMMARY","text":"<ul> <li>calcipy<ul> <li>can_skip</li> <li>check_for_stale_packages<ul> <li>_check_for_stale_packages</li> </ul> </li> <li>cli</li> <li>code_tag_collector<ul> <li>_collector</li> </ul> </li> <li>dot_dict<ul> <li>_dot_dict</li> </ul> </li> <li>experiments<ul> <li>bump_programmatically</li> <li>check_duplicate_test_names</li> </ul> </li> <li>file_search</li> <li>invoke_helpers</li> <li>md_writer<ul> <li>_writer</li> </ul> </li> <li>noxfile<ul> <li>_noxfile</li> </ul> </li> <li>scripts</li> <li>tasks<ul> <li>_invoke</li> <li>all_tasks</li> <li>cl</li> <li>defaults</li> <li>doc</li> <li>executable_utils</li> <li>lint</li> <li>nox</li> <li>pack</li> <li>stale</li> <li>tags</li> <li>test</li> <li>types</li> </ul> </li> </ul> </li> </ul>"},{"location":"reference/calcipy/","title":"calcipy","text":"<p>calcipy.</p>"},{"location":"reference/calcipy/#calcipy-functions","title":"Functions","text":""},{"location":"reference/calcipy/#calcipy.configure_runtime_type_checking_mode","title":"configure_runtime_type_checking_mode","text":"<pre><code>configure_runtime_type_checking_mode()\n</code></pre> <p>Optionally configure runtime type checking mode globally.</p> Source code in <code>calcipy/__init__.py</code> <pre><code>def configure_runtime_type_checking_mode() -&gt; None:  # pragma: no cover\n    \"\"\"Optionally configure runtime type checking mode globally.\"\"\"\n    rtc_mode = _RuntimeTypeCheckingModes.from_environment()\n\n    if rtc_mode is not _RuntimeTypeCheckingModes.OFF:\n        from beartype.roar import BeartypeClawDecorWarning  # noqa: PLC0415\n\n        beartype_this_package(conf=BeartypeConf(\n            warning_cls_on_decorator_exception=(\n                None if rtc_mode is _RuntimeTypeCheckingModes.ERROR else BeartypeClawDecorWarning\n            ),\n        ))\n</code></pre>"},{"location":"reference/calcipy/can_skip/","title":"can_skip","text":"<p>Support can-skip logic from Make.</p>"},{"location":"reference/calcipy/can_skip/#calcipy.can_skip-functions","title":"Functions","text":""},{"location":"reference/calcipy/can_skip/#calcipy.can_skip.can_skip","title":"can_skip","text":"<pre><code>can_skip(*, prerequisites, targets)\n</code></pre> <p>Generic make-style task skipping logic based on file <code>mtime</code>.</p> <p>Example use with Invoke, but can be used anywhere:</p> <pre><code>@task\ndef test(ctx: Context) -&gt; None:\n    if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):\n        return  # Exit early\n\n    ...  # Task code\n</code></pre> Source code in <code>calcipy/can_skip.py</code> <pre><code>@beartype\ndef can_skip(*, prerequisites: List[Path], targets: List[Path]) -&gt; bool:\n    \"\"\"Generic make-style task skipping logic based on file `mtime`.\n\n    Example use with Invoke, but can be used anywhere:\n\n    ```py\n    @task\n    def test(ctx: Context) -&gt; None:\n        if can_skip(prerequisites=[*Path('src').rglob('*.py')], targets=[Path('.coverage.xml')]):\n            return  # Exit early\n\n        ...  # Task code\n    ```\n\n    \"\"\"\n    if not (ts_prerequisites := [pth.stat().st_mtime for pth in prerequisites]):\n        raise ValueError('Required files do not exist', prerequisites)\n\n    ts_targets = [pth.stat().st_mtime for pth in targets]\n    if ts_targets and min(ts_targets) &gt; max(ts_prerequisites):\n        logger.warning('Skipping because targets are newer', targets=targets)\n        return True\n    return False\n</code></pre>"},{"location":"reference/calcipy/can_skip/#calcipy.can_skip.dont_skip","title":"dont_skip","text":"<pre><code>dont_skip(*, prerequisites, targets)\n</code></pre> <p>To use for testing with mock; always returns False.</p> Source code in <code>calcipy/can_skip.py</code> <pre><code>@beartype\ndef dont_skip(*, prerequisites: List[Path], targets: List[Path]) -&gt; bool:\n    \"\"\"To use for testing with mock; always returns False.\"\"\"\n    logger.debug('Mocking can_skip', prerequisites=prerequisites, targets=targets)\n    return False\n</code></pre>"},{"location":"reference/calcipy/cli/","title":"cli","text":"<p>Extend Invoke for Calcipy.</p>"},{"location":"reference/calcipy/cli/#calcipy.cli-classes","title":"Classes","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig","title":"CalcipyConfig","text":"<p>             Bases: <code>Config</code></p> <p>Opinionated Config with better defaults.</p> Source code in <code>calcipy/cli.py</code> <pre><code>class CalcipyConfig(Config):\n    \"\"\"Opinionated Config with better defaults.\"\"\"\n\n    @staticmethod\n    def global_defaults() -&gt; Dict:  # type: ignore[type-arg]  # pragma: no cover\n        \"\"\"Override the global defaults.\"\"\"\n        invoke_defaults = Config.global_defaults()\n        calcipy_defaults = {\n            'run': {\n                'echo': True,\n                'echo_format': '\\033[2;3;37mRunning: {command}\\033[0m',\n                'pty': use_pty(),\n            },\n        }\n        return merge_dicts(invoke_defaults, calcipy_defaults)\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig-functions","title":"Functions","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.CalcipyConfig.global_defaults","title":"global_defaults  <code>staticmethod</code>","text":"<pre><code>global_defaults()\n</code></pre> <p>Override the global defaults.</p> Source code in <code>calcipy/cli.py</code> <pre><code>@staticmethod\ndef global_defaults() -&gt; Dict:  # type: ignore[type-arg]  # pragma: no cover\n    \"\"\"Override the global defaults.\"\"\"\n    invoke_defaults = Config.global_defaults()\n    calcipy_defaults = {\n        'run': {\n            'echo': True,\n            'echo_format': '\\033[2;3;37mRunning: {command}\\033[0m',\n            'pty': use_pty(),\n        },\n    }\n    return merge_dicts(invoke_defaults, calcipy_defaults)\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli-functions","title":"Functions","text":""},{"location":"reference/calcipy/cli/#calcipy.cli.start_program","title":"start_program","text":"<pre><code>start_program(pkg_name, pkg_version, module=None, collection=None)\n</code></pre> <p>Run the customized Invoke Program.</p> <p>FYI: recommendation is to extend the <code>core_args</code> method, but this won\u2019t parse positional arguments: https://docs.pyinvoke.org/en/stable/concepts/library.html#modifying-core-parser-arguments</p> Source code in <code>calcipy/cli.py</code> <pre><code>@beartype\ndef start_program(  # noqa: CAC001\n    pkg_name: str,\n    pkg_version: str,\n    module: Optional[ModuleType] = None,\n    collection: Optional[Union[Collection, InvokeCollection]] = None,\n) -&gt; None:  # pragma: no cover\n    \"\"\"Run the customized Invoke Program.\n\n    FYI: recommendation is to extend the `core_args` method, but this won't parse positional arguments:\n    https://docs.pyinvoke.org/en/stable/concepts/library.html#modifying-core-parser-arguments\n\n    \"\"\"\n    # Manipulate 'sys.argv' to hide arguments that invoke can't parse\n    _gto = GlobalTaskOptions()\n    sys_argv: List[str] = sys.argv[:1]\n    last_argv = ''\n    for argv in sys.argv[1:]:\n        if not last_argv.startswith('-') and Path(argv).is_file():\n            _gto.file_args.append(Path(argv))\n        # Check for CLI flags\n        elif argv in {'-v', '-vv', '-vvv', '--verbose'}:\n            _gto.verbose = argv.count('v')\n        elif argv == '--keep-going':\n            _gto.keep_going = True\n        # Check for CLI arguments with values\n        elif last_argv == '--working-dir':\n            _gto.working_dir = Path(argv).resolve()\n        elif argv != '--working-dir':\n            sys_argv.append(argv)\n        last_argv = argv\n    _gto.file_args = [\n        _f if _f.is_absolute() else Path.cwd() / _f\n        for _f in _gto.file_args\n    ]\n    sys.argv = sys_argv\n\n    class _CalcipyConfig(CalcipyConfig):\n\n        gto: GlobalTaskOptions = _gto\n\n    if module and collection:\n        raise ValueError('Only one of collection or module can be specified')\n\n    _CalcipyProgram(\n        name=pkg_name,\n        version=pkg_version,\n        namespace=Collection.from_module(module) if module else collection,\n        config_class=_CalcipyConfig,\n    ).run()\n</code></pre>"},{"location":"reference/calcipy/cli/#calcipy.cli.task","title":"task","text":"<pre><code>task(*dec_args, **dec_kwargs)\n</code></pre> <p>Marks wrapped callable object as a valid Invoke task.</p> Source code in <code>calcipy/cli.py</code> <pre><code>def task(*dec_args: Any, **dec_kwargs: Any) -&gt; Callable:  # type: ignore[type-arg]\n    \"\"\"Marks wrapped callable object as a valid Invoke task.\"\"\"\n    def wrapper(func: Any) -&gt; Callable:  # type: ignore[type-arg]\n        # Attach arguments for Task\n        setattr(func, TASK_ARGS_ATTR, dec_args)\n        setattr(func, TASK_KWARGS_ATTR, dec_kwargs)\n        # Attach public attributes from invoke that are expected\n        func.help = dec_kwargs.pop('help', {})\n\n        def _with_kwargs(**extra_kwargs: Any) -&gt; Callable:  # type: ignore[type-arg] # nosem\n            \"\"\"Support building partial tasks.\"\"\"\n            if extra_kwargs:\n                # Set a unique name when 'extra_kwargs' was provided\n                # https://github.com/pyinvoke/invoke/blob/07b836f2663bb073a7bcef3d6c454e1dc6b867ae/invoke/tasks.py#L81-L104\n                encoded = b64encode(str(extra_kwargs).encode())\n                func.__name__ = f'{func.__name__}_{encoded.decode().rstrip(\"=\")}'\n\n            @wraps(func)  # nosem\n            def _with_kwargs_inner(*args: Any, **kwargs: Any) -&gt; Any:\n                return func(*args, **kwargs, **extra_kwargs)\n            return _with_kwargs_inner\n\n        func.with_kwargs = _with_kwargs\n\n        @wraps(func)  # nosem\n        def _inner(*args: Any, **kwargs: Any) -&gt; Any:\n            return func(*args, **kwargs)\n\n        return _inner\n\n    # Handle the case when the decorator is called without arguments\n    if (\n        len(dec_args) == 1\n        and callable(dec_args[0])\n        and not hasattr(dec_args[0], TASK_ARGS_ATTR)\n    ):\n        return wrapper(dec_args[0])\n\n    return wrapper\n</code></pre>"},{"location":"reference/calcipy/file_search/","title":"file_search","text":"<p>Find Files.</p>"},{"location":"reference/calcipy/file_search/#calcipy.file_search-functions","title":"Functions","text":""},{"location":"reference/calcipy/file_search/#calcipy.file_search.find_project_files","title":"find_project_files","text":"<pre><code>find_project_files(path_project, ignore_patterns)\n</code></pre> <p>Find project files in git version control.</p> <p>Note: uses the relative project directory and verifies that each file exists</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory</p> <p> TYPE: <code>Path</code> </p> <code>ignore_patterns</code> <p>glob ignore patterns</p> <p> TYPE: <code>List[str]</code> </p> RETURNS DESCRIPTION <code>List[Path]</code> <p>Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths</p> Source code in <code>calcipy/file_search.py</code> <pre><code>@beartype\ndef find_project_files(path_project: Path, ignore_patterns: List[str]) -&gt; List[Path]:\n    \"\"\"Find project files in git version control.\n\n    &gt; Note: uses the relative project directory and verifies that each file exists\n\n    Args:\n        path_project: Path to the project directory\n        ignore_patterns: glob ignore patterns\n\n    Returns:\n        Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths\n\n    \"\"\"\n    file_paths = []\n    rel_filepaths = _get_all_files(cwd=path_project)\n    filtered_rel_files = _filter_files(rel_filepaths=rel_filepaths, ignore_patterns=ignore_patterns)\n    for rel_file in filtered_rel_files:\n        path_file = path_project / rel_file\n        if path_file.is_file():\n            file_paths.append(path_file)\n        else:  # pragma: no cover\n            logger.warning('Could not find the specified file', path_file=path_file)\n    return file_paths\n</code></pre>"},{"location":"reference/calcipy/file_search/#calcipy.file_search.find_project_files_by_suffix","title":"find_project_files_by_suffix","text":"<pre><code>find_project_files_by_suffix(path_project, *, ignore_patterns=None)\n</code></pre> <p>Find project files in git version control.</p> <p>Note: uses the relative project directory and verifies that each file exists</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory</p> <p> TYPE: <code>Path</code> </p> <code>ignore_patterns</code> <p>glob ignore patterns</p> <p> TYPE: <code>Optional[List[str]]</code> DEFAULT: <code>None</code> </p> RETURNS DESCRIPTION <code>Dict[str, List[Path]]</code> <p>Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths</p> Source code in <code>calcipy/file_search.py</code> <pre><code>@beartype\ndef find_project_files_by_suffix(\n    path_project: Path, *, ignore_patterns: Optional[List[str]] = None,\n) -&gt; Dict[str, List[Path]]:\n    \"\"\"Find project files in git version control.\n\n    &gt; Note: uses the relative project directory and verifies that each file exists\n\n    Args:\n        path_project: Path to the project directory\n        ignore_patterns: glob ignore patterns\n\n    Returns:\n        Dict[str, List[Path]]: where keys are the suffix (without leading dot) and values the list of paths\n\n    \"\"\"\n    file_lookup: Dict[str, List[Path]] = defaultdict(list)\n    for path_file in find_project_files(path_project, ignore_patterns or []):\n        file_lookup[path_file.suffix.lstrip('.')].append(path_file)\n    return dict(file_lookup)\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/","title":"invoke_helpers","text":"<p>Invoke Helpers.</p>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers-functions","title":"Functions","text":""},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.get_doc_subdir","title":"get_doc_subdir","text":"<pre><code>get_doc_subdir(path_project=None)\n</code></pre> <p>Retrieve the documentation directory from the copier answer file.</p> PARAMETER  DESCRIPTION <code>path_project</code> <p>Path to the project directory with contains <code>.copier-answers.yml</code></p> <p> TYPE: <code>Optional[Path]</code> DEFAULT: <code>None</code> </p> RETURNS DESCRIPTION <code>Path</code> <p>to the source documentation directory</p> <p> TYPE: <code>Path</code> </p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@beartype\ndef get_doc_subdir(path_project: Optional[Path] = None) -&gt; Path:\n    \"\"\"Retrieve the documentation directory from the copier answer file.\n\n    Args:\n        path_project: Path to the project directory with contains `.copier-answers.yml`\n\n    Returns:\n        Path: to the source documentation directory\n\n    \"\"\"\n    path_copier = (path_project or get_project_path()) / COPIER_ANSWERS\n    doc_dir = read_yaml_file(path_copier).get('doc_dir', 'docs')\n    return path_copier.parent / doc_dir / 'docs'  # type: ignore[no-any-return]\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.get_project_path","title":"get_project_path  <code>cached</code>","text":"<pre><code>get_project_path()\n</code></pre> <p>Retrieve the <code>cwd</code>.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@lru_cache(maxsize=1)\ndef get_project_path() -&gt; Path:\n    \"\"\"Retrieve the `cwd`.\"\"\"\n    return Path.cwd()\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.run","title":"run","text":"<pre><code>run(ctx, *run_args, **run_kwargs)\n</code></pre> <p>Wrap invoke.run to run within the <code>working_dir</code>.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@beartype\ndef run(ctx: Context, *run_args: Any, **run_kwargs: Any) -&gt; Optional[Result]:\n    \"\"\"Wrap invoke.run to run within the `working_dir`.\"\"\"\n    working_dir = '.'\n    with suppress(AttributeError):\n        working_dir = ctx.config.gto.working_dir\n\n    with ctx.cd(working_dir):\n        return ctx.run(*run_args, **run_kwargs)\n</code></pre>"},{"location":"reference/calcipy/invoke_helpers/#calcipy.invoke_helpers.use_pty","title":"use_pty  <code>cached</code>","text":"<pre><code>use_pty()\n</code></pre> <p>Returns False on Windows and some CI environments.</p> Source code in <code>calcipy/invoke_helpers.py</code> <pre><code>@lru_cache(maxsize=1)\ndef use_pty() -&gt; bool:\n    \"\"\"Returns False on Windows and some CI environments.\"\"\"\n    if platform.system() == 'Windows':\n        return False\n    return not environ.get('GITHUB_ACTION')\n</code></pre>"},{"location":"reference/calcipy/scripts/","title":"scripts","text":"<p>Start the command line program.</p>"},{"location":"reference/calcipy/scripts/#calcipy.scripts-classes","title":"Classes","text":""},{"location":"reference/calcipy/scripts/#calcipy.scripts-functions","title":"Functions","text":""},{"location":"reference/calcipy/scripts/#calcipy.scripts.start","title":"start","text":"<pre><code>start()\n</code></pre> <p>Run the customized Invoke Program.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start() -&gt; None:  # pragma: no cover\n    \"\"\"Run the customized Invoke Program.\"\"\"\n    from .tasks import all_tasks  # noqa: PLC0415\n    start_program(__pkg_name__, __version__, all_tasks)\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_docs","title":"start_docs","text":"<pre><code>start_docs()\n</code></pre> <p>Run CLI with only the cl and doc namespaces.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_docs() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the cl and doc namespaces.\"\"\"\n    from .tasks import cl, doc  # noqa: PLC0415\n    _start_subset([cl, doc])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_lint","title":"start_lint","text":"<pre><code>start_lint()\n</code></pre> <p>Run CLI with only the lint namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_lint() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the lint namespace.\"\"\"\n    from .tasks import lint  # noqa: PLC0415\n    _start_subset([lint])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_pack","title":"start_pack","text":"<pre><code>start_pack()\n</code></pre> <p>Run CLI with only the pack namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_pack() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the pack namespace.\"\"\"\n    from .tasks import pack  # noqa: PLC0415\n    _start_subset([pack])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_tags","title":"start_tags","text":"<pre><code>start_tags()\n</code></pre> <p>Run CLI with only the tags namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_tags() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the tags namespace.\"\"\"\n    from .tasks import tags  # noqa: PLC0415\n    _start_subset([tags])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_test","title":"start_test","text":"<pre><code>start_test()\n</code></pre> <p>Run CLI with only the test namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_test() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the test namespace.\"\"\"\n    from .tasks import test  # noqa: PLC0415\n    _start_subset([test])\n</code></pre>"},{"location":"reference/calcipy/scripts/#calcipy.scripts.start_types","title":"start_types","text":"<pre><code>start_types()\n</code></pre> <p>Run CLI with only the types namespace.</p> Source code in <code>calcipy/scripts.py</code> <pre><code>def start_types() -&gt; None:  # pragma: no cover\n    \"\"\"Run CLI with only the types namespace.\"\"\"\n    from .tasks import types  # noqa: PLC0415\n    _start_subset([types])\n</code></pre>"},{"location":"reference/calcipy/check_for_stale_packages/","title":"check_for_stale_packages","text":""},{"location":"reference/calcipy/check_for_stale_packages/#calcipy.check_for_stale_packages-functions","title":"Functions","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/","title":"_check_for_stale_packages","text":"<p>Check for stale packages.</p>"},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages.CALCIPY_CACHE","title":"CALCIPY_CACHE  <code>module-attribute</code>","text":"<pre><code>CALCIPY_CACHE = Path('.calcipy_packaging.lock')\n</code></pre> <p>Path to the packaging lock file.</p>"},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages-functions","title":"Functions","text":""},{"location":"reference/calcipy/check_for_stale_packages/_check_for_stale_packages/#calcipy.check_for_stale_packages._check_for_stale_packages.check_for_stale_packages","title":"check_for_stale_packages","text":"<pre><code>check_for_stale_packages(*, stale_months, path_lock=LOCK, path_cache=CALCIPY_CACHE)\n</code></pre> <p>Read the cached packaging information.</p> PARAMETER  DESCRIPTION <code>stale_months</code> <p>cutoff in months for when a package might be stale enough to be a risk</p> <p> TYPE: <code>int</code> </p> Source code in <code>calcipy/check_for_stale_packages/_check_for_stale_packages.py</code> <pre><code>@beartype\ndef check_for_stale_packages(*, stale_months: int, path_lock: Path = LOCK, path_cache: Path = CALCIPY_CACHE) -&gt; bool:\n    \"\"\"Read the cached packaging information.\n\n    Args:\n        stale_months: cutoff in months for when a package might be stale enough to be a risk\n\n    \"\"\"\n    packages = _read_packages(path_lock)\n    cached_packages = _read_cache(path_cache)\n    if cached_packages and can_skip.can_skip(prerequisites=[path_lock], targets=[path_cache]):\n        packages = [*cached_packages.values()]\n    else:\n        packages = _collect_release_dates(packages, cached_packages)\n        _write_cache(packages, path_cache)\n    return _packages_are_stale(packages, stale_months=stale_months)\n</code></pre>"},{"location":"reference/calcipy/code_tag_collector/","title":"code_tag_collector","text":""},{"location":"reference/calcipy/code_tag_collector/#calcipy.code_tag_collector-functions","title":"Functions","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/","title":"_collector","text":"<p>Collect code tags and output for review in a single location.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.CODE_TAG_RE","title":"CODE_TAG_RE  <code>module-attribute</code>","text":"<pre><code>CODE_TAG_RE = '((^|\\\\s|\\\\(|\"|\\\\\\')(?P&lt;tag&gt;{tag})(:| -)([^\\\\r\\\\n]))(?P&lt;text&gt;.+)'\n</code></pre> <p>Default code tag regex with <code>tag</code> and <code>text</code> matching groups.</p> <p>Requires formatting with list of tags: <code>CODE_TAG_RE.format(tag='|'.join(tag_list))</code></p> <p>Commonly, the <code>tag_list</code> could be <code>COMMON_CODE_TAGS</code></p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.COMMON_CODE_TAGS","title":"COMMON_CODE_TAGS  <code>module-attribute</code>","text":"<pre><code>COMMON_CODE_TAGS = ['FIXME', 'TODO', 'PLANNED', 'HACK', 'REVIEW', 'TBD', 'DEBUG']\n</code></pre> <p>Most common code tags.</p> <p>FYI and NOTE are excluded to not be tracked in the Code Summary.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.SKIP_PHRASE","title":"SKIP_PHRASE  <code>module-attribute</code>","text":"<pre><code>SKIP_PHRASE = 'calcipy_skip_tags'\n</code></pre> <p>String that indicates the file should be excluded from the tag search.</p>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector-functions","title":"Functions","text":""},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.github_blame_url","title":"github_blame_url","text":"<pre><code>github_blame_url(clone_uri)\n</code></pre> <p>Format the blame URL.</p> PARAMETER  DESCRIPTION <code>clone_uri</code> <p>git remote URI</p> <p> TYPE: <code>str</code> </p> RETURNS DESCRIPTION <code>str</code> <p><code>repo_url</code></p> <p> TYPE: <code>str</code> </p> Source code in <code>calcipy/code_tag_collector/_collector.py</code> <pre><code>@beartype\ndef github_blame_url(clone_uri: str) -&gt; str:\n    \"\"\"Format the blame URL.\n\n    Args:\n        clone_uri: git remote URI\n\n    Returns:\n       str: `repo_url`\n\n    \"\"\"\n    # Could be ssh or http (with or without .git)\n    # &gt; git@github.com:KyleKing/calcipy.git\n    # &gt; https://github.com/KyleKing/calcipy.git\n    if matches := re.compile(_GITHUB_ORIGIN).match(clone_uri):\n        github_url = 'https://github.com/'\n        return f\"{github_url}{matches['owner']}/{matches['repository']}\"\n    return ''\n</code></pre>"},{"location":"reference/calcipy/code_tag_collector/_collector/#calcipy.code_tag_collector._collector.write_code_tag_file","title":"write_code_tag_file","text":"<pre><code>write_code_tag_file(\n    path_tag_summary, paths_source, base_dir, regex=\"\", tags=\"\", header=\"# Task Summary\\n\\nAuto-Generated by `calcipy`\"\n)\n</code></pre> <p>Create the code tag summary file.</p> PARAMETER  DESCRIPTION <code>path_tag_summary</code> <p>Path to the output file</p> <p> TYPE: <code>Path</code> </p> <code>paths_source</code> <p>list of source files to parse</p> <p> TYPE: <code>List[Path]</code> </p> <code>base_dir</code> <p>base directory relative to the searched files</p> <p> TYPE: <code>Path</code> </p> <code>regex</code> <p>compiled regular expression. Expected to have matching groups <code>(tag, text)</code>. Default is CODE_TAG_RE with tags from tag_order</p> <p> TYPE: <code>str</code> DEFAULT: <code>''</code> </p> <code>tags</code> <p>subset of all tags to include in the report and specified order. Default is COMMON_CODE_TAGS</p> <p> TYPE: <code>str</code> DEFAULT: <code>''</code> </p> <code>header</code> <p>header text</p> <p> TYPE: <code>str</code> DEFAULT: <code>'# Task Summary\\n\\nAuto-Generated by `calcipy`'</code> </p> Source code in <code>calcipy/code_tag_collector/_collector.py</code> <pre><code>@beartype\ndef write_code_tag_file(\n    path_tag_summary: Path,\n    paths_source: List[Path],\n    base_dir: Path,\n    regex: str = '',\n    tags: str = '',\n    header: str = '# Task Summary\\n\\nAuto-Generated by `calcipy`',\n) -&gt; None:\n    \"\"\"Create the code tag summary file.\n\n    Args:\n        path_tag_summary: Path to the output file\n        paths_source: list of source files to parse\n        base_dir: base directory relative to the searched files\n        regex: compiled regular expression. Expected to have matching groups `(tag, text)`.\n            Default is CODE_TAG_RE with tags from tag_order\n        tags: subset of all tags to include in the report and specified order. Default is COMMON_CODE_TAGS\n        header: header text\n\n    \"\"\"\n    tag_order = [_t.strip() for _t in tags.split(',') if _t] or COMMON_CODE_TAGS\n    matcher = (regex or CODE_TAG_RE).format(tag='|'.join(tag_order))\n\n    matches = _search_files(paths_source, re.compile(matcher))\n    if report := _format_report(\n        base_dir, matches, tag_order=tag_order,\n    ).strip():\n        path_tag_summary.write_text(f'{header}\\n\\n{report}\\n\\n&lt;!-- {SKIP_PHRASE} --&gt;\\n')\n        logger.text('Created Code Tag Summary', path_tag_summary=path_tag_summary)\n    elif path_tag_summary.is_file():\n        path_tag_summary.unlink()\n</code></pre>"},{"location":"reference/calcipy/dot_dict/","title":"dot_dict","text":""},{"location":"reference/calcipy/dot_dict/#calcipy.dot_dict-functions","title":"Functions","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/","title":"_dot_dict","text":"<p>Dotted dictionary for consistent interface.</p> <p>Consider moving to Corallium, but I don\u2019t have any uses for it yet.</p>"},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict.DdictType","title":"DdictType  <code>module-attribute</code>","text":"<pre><code>DdictType = Union[Dict[str, Any], Box]\n</code></pre> <p>Return type from <code>ddict()</code>.</p>"},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict-functions","title":"Functions","text":""},{"location":"reference/calcipy/dot_dict/_dot_dict/#calcipy.dot_dict._dot_dict.ddict","title":"ddict","text":"<pre><code>ddict(**kwargs)\n</code></pre> <p>Return a dotted dictionary that can also be accessed normally.</p> <ul> <li>Currently uses <code>python-box</code></li> <li>Could consider <code>cleverdict</code> which had updates as recently as 2022</li> <li>There are numerous other variations that haven\u2019t been updated since 2020, such as <code>munch</code>, <code>bunch</code>, <code>ddict</code></li> </ul> PARAMETER  DESCRIPTION <code>**kwargs</code> <p>keyword arguments formatted into dictionary</p> <p> TYPE: <code>Dict[str, Any]</code> DEFAULT: <code>{}</code> </p> RETURNS DESCRIPTION <code>DdictType</code> <p>dotted dictionary</p> <p> TYPE: <code>DdictType</code> </p> Source code in <code>calcipy/dot_dict/_dot_dict.py</code> <pre><code>@beartype\ndef ddict(**kwargs: Dict[str, Any]) -&gt; DdictType:\n    \"\"\"Return a dotted dictionary that can also be accessed normally.\n\n    - Currently uses `python-box`\n    - Could consider `cleverdict` which had updates as recently as 2022\n    - There are numerous other variations that haven't been updated since 2020, such as `munch`, `bunch`, `ddict`\n\n    Args:\n        **kwargs: keyword arguments formatted into dictionary\n\n    Returns:\n        DdictType: dotted dictionary\n\n    \"\"\"\n    return Box(kwargs)\n</code></pre>"},{"location":"reference/calcipy/experiments/","title":"experiments","text":""},{"location":"reference/calcipy/experiments/bump_programmatically/","title":"bump_programmatically","text":"<p>Experiment with bumping the git tag using <code>griffe</code>.</p>"},{"location":"reference/calcipy/experiments/bump_programmatically/#calcipy.experiments.bump_programmatically-functions","title":"Functions","text":""},{"location":"reference/calcipy/experiments/bump_programmatically/#calcipy.experiments.bump_programmatically.bump_tag","title":"bump_tag","text":"<pre><code>bump_tag(*, pkg_name, tag, tag_prefix)\n</code></pre> <p>Make a SemVer minor bump using <code>griffe</code> if there were any breaking changes.</p> <p>Major versions must be bumped manually</p> Source code in <code>calcipy/experiments/bump_programmatically.py</code> <pre><code>@beartype\ndef bump_tag(*, pkg_name: str, tag: str, tag_prefix: str) -&gt; str:\n    \"\"\"Make a SemVer minor bump using `griffe` if there were any breaking changes.\n\n    Major versions must be bumped manually\n\n    \"\"\"\n    previous = griffe.load_git(pkg_name, ref=tag)\n    current = griffe.load(pkg_name)\n\n    breakages = [*griffe.find_breaking_changes(previous, current)]\n    for breakage in breakages:\n        try:\n            logger.text(breakage._explain_oneline())  # noqa: SLF001\n        except BuiltinModuleError:  # noqa: PERF203\n            logger.warning(str(breakage))\n        except Exception:\n            logger.exception(str(breakage))\n\n    try:\n        ver = semver.Version.parse(tag.replace(tag_prefix, ''))\n    except ValueError:\n        logger.exception('Failed to parse tag', tag=tag)\n        return ''\n    new_ver = ver.bump_minor() if any(breakages) else ver.bump_patch()\n    return f'{tag_prefix}{new_ver}'\n</code></pre>"},{"location":"reference/calcipy/experiments/check_duplicate_test_names/","title":"check_duplicate_test_names","text":"<p>Experiment with checking for duplicate test names.</p>"},{"location":"reference/calcipy/experiments/check_duplicate_test_names/#calcipy.experiments.check_duplicate_test_names-functions","title":"Functions","text":""},{"location":"reference/calcipy/experiments/check_duplicate_test_names/#calcipy.experiments.check_duplicate_test_names.run","title":"run","text":"<pre><code>run(test_path)\n</code></pre> <p>Check for duplicates in the test suite.</p> <p>Inspired by: https://stackoverflow.com/a/67840804/3219667</p> Source code in <code>calcipy/experiments/check_duplicate_test_names.py</code> <pre><code>@beartype\ndef run(test_path: Path) -&gt; List[str]:  # noqa: C901,CAC001  # pylint: disable=too-complex\n    \"\"\"Check for duplicates in the test suite.\n\n    Inspired by: https://stackoverflow.com/a/67840804/3219667\n\n    \"\"\"\n    summary = set()\n    duplicates = []\n\n    for path_test in test_path.rglob('test_*.py'):  # pylint: disable=too-many-nested-blocks\n        logger.info(path_test.as_posix())\n        parsed_ast = ast.parse(path_test.read_text())\n\n        for node in parsed_ast.body:\n            if isinstance(node, ast.FunctionDef):\n                if node.name in summary and node.name.startswith('test_'):\n                    duplicates.append(node.name)\n                summary.add(node.name)\n                _show_info(node)\n            elif isinstance(node, ast.ClassDef):\n                logger.info('Class name', name=node.name)\n                for method in node.body:\n                    if isinstance(method, ast.FunctionDef):\n                        _show_info(method)\n\n        for node in ast.walk(parsed_ast):  # type: ignore[assignment]\n            if (\n                isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef))\n                and node.name not in summary\n            ):\n                logger.info('Found new function(s) through walking')\n                _show_info(node)\n                summary.add(node.name)\n\n    if duplicates:\n        logger.error('Found Duplicates', duplicates=duplicates)\n    return duplicates\n</code></pre>"},{"location":"reference/calcipy/md_writer/","title":"md_writer","text":""},{"location":"reference/calcipy/md_writer/#calcipy.md_writer-functions","title":"Functions","text":""},{"location":"reference/calcipy/md_writer/_writer/","title":"_writer","text":"<p>Markdown Machine.</p>"},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer.HandlerLookupT","title":"HandlerLookupT  <code>module-attribute</code>","text":"<pre><code>HandlerLookupT = Dict[str, Callable[[str, Path], List[str]]]\n</code></pre> <p>Handler Lookup.</p>"},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer-functions","title":"Functions","text":""},{"location":"reference/calcipy/md_writer/_writer/#calcipy.md_writer._writer.write_autoformatted_md_sections","title":"write_autoformatted_md_sections","text":"<pre><code>write_autoformatted_md_sections(handler_lookup=None, paths_md=None)\n</code></pre> <p>Populate the auto-formatted sections of markdown files with user-configured logic.</p> Source code in <code>calcipy/md_writer/_writer.py</code> <pre><code>@beartype\ndef write_autoformatted_md_sections(\n    handler_lookup: Optional[HandlerLookupT] = None,\n    paths_md: Optional[List[Path]] = None,\n) -&gt; None:\n    \"\"\"Populate the auto-formatted sections of markdown files with user-configured logic.\"\"\"\n    _lookup: HandlerLookupT = handler_lookup or {\n        'COVERAGE ': _handle_coverage,\n        'SOURCE_FILE=': _handle_source_file,\n    }\n\n    paths = paths_md or find_project_files_by_suffix(get_project_path()).get('md') or []\n    for path_md in paths:\n        logger.text_debug('Processing', path_md=path_md)\n        if md_lines := _ReplacementMachine().parse(read_lines(path_md), _lookup, path_md):\n            path_md.write_text('\\n'.join(md_lines) + '\\n', encoding='utf-8')\n</code></pre>"},{"location":"reference/calcipy/noxfile/","title":"noxfile","text":""},{"location":"reference/calcipy/noxfile/#calcipy.noxfile-functions","title":"Functions","text":""},{"location":"reference/calcipy/noxfile/_noxfile/","title":"_noxfile","text":"<p>nox-poetry configuration file.</p> <p>Useful snippets from docs</p> <pre><code>poetry run nox -l\npoetry run nox --list-sessions\n\npoetry run nox -s build_check-3.8 build_dist-3.8 tests-3.8\npoetry run nox --session tests-3.11\n\npoetry run nox --python 3.8\n\npoetry run nox -k \"not build_check and not build_dist\"\n</code></pre> <p>Useful nox snippets</p> <pre><code># Example conditionally skipping a session\nif not session.interactive:\n    session.skip('Cannot run detect-secrets audit in non-interactive shell')\n\n# Install pinned version\nsession.install('detect-secrets==1.0.3')\n\n# Example capturing STDOUT into a file (could do the same for stderr)\npath_stdout = Path('.stdout.txt').resolve()\nwith open(path_stdout, 'w') as out:\n    session.run(*shlex.split('echo Hello World!'), stdout=out)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile-functions","title":"Functions","text":""},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.build_check","title":"build_check","text":"<pre><code>build_check(session)\n</code></pre> <p>Check that the built output meets all checks.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_poetry_session(python=_get_pythons()[-1:], reuse_venv=True)\ndef build_check(session: NPSession) -&gt; None:  # pragma: no cover\n    \"\"\"Check that the built output meets all checks.\"\"\"\n    # Build sdist and fix return URI, which will have file://...#egg=calcipy\n    sdist_uri = session.poetry.build_package(distribution_format=DistributionFormat.SDIST)\n    path_sdist = Path(url2pathname(urlparse(sdist_uri).path))\n    logger.text_debug('Fixed sdist URI', sdist_uri=sdist_uri, path_sdist=path_sdist)\n    # Check with pyroma\n    session.install('pyroma&gt;=4.0', '--upgrade')\n    # required for \"poetry.core.masonry.api\" build backend\n    session.run('python', '-m', 'pip', 'install', 'poetry&gt;=1.3', stdout=True)\n    session.run('pyroma', '--file', path_sdist.as_posix(), '--min=9', stdout=True)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.build_dist","title":"build_dist","text":"<pre><code>build_dist(session)\n</code></pre> <p>Build and test the project files within a controlled environment for repeatability.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_session(python=_get_pythons()[-1:], reuse_venv=False)\ndef build_dist(session: Union[NoxSession, NPSession]) -&gt; None:  # pragma: no cover\n    \"\"\"Build and test the project files within a controlled environment for repeatability.\"\"\"\n    dist_path = Path('dist')\n    if_found_unlink(dist_path)\n\n    # Support 'corallium' by re-implementing \"session.poetry.build_package()\", from:\n    # https://github.com/cjolowicz/nox-poetry/blob/5772b66ebff8d5a3351a08ed402d3d31e48be5f8/src/nox_poetry/sessions.py#L233-L255\n    # https://github.com/cjolowicz/nox-poetry/blob/5772b66ebff8d5a3351a08ed402d3d31e48be5f8/src/nox_poetry/poetry.py#L111-L154\n    output = session.run(*shlex.split('poetry build --format=wheel --no-ansi'),\n                         external=True, silent=True, stderr=None)\n    output = cast(str, output)\n    wheel = dist_path / output.split()[-1]\n    path_wheel = wheel.resolve().as_uri()\n\n    logger.text('Created wheel', path_wheel=path_wheel)\n    # Install the wheel and check that imports without any of the optional dependencies\n    session.install(path_wheel)\n    session.run(*shlex.split('python scripts/check_imports.py'), stdout=True)\n</code></pre>"},{"location":"reference/calcipy/noxfile/_noxfile/#calcipy.noxfile._noxfile.tests","title":"tests","text":"<pre><code>tests(session)\n</code></pre> <p>Run doit test task for specified python versions.</p> Source code in <code>calcipy/noxfile/_noxfile.py</code> <pre><code>@nox_session(python=_get_pythons(), reuse_venv=True)\ndef tests(session: Union[NoxSession, NPSession]) -&gt; None:  # pragma: no cover\n    \"\"\"Run doit test task for specified python versions.\"\"\"\n    _install_local(session, ['ddict', 'doc', 'lint', 'nox', 'stale', 'tags', 'test'])\n    session.run(*shlex.split('pytest ./tests'), stdout=True, env={'RUNTIME_TYPE_CHECKING_MODE': 'WARNING'})\n</code></pre>"},{"location":"reference/calcipy/tasks/","title":"tasks","text":""},{"location":"reference/calcipy/tasks/_invoke/","title":"_invoke","text":"<p>Extend Invoke for Calcipy.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection","title":"Collection","text":"<p>             Bases: <code>Collection</code></p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>class Collection(InvokeCollection):\n\n    @classmethod\n    def from_module(\n        cls,\n        module: ModuleType,\n        name: Optional[str] = None,\n        config: Optional[Dict[str, Any]] = None,\n        loaded_from: Optional[str] = None,\n        auto_dash_names: Optional[bool] = None,\n    ) -&gt; 'InvokeCollection':\n        \"\"\"Extend search for a namespace, Task, or deferred task.\"\"\"\n        collection = super().from_module(\n            module=module,\n            name=name,\n            config=config,\n            loaded_from=loaded_from,\n            auto_dash_names=auto_dash_names,\n        )\n\n        # If tasks were not loaded from a namespace or otherwise found\n        if not collection.task_names:\n            # Look for any decorated, but deferred \"Tasks\"\n            for task in (fxn for fxn in vars(module).values() if hasattr(fxn, TASK_ARGS_ATTR)):\n                collection.add_task(task)\n\n        return collection\n\n    def add_task(\n        self,\n        task: DeferedTask,\n        name: Optional[str] = None,\n        aliases: Optional[Tuple[str, ...]] = None,\n        default: Optional[bool] = None,\n    ) -&gt; None:\n        \"\"\"Extend for deferred tasks.\"\"\"\n        super().add_task(task=_build_task(task), name=name, aliases=aliases, default=default)\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection.add_task","title":"add_task","text":"<pre><code>add_task(task, name=None, aliases=None, default=None)\n</code></pre> <p>Extend for deferred tasks.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>def add_task(\n    self,\n    task: DeferedTask,\n    name: Optional[str] = None,\n    aliases: Optional[Tuple[str, ...]] = None,\n    default: Optional[bool] = None,\n) -&gt; None:\n    \"\"\"Extend for deferred tasks.\"\"\"\n    super().add_task(task=_build_task(task), name=name, aliases=aliases, default=default)\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.Collection.from_module","title":"from_module  <code>classmethod</code>","text":"<pre><code>from_module(module, name=None, config=None, loaded_from=None, auto_dash_names=None)\n</code></pre> <p>Extend search for a namespace, Task, or deferred task.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>@classmethod\ndef from_module(\n    cls,\n    module: ModuleType,\n    name: Optional[str] = None,\n    config: Optional[Dict[str, Any]] = None,\n    loaded_from: Optional[str] = None,\n    auto_dash_names: Optional[bool] = None,\n) -&gt; 'InvokeCollection':\n    \"\"\"Extend search for a namespace, Task, or deferred task.\"\"\"\n    collection = super().from_module(\n        module=module,\n        name=name,\n        config=config,\n        loaded_from=loaded_from,\n        auto_dash_names=auto_dash_names,\n    )\n\n    # If tasks were not loaded from a namespace or otherwise found\n    if not collection.task_names:\n        # Look for any decorated, but deferred \"Tasks\"\n        for task in (fxn for fxn in vars(module).values() if hasattr(fxn, TASK_ARGS_ATTR)):\n            collection.add_task(task)\n\n    return collection\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions","title":"GlobalTaskOptions","text":"<p>             Bases: <code>BaseModel</code></p> <p>Global Task Options.</p> Source code in <code>calcipy/tasks/_invoke.py</code> <pre><code>class GlobalTaskOptions(BaseModel):\n    \"\"\"Global Task Options.\"\"\"\n\n    working_dir: Path = Field(default_factory=Path.cwd)\n    \"\"\"Working directory for the program to use globally.\"\"\"\n\n    file_args: List[Path] = Field(default_factory=list)\n    \"\"\"List of Paths to modify.\"\"\"\n\n    verbose: PositiveInt = Field(default=0, le=3)\n    \"\"\"Verbosity level.\"\"\"\n\n    keep_going: bool = False\n    \"\"\"Continue task execution regardless of failure.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.file_args","title":"file_args  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>file_args = Field(default_factory=list)\n</code></pre> <p>List of Paths to modify.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.keep_going","title":"keep_going  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>keep_going = False\n</code></pre> <p>Continue task execution regardless of failure.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.verbose","title":"verbose  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>verbose = Field(default=0, le=3)\n</code></pre> <p>Verbosity level.</p>"},{"location":"reference/calcipy/tasks/_invoke/#calcipy.tasks._invoke.GlobalTaskOptions.working_dir","title":"working_dir  <code>class-attribute</code> <code>instance-attribute</code>","text":"<pre><code>working_dir = Field(default_factory=Path.cwd)\n</code></pre> <p>Working directory for the program to use globally.</p>"},{"location":"reference/calcipy/tasks/all_tasks/","title":"all_tasks","text":"<p>Tasks can be imported piecemeal or imported in their entirety from here.</p>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.TaskList","title":"TaskList  <code>module-attribute</code>","text":"<pre><code>TaskList = List[Union[Call, DeferedTask]]\n</code></pre> <p>List of wrapped or normal task functions.</p>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.main","title":"main","text":"<pre><code>main(_ctx)\n</code></pre> <p>Main task pipeline.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(post=with_progress(_MAIN_TASKS))\ndef main(_ctx: Context) -&gt; None:\n    \"\"\"Main task pipeline.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.other","title":"other","text":"<pre><code>other(_ctx)\n</code></pre> <p>Run tasks that are otherwise not exercised in main.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(post=with_progress(_OTHER_TASKS))  # pyright: ignore[reportGeneralTypeIssues]\ndef other(_ctx: Context) -&gt; None:\n    \"\"\"Run tasks that are otherwise not exercised in main.\"\"\"\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.progress","title":"progress","text":"<pre><code>progress(_ctx, *, index, total)\n</code></pre> <p>Progress Task.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help={\n        'index': 'Current index (0-indexed)',\n        'total': 'Total steps',\n    },\n    show_task_info=False,\n)\ndef progress(_ctx: Context, *, index: int, total: int) -&gt; None:\n    \"\"\"Progress Task.\"\"\"\n    logger.text('Progress', is_header=True, index=index + 1, total=total)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.release","title":"release","text":"<pre><code>release(ctx, *, suffix=None)\n</code></pre> <p>Release pipeline.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help=cl.bump.help,\n    post=with_progress(\n        [  # pyright: ignore[reportGeneralTypeIssues]\n            pack.lock,\n            doc.build,\n            doc.deploy,\n            pack.publish,\n        ],\n        offset=1,\n    ),\n)\ndef release(ctx: Context, *, suffix: cl.SuffixT = None) -&gt; None:\n    \"\"\"Release pipeline.\"\"\"\n    cl.bumpz(ctx, suffix=suffix)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.summary","title":"summary","text":"<pre><code>summary(_ctx, *, message)\n</code></pre> <p>Summary Task.</p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@task(\n    help={\n        'message': 'String message to display',\n    },\n    show_task_info=False,\n)\ndef summary(_ctx: Context, *, message: str) -&gt; None:\n    \"\"\"Summary Task.\"\"\"\n    logger.text(message, is_header=True)\n</code></pre>"},{"location":"reference/calcipy/tasks/all_tasks/#calcipy.tasks.all_tasks.with_progress","title":"with_progress","text":"<pre><code>with_progress(items, offset=0)\n</code></pre> <p>Inject intermediary \u2018progress\u2019 tasks.</p> PARAMETER  DESCRIPTION <code>items</code> <p>list of tasks</p> <p> TYPE: <code>Any</code> </p> <code>offset</code> <p>Optional offset to shift counters</p> <p> TYPE: <code>int</code> DEFAULT: <code>0</code> </p> Source code in <code>calcipy/tasks/all_tasks.py</code> <pre><code>@beartype\ndef with_progress(items: Any, offset: int = 0) -&gt; TaskList:\n    \"\"\"Inject intermediary 'progress' tasks.\n\n    Args:\n        items: list of tasks\n        offset: Optional offset to shift counters\n\n    \"\"\"\n    task_items = [_build_task(_t) for _t in items]\n    message = 'Running tasks: ' + ', '.join([str(_t.__name__) for _t in task_items])\n    tasks: TaskList = [summary.with_kwargs(message=message)]\n\n    total = len(task_items) + offset\n    for idx, item in enumerate(task_items):\n        tasks += [progress.with_kwargs(index=idx + offset, total=total), item]\n    return tasks\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/","title":"cl","text":"<p>Changelog CLI.</p>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl-attributes","title":"Attributes","text":""},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.SuffixT","title":"SuffixT  <code>module-attribute</code>","text":"<pre><code>SuffixT = Optional[Literal['alpha', 'beta', 'rc']]\n</code></pre> <p>Prerelease Suffix Type.</p>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.bump","title":"bump","text":"<pre><code>bump(ctx, *, suffix=None)\n</code></pre> <p>Bumps project version based on commits &amp; settings in pyproject.toml.</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@task(\n    pre=[write],\n    help={\n        'suffix': 'Specify prerelease suffix for version bump (alpha, beta, rc)',\n    },\n)\ndef bump(ctx: Context, *, suffix: SuffixT = None) -&gt; None:\n    \"\"\"Bumps project version based on commits &amp; settings in pyproject.toml.\"\"\"\n    bumpz(ctx, suffix=suffix)\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.bumpz","title":"bumpz","text":"<pre><code>bumpz(ctx, *, suffix=None)\n</code></pre> <p>Bumps project version based on commits &amp; settings in pyproject.toml.</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@beartype\ndef bumpz(ctx: Context, *, suffix: SuffixT = None) -&gt; None:\n    \"\"\"Bumps project version based on commits &amp; settings in pyproject.toml.\"\"\"\n    check_installed(ctx, executable='gh', message=GH_MESSAGE)\n\n    opt_cz_args = f' --prerelease={suffix}' if suffix else ''\n    run(ctx, f'{python_dir()}/cz bump{opt_cz_args} --annotated-tag --no-verify --gpg-sign')\n\n    run(ctx, 'git push origin --tags --no-verify')\n\n    get_last_tag = 'git tag --list --sort=-creatordate | head -n 1'\n    opt_gh_args = ' --prerelease' if suffix else ''\n    run(ctx, f'gh release create --generate-notes $({get_last_tag}){opt_gh_args}')\n</code></pre>"},{"location":"reference/calcipy/tasks/cl/#calcipy.tasks.cl.write","title":"write","text":"<pre><code>write(ctx)\n</code></pre> <p>Write a Changelog file with the raw Git history.</p> <p>Resources:</p> <ul> <li>https://keepachangelog.com/en/1.0.0/</li> <li>https://www.conventionalcommits.org/en/v1.0.0/</li> <li>https://writingfordevelopers.substack.com/p/how-to-write-a-commit-message</li> <li>https://chris.beams.io/posts/git-commit/</li> <li>https://semver.org/</li> <li>https://calver.org/</li> </ul> RETURNS DESCRIPTION <code>None</code> <p>List[DoitAction]: doit actions</p> Source code in <code>calcipy/tasks/cl.py</code> <pre><code>@task()\ndef write(ctx: Context) -&gt; None:\n    \"\"\"Write a Changelog file with the raw Git history.\n\n    Resources:\n\n    - https://keepachangelog.com/en/1.0.0/\n    - https://www.conventionalcommits.org/en/v1.0.0/\n    - https://writingfordevelopers.substack.com/p/how-to-write-a-commit-message\n    - https://chris.beams.io/posts/git-commit/\n    - https://semver.org/\n    - https://calver.org/\n\n    Returns:\n        List[DoitAction]: doit actions\n\n    \"\"\"\n    run(ctx, f'{python_dir()}/cz changelog')\n    path_cl = get_project_path() / 'CHANGELOG.md'\n    if not path_cl.is_file():\n        msg = f'Could not locate the changelog at: {path_cl}'\n        raise FileNotFoundError(msg)\n    path_cl.replace(get_doc_subdir() / path_cl.name)\n</code></pre>"},{"location":"reference/calcipy/tasks/defaults/","title":"defaults","text":"<p>Calcipy-Invoke Defaults.</p>"},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults-classes","title":"Classes","text":""},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults.from_ctx","title":"from_ctx","text":"<pre><code>from_ctx(ctx, group, key)\n</code></pre> <p>Safely extract the value from the context or the defaults.</p> <p>Instead of <code>ctx.tests.out_dir</code> use <code>from_ctx(ctx, 'test', 'out_dir')</code></p> Source code in <code>calcipy/tasks/defaults.py</code> <pre><code>@beartype\ndef from_ctx(ctx: Context, group: str, key: str) -&gt; str:\n    \"\"\"Safely extract the value from the context or the defaults.\n\n    Instead of `ctx.tests.out_dir` use `from_ctx(ctx, 'test', 'out_dir')`\n\n    \"\"\"\n    with suppress(KeyError):\n        return str(ctx.config[group][key])\n    return str(DEFAULTS[group][key])\n</code></pre>"},{"location":"reference/calcipy/tasks/defaults/#calcipy.tasks.defaults.new_collection","title":"new_collection","text":"<pre><code>new_collection()\n</code></pre> <p>Initialize a collection with the combination of merged and project-specific defaults.</p> Source code in <code>calcipy/tasks/defaults.py</code> <pre><code>@beartype\ndef new_collection() -&gt; Collection:\n    \"\"\"Initialize a collection with the combination of merged and project-specific defaults.\"\"\"\n    ns = Collection('')\n\n    # Merge default and user configuration\n    ns.configure(DEFAULTS)\n    config_path = Path('.calcipy.json')\n    if config_path.is_file():\n        ns.configure(json.loads(config_path.read_text(encoding='utf-8')))\n\n    return ns\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/","title":"doc","text":"<p>Document CLI.</p>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.build","title":"build","text":"<pre><code>build(ctx)\n</code></pre> <p>Build documentation with mkdocs.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef build(ctx: Context) -&gt; None:\n    \"\"\"Build documentation with mkdocs.\"\"\"\n    auto_doc_path = get_doc_subdir().parent / 'modules'\n    write_autoformatted_md_sections()\n    delete_dir(auto_doc_path)\n    _diagram_task(ctx, auto_doc_path)\n\n    # Find and trim trailing whitespace\n    for path_md in auto_doc_path.rglob('*.md'):\n        trim_trailing_whitespace(path_md)\n\n    run(ctx, f'{python_dir()}/mkdocs build --site-dir {get_out_dir()}')\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.deploy","title":"deploy","text":"<pre><code>deploy(ctx)\n</code></pre> <p>Deploy docs to the Github <code>gh-pages</code> branch.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef deploy(ctx: Context) -&gt; None:\n    \"\"\"Deploy docs to the Github `gh-pages` branch.\"\"\"\n    if _is_mkdocs_local():  # pragma: no cover\n        raise NotImplementedError('Not yet configured to deploy documentation without \"use_directory_urls\"')\n\n    with suppress(UnexpectedExit):\n        run(ctx, 'pre-commit uninstall')  # To prevent pre-commit failures when mkdocs calls push\n    run(ctx, f'{python_dir()}/mkdocs gh-deploy --force')\n    with suppress(UnexpectedExit):\n        run(ctx, 'pre-commit install')  # Restore pre-commit\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.get_out_dir","title":"get_out_dir","text":"<pre><code>get_out_dir()\n</code></pre> <p>Retrieve the mkdocs-specified site directory.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@beartype\ndef get_out_dir() -&gt; Path:\n    \"\"\"Retrieve the mkdocs-specified site directory.\"\"\"\n    mkdocs_config = read_yaml_file(get_project_path() / MKDOCS_CONFIG)\n    return Path(mkdocs_config.get('site_dir', 'releases/site'))\n</code></pre>"},{"location":"reference/calcipy/tasks/doc/#calcipy.tasks.doc.watch","title":"watch","text":"<pre><code>watch(ctx)\n</code></pre> <p>Serve local documentation for local editing.</p> Source code in <code>calcipy/tasks/doc.py</code> <pre><code>@task()\ndef watch(ctx: Context) -&gt; None:\n    \"\"\"Serve local documentation for local editing.\"\"\"\n    if _is_mkdocs_local():  # pragma: no cover\n        path_doc_index = get_out_dir() / 'index.html'\n        open_in_browser(path_doc_index)\n    else:  # pragma: no cover\n        webbrowser.open('http://localhost:8000')\n        run(ctx, f'{python_dir()}/mkdocs serve --dirtyreload')\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/","title":"executable_utils","text":"<p>Utilities for working in calcipy\u2019s python environment.</p>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.check_installed","title":"check_installed","text":"<pre><code>check_installed(ctx, executable, message)\n</code></pre> <p>If the required executable isn\u2019t present, raise a clear user error.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@beartype\ndef check_installed(ctx: Context, executable: str, message: str) -&gt; None:\n    \"\"\"If the required executable isn't present, raise a clear user error.\"\"\"\n    res = run(ctx, f'which {executable}', warn=True, hide=True)\n    if not res or res.exited == 1:\n        raise RuntimeError(message)\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.python_dir","title":"python_dir  <code>cached</code>","text":"<pre><code>python_dir()\n</code></pre> <p>Runs an executable from the currently active Python directory.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef python_dir() -&gt; str:\n    \"\"\"Runs an executable from the currently active Python directory.\"\"\"\n    return str(resolve_python().parent)\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.python_m","title":"python_m  <code>cached</code>","text":"<pre><code>python_m()\n</code></pre> <p>Return the active python path and <code>-m</code> flag.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef python_m() -&gt; str:\n    \"\"\"Return the active python path and `-m` flag.\"\"\"\n    return f'{resolve_python()} -m'\n</code></pre>"},{"location":"reference/calcipy/tasks/executable_utils/#calcipy.tasks.executable_utils.resolve_python","title":"resolve_python  <code>cached</code>","text":"<pre><code>resolve_python()\n</code></pre> <p>Resolve the user\u2019s Python path based on <code>sys</code>.</p> Source code in <code>calcipy/tasks/executable_utils.py</code> <pre><code>@lru_cache(maxsize=1)\ndef resolve_python() -&gt; Path:\n    \"\"\"Resolve the user's Python path based on `sys`.\"\"\"\n    python_path = Path(sys.executable)\n    with suppress(ValueError):\n        return python_path.relative_to(Path.cwd())\n    return python_path\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/","title":"lint","text":"<p>Lint CLI.</p>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.autopep8","title":"autopep8","text":"<pre><code>autopep8(ctx)\n</code></pre> <p>Run autopep8.</p> <p>FYI: This is temporary until ruff implements white space rules https://github.com/charliermarsh/ruff/issues/970</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef autopep8(ctx: Context) -&gt; None:\n    \"\"\"Run autopep8.\n\n    FYI: This is temporary until ruff implements white space rules\n    https://github.com/charliermarsh/ruff/issues/970\n\n    \"\"\"\n    cli_args = '--aggressive --recursive --in-place --max-line-length=120'\n    _inner_task(ctx, command='autopep8', cli_args=cli_args)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.check","title":"check","text":"<pre><code>check(ctx)\n</code></pre> <p>Run ruff as check-only.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(default=True)\ndef check(ctx: Context) -&gt; None:\n    \"\"\"Run ruff as check-only.\"\"\"\n    _inner_task(ctx, command='ruff check')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.fix","title":"fix","text":"<pre><code>fix(ctx)\n</code></pre> <p>Run ruff and apply fixes.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(pre=[autopep8])\ndef fix(ctx: Context) -&gt; None:\n    \"\"\"Run ruff and apply fixes.\"\"\"\n    _inner_task(ctx, command='ruff check', cli_args='--fix')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.flake8","title":"flake8","text":"<pre><code>flake8(ctx)\n</code></pre> <p>Run flake8.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef flake8(ctx: Context) -&gt; None:\n    \"\"\"Run flake8.\"\"\"\n    _inner_task(ctx, command='flake8', run_as_module=False)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.pre_commit","title":"pre_commit","text":"<pre><code>pre_commit(ctx, *, no_update=False)\n</code></pre> <p>Run pre-commit.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(\n    help={\n        'no_update': 'Skip updating the pre-commit hooks',\n    },\n)\ndef pre_commit(ctx: Context, *, no_update: bool = False) -&gt; None:\n    \"\"\"Run pre-commit.\"\"\"\n    check_installed(ctx, executable='pre-commit', message=PRE_COMMIT_MESSAGE)\n\n    run(ctx, 'pre-commit install')\n    if not no_update:\n        run(ctx, 'pre-commit autoupdate')\n\n    all_hook_stages = [\n        'commit', 'merge-commit', 'push', 'prepare-commit-msg', 'commit-msg', 'post-checkout',\n        'post-commit', 'post-merge', 'post-rewrite', 'manual',\n    ]\n    stages_cli = ' '.join(f'--hook-stage {stg}' for stg in all_hook_stages)\n    run(ctx, f'pre-commit run --all-files {stages_cli}')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.pylint","title":"pylint","text":"<pre><code>pylint(ctx, *, report=False)\n</code></pre> <p>Run pylint.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task(\n    help={\n        'report': 'if provided, show the pylint summary report',\n    },\n)\ndef pylint(ctx: Context, *, report: bool = False) -&gt; None:\n    \"\"\"Run pylint.\"\"\"\n    cli_args = '--report=y' if report else ''\n    _inner_task(ctx, command='pylint', cli_args=cli_args)\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.security","title":"security","text":"<pre><code>security(ctx)\n</code></pre> <p>Attempt to identify possible security vulnerabilities.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef security(ctx: Context) -&gt; None:\n    \"\"\"Attempt to identify possible security vulnerabilities.\"\"\"\n    logger.warning('Note: Selectively override bandit with \"# nosec\"', is_header=True)\n    pkg_name = read_package_name()\n    run(ctx, f'{python_dir()}/bandit --recursive {pkg_name} -s B101')\n\n    check_installed(ctx, executable='semgrep', message=SEMGREP_MESSAGE)\n    logger.warning('Note: Selectively override semgrep with \"# nosem\"', is_header=True)\n    # See additional semgrep rules at:\n    #   https://semgrep.dev/explore\n    #   https://github.com/returntocorp/semgrep-rules/tree/develop/python\n    #   https://awesomeopensource.com/project/returntocorp/semgrep-rules?categorypage=45\n    semgrep_configs = ' '.join([  # noqa: FLY002\n        '--config=p/ci',\n        '--config=p/default',\n        '--config=p/security-audit',\n        '--config=r/bash',\n        '--config=r/contrib',\n        '--config=r/fingerprints',\n        '--config=r/generic',\n        '--config=r/json',\n        '--config=r/python',\n        '--config=r/terraform',\n        '--config=r/yaml',\n        '--exclude-rule=yaml.github-actions.security.third-party-action-not-pinned-to-commit-sha.third-party-action-not-pinned-to-commit-sha',\n    ])\n    run(ctx, f'semgrep ci --autofix {semgrep_configs}')\n</code></pre>"},{"location":"reference/calcipy/tasks/lint/#calcipy.tasks.lint.watch","title":"watch","text":"<pre><code>watch(ctx)\n</code></pre> <p>Run ruff as check-only.</p> Source code in <code>calcipy/tasks/lint.py</code> <pre><code>@task()\ndef watch(ctx: Context) -&gt; None:\n    \"\"\"Run ruff as check-only.\"\"\"\n    _inner_task(ctx, command='ruff check', cli_args='--watch --show-source')\n</code></pre>"},{"location":"reference/calcipy/tasks/nox/","title":"nox","text":"<p>Nox CLI.</p>"},{"location":"reference/calcipy/tasks/nox/#calcipy.tasks.nox-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/nox/#calcipy.tasks.nox.noxfile","title":"noxfile","text":"<pre><code>noxfile(ctx, *, session='')\n</code></pre> <p>Run nox from the local noxfile.</p> Source code in <code>calcipy/tasks/nox.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'session': 'Optional session to run',\n    },\n)\ndef noxfile(ctx: Context, *, session: str = '') -&gt; None:\n    \"\"\"Run nox from the local noxfile.\"\"\"\n    cli_args = ['--session', session] if session else []\n    run(ctx, f'{python_dir()}/nox --error-on-missing-interpreters {\" \".join(cli_args)}')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/","title":"pack","text":"<p>Packaging CLI.</p>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.bump_tag","title":"bump_tag","text":"<pre><code>bump_tag(ctx, *, tag, tag_prefix='', pkg_name='')\n</code></pre> <p>Experiment with bumping the git tag using <code>griffe</code>.</p> <p>Example for <code>calcipy</code>:</p> <pre><code>./run pack.bump-tag --tag=\"$(git tag -l \"*\" | sort | head -n 5 | tail -n 1)\" --tag-prefix=\"\"\n</code></pre> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task(\n    help={\n        'tag': 'Last tag, can be provided with `--tag=\"$(git tag -l \"v*\" | sort | tail -n 1)\"`',\n        'tag_prefix': 'Optional tag prefix, such as \"v\"',\n        'pkg_name': 'Optional package name. If not provided, will read the poetry pyproject.toml file',\n    },\n)\ndef bump_tag(ctx: Context, *, tag: str, tag_prefix: str = '', pkg_name: str = '') -&gt; None:  # noqa: ARG001\n    \"\"\"Experiment with bumping the git tag using `griffe`.\n\n    Example for `calcipy`:\n\n    ```sh\n    ./run pack.bump-tag --tag=\"$(git tag -l \"*\" | sort | head -n 5 | tail -n 1)\" --tag-prefix=\"\"\n    ```\n\n    \"\"\"\n    if not tag:\n        raise ValueError('tag must not be empty')\n    if not pkg_name:\n        poetry_config = file_helpers.read_pyproject()['tool']['poetry']\n        pkg_name = poetry_config['name']\n\n    new_version = bump_programmatically.bump_tag(\n        pkg_name=pkg_name,\n        tag=tag,\n        tag_prefix=tag_prefix,\n    )\n    logger.text(new_version)\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.check_licenses","title":"check_licenses","text":"<pre><code>check_licenses(ctx)\n</code></pre> <p>Check licenses for compatibility with <code>licensecheck</code>.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef check_licenses(ctx: Context) -&gt; None:\n    \"\"\"Check licenses for compatibility with `licensecheck`.\"\"\"\n    res = run(ctx, 'which licensecheck', warn=True, hide=True)\n    if not res or res.exited == 1:\n        logger.warning('`licensecheck` not found. installing with pipx')\n        run(ctx, 'pipx install licensecheck')\n    run(ctx, 'licensecheck')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.install_extras","title":"install_extras","text":"<pre><code>install_extras(ctx)\n</code></pre> <p>Run poetry install with all extras.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef install_extras(ctx: Context) -&gt; None:\n    \"\"\"Run poetry install with all extras.\"\"\"\n    poetry_config = file_helpers.read_pyproject()['tool']['poetry']\n    extras = (poetry_config.get('extras') or {}).keys()\n    run(ctx, ' '.join(['poetry install --sync', *[f'--extras={ex}' for ex in extras]]))\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.lock","title":"lock","text":"<pre><code>lock(ctx)\n</code></pre> <p>Ensure poetry.lock is  up-to-date.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task()\ndef lock(ctx: Context) -&gt; None:\n    \"\"\"Ensure poetry.lock is  up-to-date.\"\"\"\n    if can_skip.can_skip(prerequisites=[PROJECT_TOML], targets=[LOCK]):\n        return  # Exit early\n\n    run(ctx, 'poetry lock --no-update')\n</code></pre>"},{"location":"reference/calcipy/tasks/pack/#calcipy.tasks.pack.publish","title":"publish","text":"<pre><code>publish(ctx, *, to_test_pypi=False)\n</code></pre> <p>Build the distributed format(s) and publish.</p> Source code in <code>calcipy/tasks/pack.py</code> <pre><code>@task(\n    help={\n        'to_test_pypi': 'Publish to the TestPyPi repository',\n    },\n)\ndef publish(ctx: Context, *, to_test_pypi: bool = False) -&gt; None:\n    \"\"\"Build the distributed format(s) and publish.\"\"\"\n    run(ctx, f'{python_dir()}/nox --error-on-missing-interpreters --session build_dist build_check')\n\n    cmd = 'poetry publish'\n    if to_test_pypi:\n        cmd += ' --repository testpypi'\n    run(ctx, cmd)\n</code></pre>"},{"location":"reference/calcipy/tasks/stale/","title":"stale","text":"<p>Stale Packages CLI.</p>"},{"location":"reference/calcipy/tasks/stale/#calcipy.tasks.stale-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/stale/#calcipy.tasks.stale.check_for_stale_packages","title":"check_for_stale_packages","text":"<pre><code>check_for_stale_packages(ctx, *, stale_months=48)\n</code></pre> <p>Identify stale dependencies.</p> Source code in <code>calcipy/tasks/stale.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'stale_months': 'Cutoff in months for when a package may be stale enough to be a risk',\n    },\n)\ndef check_for_stale_packages(ctx: Context, *, stale_months: int = 48) -&gt; None:\n    \"\"\"Identify stale dependencies.\"\"\"\n    cfsp(stale_months=stale_months)\n    run(ctx, f'{python_dir()}/pip-check --cmd=\"poetry run pip\" --hide-unchanged')\n</code></pre>"},{"location":"reference/calcipy/tasks/tags/","title":"tags","text":"<p>Code Tag Collector CLI.</p>"},{"location":"reference/calcipy/tasks/tags/#calcipy.tasks.tags-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/tags/#calcipy.tasks.tags.collect_code_tags","title":"collect_code_tags","text":"<pre><code>collect_code_tags(ctx, base_dir='.', filename=None, tag_order='', regex='', ignore_patterns='')\n</code></pre> <p>Create a <code>CODE_TAG_SUMMARY.md</code> with a table for TODO- and FIXME-style code comments.</p> Source code in <code>calcipy/tasks/tags.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'base_dir': 'Working Directory',\n        'filename': 'Code Tag Summary Filename',\n        'tag_order': 'Ordered list of code tags to locate (Comma-separated)',\n        'regex': 'Custom Code Tag Regex. Must contain \"{tag}\"',\n        'ignore_patterns': 'Glob patterns to ignore files and directories when searching (Comma-separated)',\n    },\n)\ndef collect_code_tags(\n    ctx: Context,\n    base_dir: str = '.',\n    filename: Optional[str] = None,\n    tag_order: str = '',\n    regex: str = '',\n    ignore_patterns: str = '',\n) -&gt; None:\n    \"\"\"Create a `CODE_TAG_SUMMARY.md` with a table for TODO- and FIXME-style code comments.\"\"\"\n    pth_base_dir = Path(base_dir).resolve()\n    path_tag_summary = get_doc_subdir() / (filename or from_ctx(ctx, 'tags', 'filename'))\n    patterns = (ignore_patterns or from_ctx(ctx, 'tags', 'ignore_patterns')).split(',')\n    paths_source = find_project_files(pth_base_dir, ignore_patterns=[*filter(lambda item: item, patterns)])\n\n    write_code_tag_file(\n        path_tag_summary=path_tag_summary,\n        paths_source=paths_source,\n        base_dir=pth_base_dir,\n        regex=regex,\n        tags=tag_order,\n        header='# Collected Code Tags',\n    )\n</code></pre>"},{"location":"reference/calcipy/tasks/test/","title":"test","text":"<p>Test CLI.</p>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.check","title":"check","text":"<pre><code>check(_ctx)\n</code></pre> <p>Run pytest checks, such as identifying .</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task()\ndef check(_ctx: Context) -&gt; None:\n    \"\"\"Run pytest checks, such as identifying .\"\"\"\n    if duplciates := check_duplicate_test_names.run(Path('tests')):\n        raise RuntimeError(f'Duplicate test names found ({duplciates}). See above for details.')  # noqa: EM102\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.coverage","title":"coverage","text":"<pre><code>coverage(ctx, *, min_cover=0, out_dir=None, view=False)\n</code></pre> <p>Generate useful coverage outputs after running pytest.</p> <p>Creates <code>coverage.json</code> used in <code>doc.build</code></p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(\n    help={\n        'min_cover': 'Fail if coverage less than threshold',\n        'out_dir': 'Optional path to coverage directory. Typically \".cover\" or \"releases/tests\"',\n        'view': 'If True, open the created files',\n    },\n)\ndef coverage(ctx: Context, *, min_cover: int = 0, out_dir: Optional[str] = None, view: bool = False) -&gt; None:\n    \"\"\"Generate useful coverage outputs after running pytest.\n\n    Creates `coverage.json` used in `doc.build`\n\n    \"\"\"\n    pkg_name = read_package_name()\n    _inner_task(ctx, cli_args='', min_cover=min_cover,\n                command=f'coverage run --branch --source={pkg_name} --module pytest')\n\n    cov_dir = Path(out_dir or from_ctx(ctx, 'test', 'out_dir'))\n    cov_dir.mkdir(exist_ok=True, parents=True)\n    print()  # noqa: T201\n    for cli_args in (\n        'report --show-missing',  # Write to STDOUT\n        f'html --directory={cov_dir}',  # Write to HTML\n        'json',  # Create coverage.json file for \"_handle_coverage\"\n    ):\n        run(ctx, f'{python_dir()}/coverage {cli_args}')\n\n    if view:  # pragma: no cover\n        open_in_browser(cov_dir / 'index.html')\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.pytest","title":"pytest","text":"<pre><code>pytest(ctx, *, keyword='', marker='', min_cover=0)\n</code></pre> <p>Run pytest with default arguments.</p> <p>Additional arguments can be set in the environment variable \u2018PYTEST_ADDOPTS\u2019</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(\n    default=True,\n    help={\n        'min_cover': 'Fail if coverage less than threshold',\n        **KM_HELP,\n    },\n)\ndef pytest(ctx: Context, *, keyword: str = '', marker: str = '', min_cover: int = 0) -&gt; None:\n    \"\"\"Run pytest with default arguments.\n\n    Additional arguments can be set in the environment variable 'PYTEST_ADDOPTS'\n\n    \"\"\"\n    pkg_name = read_package_name()\n    durations = '--durations=25 --durations-min=\"0.1\"'\n    _inner_task(ctx,\n                cli_args=f' --cov={pkg_name} --cov-branch --cov-report=term-missing {durations}',\n                keyword=keyword, marker=marker, min_cover=min_cover)\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.step","title":"step","text":"<pre><code>step(ctx, *, keyword='', marker='')\n</code></pre> <p>Run pytest optimized to stop on first error.</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(help=KM_HELP)\ndef step(ctx: Context, *, keyword: str = '', marker: str = '') -&gt; None:\n    \"\"\"Run pytest optimized to stop on first error.\"\"\"\n    _inner_task(ctx, cli_args=_STEPWISE_ARGS, keyword=keyword, marker=marker)\n</code></pre>"},{"location":"reference/calcipy/tasks/test/#calcipy.tasks.test.watch","title":"watch","text":"<pre><code>watch(ctx, *, keyword='', marker='')\n</code></pre> <p>Run pytest with polling and optimized to stop on first error.</p> Source code in <code>calcipy/tasks/test.py</code> <pre><code>@task(help=KM_HELP)\ndef watch(ctx: Context, *, keyword: str = '', marker: str = '') -&gt; None:\n    \"\"\"Run pytest with polling and optimized to stop on first error.\"\"\"\n    _inner_task(ctx, cli_args=_STEPWISE_ARGS, keyword=keyword, marker=marker, command='ptw . --now')\n</code></pre>"},{"location":"reference/calcipy/tasks/types/","title":"types","text":"<p>Types CLI.</p>"},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types-functions","title":"Functions","text":""},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types.mypy","title":"mypy","text":"<pre><code>mypy(ctx)\n</code></pre> <p>Run mypy.</p> Source code in <code>calcipy/tasks/types.py</code> <pre><code>@task()\ndef mypy(ctx: Context) -&gt; None:\n    \"\"\"Run mypy.\"\"\"\n    _inner_task(ctx, command=f'{python_dir()}/mypy')\n</code></pre>"},{"location":"reference/calcipy/tasks/types/#calcipy.tasks.types.pyright","title":"pyright","text":"<pre><code>pyright(ctx)\n</code></pre> <p>Run pyright.</p> Source code in <code>calcipy/tasks/types.py</code> <pre><code>@task()\ndef pyright(ctx: Context) -&gt; None:\n    \"\"\"Run pyright.\"\"\"\n    check_installed(ctx, executable='pyright', message=PYRIGHT_MESSAGE)\n    _inner_task(ctx, command='pyright')\n</code></pre>"}]}
\ No newline at end of file
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 09ec23d7174cd47c69e41976e62cb0bb8694f342..37fd89bea596a5a925d8829609a8265b5e26a8b9 100644
GIT binary patch
delta 14
VcmZ3(vWA6KzMF&N&_-5uCIBAX1Hk|Q

delta 14
VcmZ3(vWA6KzMF$XZzHQZ6960d11$gm