[{"data":1,"prerenderedAt":2763},["ShallowReactive",2],{"page-\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations\u002F":3,"content-directory":1918},{"id":4,"title":5,"body":6,"date":1902,"description":1903,"difficulty":1904,"draft":1905,"extension":1906,"meta":1907,"navigation":342,"path":1908,"seo":1909,"stem":1910,"tags":1911,"updated":1902,"__hash__":1917},"content\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations\u002Findex.md","Running Ruff and mypy in CI with Inline Annotations",{"type":7,"value":8,"toc":1881},"minimark",[9,24,29,48,52,55,66,76,80,84,89,140,146,152,163,167,174,300,303,1064,1071,1075,1303,1314,1317,1321,1324,1377,1388,1392,1395,1437,1440,1444,1447,1759,1762,1766,1779,1783,1787,1798,1802,1814,1818,1821,1825,1828,1832,1843,1847,1877],[10,11,12,13,17,18,23],"p",{},"A lint failure that only says \"exit code 1\" in a CI log is a small tax on every contributor: open the job, scroll to the step, find the file and line, switch back to the editor. Multiply by every pull request and the linters start to feel like obstacles. GitHub Actions can do much better — a step can emit ",[14,15,16],"em",{},"workflow commands"," that attach a finding to a specific line of a specific file, so the problem appears directly in the pull request's diff view, next to the code that caused it. Ruff speaks that format natively. mypy does not, but its JSON output converts to it in twenty lines. This guide builds a lint job that runs Ruff's linter and formatter check and mypy, annotates every finding inline, stays fast, and optionally feeds GitHub's code-scanning dashboard through SARIF. It belongs to the ",[19,20,22],"a",{"href":21},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002F","linting and type checking topic",".",[25,26,28],"h2",{"id":27},"prerequisites","Prerequisites",[30,31,32,45],"ul",{},[33,34,35,36,40,41,23],"li",{},"Ruff and mypy configured for the project — see ",[19,37,39],{"href":38},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project\u002F","configuring Ruff for a CLI project"," and ",[19,42,44],{"href":43},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ftype-checking-click-and-typer-code-with-mypy\u002F","type-checking Click and Typer code with mypy",[33,46,47],{},"A GitHub Actions workflow; other CI systems have equivalents (GitLab code quality reports, for example).",[25,49,51],{"id":50},"how-inline-annotations-work","How inline annotations work",[10,53,54],{},"Any step in a GitHub Actions job can print a line in a special format to its standard output:",[56,57,63],"pre",{"className":58,"code":60,"language":61,"meta":62},[59],"language-text","::error file=src\u002Fmytool\u002Fcli.py,line=14,col=5,title=mypy (return-value)::Incompatible return value type\n","text","",[64,65,60],"code",{"__ignoreMap":62},[10,67,68,69,40,72,75],{},"The runner intercepts it, shows it in the job summary, and — when the file is part of the pull request's diff — attaches it to that line in the \"Files changed\" view. ",[64,70,71],{},"::warning",[64,73,74],{},"::notice"," work the same way with different severities.",[77,78],"inline-diagram",{"name":79},"annot-flow",[25,81,83],{"id":82},"the-recipe","The recipe",[85,86,88],"h3",{"id":87},"ruff-native-github-output","Ruff: native GitHub output",[56,90,94],{"className":91,"code":92,"language":93,"meta":62,"style":62},"language-bash shiki shiki-themes github-light github-dark","uvx ruff check --output-format github .\nuvx ruff format --check --diff .\n","bash",[64,95,96,122],{"__ignoreMap":62},[97,98,101,105,109,112,116,119],"span",{"class":99,"line":100},"line",1,[97,102,104],{"class":103},"sScJk","uvx",[97,106,108],{"class":107},"sZZnC"," ruff",[97,110,111],{"class":107}," check",[97,113,115],{"class":114},"sj4cs"," --output-format",[97,117,118],{"class":107}," github",[97,120,121],{"class":107}," .\n",[97,123,125,127,129,132,135,138],{"class":99,"line":124},2,[97,126,104],{"class":103},[97,128,108],{"class":107},[97,130,131],{"class":107}," format",[97,133,134],{"class":114}," --check",[97,136,137],{"class":114}," --diff",[97,139,121],{"class":107},[10,141,142,145],{},[64,143,144],{},"--output-format github"," makes every lint finding a workflow command. On a module with an unused import it prints:",[56,147,150],{"className":148,"code":149,"language":61,"meta":62},[59],"::error title=ruff (F401),file=src\u002Fmytool\u002Fbad.py,line=1,col=8,endLine=1,endColumn=10::src\u002Fmytool\u002Fbad.py:1:8: F401 `os` imported but unused\n",[64,151,149],{"__ignoreMap":62},[10,153,154,155,158,159,162],{},"The format check has no annotation mode, but ",[64,156,157],{},"--diff"," prints exactly what would change, which is usually enough to fix it at a glance — and the fix is always the same: run ",[64,160,161],{},"ruff format"," locally.",[85,164,166],{"id":165},"mypy-json-to-annotations","mypy: JSON to annotations",[10,168,169,170,173],{},"Recent mypy versions emit one JSON object per finding with ",[64,171,172],{},"--output json",":",[56,175,179],{"className":176,"code":177,"language":178,"meta":62,"style":62},"language-json shiki shiki-themes github-light github-dark","{\"file\": \"src\u002Fmytool\u002Fbad.py\", \"line\": 4, \"column\": 11, \"end_line\": 4, \"end_column\": 12, \"message\": \"Incompatible return value type (got \\\"int\\\", expected \\\"str\\\")\", \"hint\": null, \"code\": \"return-value\", \"severity\": \"error\"}\n","json",[64,180,181],{"__ignoreMap":62},[97,182,183,187,190,193,196,199,202,204,207,209,212,214,217,219,222,224,226,228,231,233,236,238,241,243,246,249,252,254,257,259,262,264,267,269,272,274,277,279,282,284,287,289,292,294,297],{"class":99,"line":100},[97,184,186],{"class":185},"sVt8B","{",[97,188,189],{"class":114},"\"file\"",[97,191,192],{"class":185},": ",[97,194,195],{"class":107},"\"src\u002Fmytool\u002Fbad.py\"",[97,197,198],{"class":185},", ",[97,200,201],{"class":114},"\"line\"",[97,203,192],{"class":185},[97,205,206],{"class":114},"4",[97,208,198],{"class":185},[97,210,211],{"class":114},"\"column\"",[97,213,192],{"class":185},[97,215,216],{"class":114},"11",[97,218,198],{"class":185},[97,220,221],{"class":114},"\"end_line\"",[97,223,192],{"class":185},[97,225,206],{"class":114},[97,227,198],{"class":185},[97,229,230],{"class":114},"\"end_column\"",[97,232,192],{"class":185},[97,234,235],{"class":114},"12",[97,237,198],{"class":185},[97,239,240],{"class":114},"\"message\"",[97,242,192],{"class":185},[97,244,245],{"class":107},"\"Incompatible return value type (got ",[97,247,248],{"class":114},"\\\"",[97,250,251],{"class":107},"int",[97,253,248],{"class":114},[97,255,256],{"class":107},", expected ",[97,258,248],{"class":114},[97,260,261],{"class":107},"str",[97,263,248],{"class":114},[97,265,266],{"class":107},")\"",[97,268,198],{"class":185},[97,270,271],{"class":114},"\"hint\"",[97,273,192],{"class":185},[97,275,276],{"class":114},"null",[97,278,198],{"class":185},[97,280,281],{"class":114},"\"code\"",[97,283,192],{"class":185},[97,285,286],{"class":107},"\"return-value\"",[97,288,198],{"class":185},[97,290,291],{"class":114},"\"severity\"",[97,293,192],{"class":185},[97,295,296],{"class":107},"\"error\"",[97,298,299],{"class":185},"}\n",[10,301,302],{},"A small script turns those lines into workflow commands, escaping the characters the format reserves:",[56,304,308],{"className":305,"code":306,"language":307,"meta":62,"style":62},"language-python shiki shiki-themes github-light github-dark","# scripts\u002Fmypy_annotations.py\n\"\"\"Read `mypy --output json` on stdin; print GitHub workflow annotations.\"\"\"\nfrom __future__ import annotations\n\nimport json\nimport sys\n\n\ndef escape_data(text: str) -> str:\n    return text.replace(\"%\", \"%25\").replace(\"\\r\", \"%0D\").replace(\"\\n\", \"%0A\")\n\n\ndef escape_property(text: str) -> str:\n    return escape_data(text).replace(\":\", \"%3A\").replace(\",\", \"%2C\")\n\n\ndef annotation(finding: dict) -> str:\n    level = {\"error\": \"error\", \"note\": \"notice\"}.get(finding.get(\"severity\"), \"warning\")\n    props = {\n        \"file\": finding[\"file\"],\n        \"line\": finding.get(\"line\", 1),\n        \"col\": max(finding.get(\"column\", 0), 0) + 1,\n        \"title\": f\"mypy ({finding.get('code') or 'misc'})\",\n    }\n    if finding.get(\"end_line\"):\n        props[\"endLine\"] = finding[\"end_line\"]\n    message = finding[\"message\"]\n    if finding.get(\"hint\"):\n        message += \"\\n\" + finding[\"hint\"]\n    rendered = \",\".join(f\"{k}={escape_property(str(v))}\" for k, v in props.items())\n    return f\"::{level} {rendered}::{escape_data(message)}\"\n\n\ndef main() -> int:\n    errors = 0\n    for line in sys.stdin:\n        line = line.strip()\n        if not line.startswith(\"{\"):\n            print(line)                       # pass through summaries and crashes\n            continue\n        finding = json.loads(line)\n        errors += finding.get(\"severity\") == \"error\"\n        print(annotation(finding))\n    return 1 if errors else 0\n\n\nif __name__ == \"__main__\":\n    raise SystemExit(main())\n","python",[64,309,310,316,321,337,344,353,361,366,371,393,443,448,453,471,499,504,509,529,570,581,595,614,651,688,694,708,730,744,755,780,833,871,876,881,896,907,921,932,949,961,967,978,998,1007,1025,1030,1035,1052],{"__ignoreMap":62},[97,311,312],{"class":99,"line":100},[97,313,315],{"class":314},"sJ8bj","# scripts\u002Fmypy_annotations.py\n",[97,317,318],{"class":99,"line":124},[97,319,320],{"class":107},"\"\"\"Read `mypy --output json` on stdin; print GitHub workflow annotations.\"\"\"\n",[97,322,324,328,331,334],{"class":99,"line":323},3,[97,325,327],{"class":326},"szBVR","from",[97,329,330],{"class":114}," __future__",[97,332,333],{"class":326}," import",[97,335,336],{"class":185}," annotations\n",[97,338,340],{"class":99,"line":339},4,[97,341,343],{"emptyLinePlaceholder":342},true,"\n",[97,345,347,350],{"class":99,"line":346},5,[97,348,349],{"class":326},"import",[97,351,352],{"class":185}," json\n",[97,354,356,358],{"class":99,"line":355},6,[97,357,349],{"class":326},[97,359,360],{"class":185}," sys\n",[97,362,364],{"class":99,"line":363},7,[97,365,343],{"emptyLinePlaceholder":342},[97,367,369],{"class":99,"line":368},8,[97,370,343],{"emptyLinePlaceholder":342},[97,372,374,377,380,383,385,388,390],{"class":99,"line":373},9,[97,375,376],{"class":326},"def",[97,378,379],{"class":103}," escape_data",[97,381,382],{"class":185},"(text: ",[97,384,261],{"class":114},[97,386,387],{"class":185},") -> ",[97,389,261],{"class":114},[97,391,392],{"class":185},":\n",[97,394,396,399,402,405,407,410,413,416,419,421,423,426,428,430,433,435,437,440],{"class":99,"line":395},10,[97,397,398],{"class":326},"    return",[97,400,401],{"class":185}," text.replace(",[97,403,404],{"class":107},"\"%\"",[97,406,198],{"class":185},[97,408,409],{"class":107},"\"%25\"",[97,411,412],{"class":185},").replace(",[97,414,415],{"class":107},"\"",[97,417,418],{"class":114},"\\r",[97,420,415],{"class":107},[97,422,198],{"class":185},[97,424,425],{"class":107},"\"%0D\"",[97,427,412],{"class":185},[97,429,415],{"class":107},[97,431,432],{"class":114},"\\n",[97,434,415],{"class":107},[97,436,198],{"class":185},[97,438,439],{"class":107},"\"%0A\"",[97,441,442],{"class":185},")\n",[97,444,446],{"class":99,"line":445},11,[97,447,343],{"emptyLinePlaceholder":342},[97,449,451],{"class":99,"line":450},12,[97,452,343],{"emptyLinePlaceholder":342},[97,454,456,458,461,463,465,467,469],{"class":99,"line":455},13,[97,457,376],{"class":326},[97,459,460],{"class":103}," escape_property",[97,462,382],{"class":185},[97,464,261],{"class":114},[97,466,387],{"class":185},[97,468,261],{"class":114},[97,470,392],{"class":185},[97,472,474,476,479,482,484,487,489,492,494,497],{"class":99,"line":473},14,[97,475,398],{"class":326},[97,477,478],{"class":185}," escape_data(text).replace(",[97,480,481],{"class":107},"\":\"",[97,483,198],{"class":185},[97,485,486],{"class":107},"\"%3A\"",[97,488,412],{"class":185},[97,490,491],{"class":107},"\",\"",[97,493,198],{"class":185},[97,495,496],{"class":107},"\"%2C\"",[97,498,442],{"class":185},[97,500,502],{"class":99,"line":501},15,[97,503,343],{"emptyLinePlaceholder":342},[97,505,507],{"class":99,"line":506},16,[97,508,343],{"emptyLinePlaceholder":342},[97,510,512,514,517,520,523,525,527],{"class":99,"line":511},17,[97,513,376],{"class":326},[97,515,516],{"class":103}," annotation",[97,518,519],{"class":185},"(finding: ",[97,521,522],{"class":114},"dict",[97,524,387],{"class":185},[97,526,261],{"class":114},[97,528,392],{"class":185},[97,530,532,535,538,541,543,545,547,549,552,554,557,560,562,565,568],{"class":99,"line":531},18,[97,533,534],{"class":185},"    level ",[97,536,537],{"class":326},"=",[97,539,540],{"class":185}," {",[97,542,296],{"class":107},[97,544,192],{"class":185},[97,546,296],{"class":107},[97,548,198],{"class":185},[97,550,551],{"class":107},"\"note\"",[97,553,192],{"class":185},[97,555,556],{"class":107},"\"notice\"",[97,558,559],{"class":185},"}.get(finding.get(",[97,561,291],{"class":107},[97,563,564],{"class":185},"), ",[97,566,567],{"class":107},"\"warning\"",[97,569,442],{"class":185},[97,571,573,576,578],{"class":99,"line":572},19,[97,574,575],{"class":185},"    props ",[97,577,537],{"class":326},[97,579,580],{"class":185}," {\n",[97,582,584,587,590,592],{"class":99,"line":583},20,[97,585,586],{"class":107},"        \"file\"",[97,588,589],{"class":185},": finding[",[97,591,189],{"class":107},[97,593,594],{"class":185},"],\n",[97,596,598,601,604,606,608,611],{"class":99,"line":597},21,[97,599,600],{"class":107},"        \"line\"",[97,602,603],{"class":185},": finding.get(",[97,605,201],{"class":107},[97,607,198],{"class":185},[97,609,610],{"class":114},"1",[97,612,613],{"class":185},"),\n",[97,615,617,620,622,625,628,630,632,635,637,639,642,645,648],{"class":99,"line":616},22,[97,618,619],{"class":107},"        \"col\"",[97,621,192],{"class":185},[97,623,624],{"class":114},"max",[97,626,627],{"class":185},"(finding.get(",[97,629,211],{"class":107},[97,631,198],{"class":185},[97,633,634],{"class":114},"0",[97,636,564],{"class":185},[97,638,634],{"class":114},[97,640,641],{"class":185},") ",[97,643,644],{"class":326},"+",[97,646,647],{"class":114}," 1",[97,649,650],{"class":185},",\n",[97,652,654,657,659,662,665,667,670,673,675,678,681,684,686],{"class":99,"line":653},23,[97,655,656],{"class":107},"        \"title\"",[97,658,192],{"class":185},[97,660,661],{"class":326},"f",[97,663,664],{"class":107},"\"mypy (",[97,666,186],{"class":114},[97,668,669],{"class":185},"finding.get(",[97,671,672],{"class":107},"'code'",[97,674,641],{"class":185},[97,676,677],{"class":326},"or",[97,679,680],{"class":107}," 'misc'",[97,682,683],{"class":114},"}",[97,685,266],{"class":107},[97,687,650],{"class":185},[97,689,691],{"class":99,"line":690},24,[97,692,693],{"class":185},"    }\n",[97,695,697,700,703,705],{"class":99,"line":696},25,[97,698,699],{"class":326},"    if",[97,701,702],{"class":185}," finding.get(",[97,704,221],{"class":107},[97,706,707],{"class":185},"):\n",[97,709,711,714,717,720,722,725,727],{"class":99,"line":710},26,[97,712,713],{"class":185},"        props[",[97,715,716],{"class":107},"\"endLine\"",[97,718,719],{"class":185},"] ",[97,721,537],{"class":326},[97,723,724],{"class":185}," finding[",[97,726,221],{"class":107},[97,728,729],{"class":185},"]\n",[97,731,733,736,738,740,742],{"class":99,"line":732},27,[97,734,735],{"class":185},"    message ",[97,737,537],{"class":326},[97,739,724],{"class":185},[97,741,240],{"class":107},[97,743,729],{"class":185},[97,745,747,749,751,753],{"class":99,"line":746},28,[97,748,699],{"class":326},[97,750,702],{"class":185},[97,752,271],{"class":107},[97,754,707],{"class":185},[97,756,758,761,764,767,769,771,774,776,778],{"class":99,"line":757},29,[97,759,760],{"class":185},"        message ",[97,762,763],{"class":326},"+=",[97,765,766],{"class":107}," \"",[97,768,432],{"class":114},[97,770,415],{"class":107},[97,772,773],{"class":326}," +",[97,775,724],{"class":185},[97,777,271],{"class":107},[97,779,729],{"class":185},[97,781,783,786,788,791,794,796,798,800,803,805,807,809,812,814,817,819,821,824,827,830],{"class":99,"line":782},30,[97,784,785],{"class":185},"    rendered ",[97,787,537],{"class":326},[97,789,790],{"class":107}," \",\"",[97,792,793],{"class":185},".join(",[97,795,661],{"class":326},[97,797,415],{"class":107},[97,799,186],{"class":114},[97,801,802],{"class":185},"k",[97,804,683],{"class":114},[97,806,537],{"class":107},[97,808,186],{"class":114},[97,810,811],{"class":185},"escape_property(",[97,813,261],{"class":114},[97,815,816],{"class":185},"(v))",[97,818,683],{"class":114},[97,820,415],{"class":107},[97,822,823],{"class":326}," for",[97,825,826],{"class":185}," k, v ",[97,828,829],{"class":326},"in",[97,831,832],{"class":185}," props.items())\n",[97,834,836,838,841,844,846,849,851,853,856,858,861,863,866,868],{"class":99,"line":835},31,[97,837,398],{"class":326},[97,839,840],{"class":326}," f",[97,842,843],{"class":107},"\"::",[97,845,186],{"class":114},[97,847,848],{"class":185},"level",[97,850,683],{"class":114},[97,852,540],{"class":114},[97,854,855],{"class":185},"rendered",[97,857,683],{"class":114},[97,859,860],{"class":107},"::",[97,862,186],{"class":114},[97,864,865],{"class":185},"escape_data(message)",[97,867,683],{"class":114},[97,869,870],{"class":107},"\"\n",[97,872,874],{"class":99,"line":873},32,[97,875,343],{"emptyLinePlaceholder":342},[97,877,879],{"class":99,"line":878},33,[97,880,343],{"emptyLinePlaceholder":342},[97,882,884,886,889,892,894],{"class":99,"line":883},34,[97,885,376],{"class":326},[97,887,888],{"class":103}," main",[97,890,891],{"class":185},"() -> ",[97,893,251],{"class":114},[97,895,392],{"class":185},[97,897,899,902,904],{"class":99,"line":898},35,[97,900,901],{"class":185},"    errors ",[97,903,537],{"class":326},[97,905,906],{"class":114}," 0\n",[97,908,910,913,916,918],{"class":99,"line":909},36,[97,911,912],{"class":326},"    for",[97,914,915],{"class":185}," line ",[97,917,829],{"class":326},[97,919,920],{"class":185}," sys.stdin:\n",[97,922,924,927,929],{"class":99,"line":923},37,[97,925,926],{"class":185},"        line ",[97,928,537],{"class":326},[97,930,931],{"class":185}," line.strip()\n",[97,933,935,938,941,944,947],{"class":99,"line":934},38,[97,936,937],{"class":326},"        if",[97,939,940],{"class":326}," not",[97,942,943],{"class":185}," line.startswith(",[97,945,946],{"class":107},"\"{\"",[97,948,707],{"class":185},[97,950,952,955,958],{"class":99,"line":951},39,[97,953,954],{"class":114},"            print",[97,956,957],{"class":185},"(line)                       ",[97,959,960],{"class":314},"# pass through summaries and crashes\n",[97,962,964],{"class":99,"line":963},40,[97,965,966],{"class":326},"            continue\n",[97,968,970,973,975],{"class":99,"line":969},41,[97,971,972],{"class":185},"        finding ",[97,974,537],{"class":326},[97,976,977],{"class":185}," json.loads(line)\n",[97,979,981,984,986,988,990,992,995],{"class":99,"line":980},42,[97,982,983],{"class":185},"        errors ",[97,985,763],{"class":326},[97,987,702],{"class":185},[97,989,291],{"class":107},[97,991,641],{"class":185},[97,993,994],{"class":326},"==",[97,996,997],{"class":107}," \"error\"\n",[97,999,1001,1004],{"class":99,"line":1000},43,[97,1002,1003],{"class":114},"        print",[97,1005,1006],{"class":185},"(annotation(finding))\n",[97,1008,1010,1012,1014,1017,1020,1023],{"class":99,"line":1009},44,[97,1011,398],{"class":326},[97,1013,647],{"class":114},[97,1015,1016],{"class":326}," if",[97,1018,1019],{"class":185}," errors ",[97,1021,1022],{"class":326},"else",[97,1024,906],{"class":114},[97,1026,1028],{"class":99,"line":1027},45,[97,1029,343],{"emptyLinePlaceholder":342},[97,1031,1033],{"class":99,"line":1032},46,[97,1034,343],{"emptyLinePlaceholder":342},[97,1036,1038,1041,1044,1047,1050],{"class":99,"line":1037},47,[97,1039,1040],{"class":326},"if",[97,1042,1043],{"class":114}," __name__",[97,1045,1046],{"class":326}," ==",[97,1048,1049],{"class":107}," \"__main__\"",[97,1051,392],{"class":185},[97,1053,1055,1058,1061],{"class":99,"line":1054},48,[97,1056,1057],{"class":326},"    raise",[97,1059,1060],{"class":114}," SystemExit",[97,1062,1063],{"class":185},"(main())\n",[10,1065,1066,1067,1070],{},"mypy reports zero-based columns in JSON while annotations are one-based, hence the ",[64,1068,1069],{},"+ 1",". Lines that are not JSON — a crash, a configuration error — are passed through unchanged, so a broken mypy setup still fails visibly instead of producing an empty, green run. The exit code comes from the findings, because mypy's own exit status is lost in the pipe.",[85,1072,1074],{"id":1073},"the-workflow","The workflow",[56,1076,1080],{"className":1077,"code":1078,"language":1079,"meta":62,"style":62},"language-yaml shiki shiki-themes github-light github-dark","# .github\u002Fworkflows\u002Flint.yml\nname: lint\non: [push, pull_request]\n\npermissions:\n  contents: read\n\njobs:\n  ruff:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions\u002Fcheckout@v4\n      - uses: astral-sh\u002Fsetup-uv@v6\n      - run: uvx ruff@0.16.10 check --output-format github .\n      - run: uvx ruff@0.16.10 format --check --diff .\n\n  mypy:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions\u002Fcheckout@v4\n      - uses: astral-sh\u002Fsetup-uv@v6\n        with:\n          enable-cache: true\n      - run: uv sync --locked --group lint\n      - run: uv run mypy --output json src | python scripts\u002Fmypy_annotations.py\n","yaml",[64,1081,1082,1087,1098,1116,1120,1127,1137,1141,1148,1155,1165,1172,1185,1196,1208,1219,1223,1230,1238,1244,1254,1264,1271,1281,1292],{"__ignoreMap":62},[97,1083,1084],{"class":99,"line":100},[97,1085,1086],{"class":314},"# .github\u002Fworkflows\u002Flint.yml\n",[97,1088,1089,1093,1095],{"class":99,"line":124},[97,1090,1092],{"class":1091},"s9eBZ","name",[97,1094,192],{"class":185},[97,1096,1097],{"class":107},"lint\n",[97,1099,1100,1103,1106,1109,1111,1114],{"class":99,"line":323},[97,1101,1102],{"class":114},"on",[97,1104,1105],{"class":185},": [",[97,1107,1108],{"class":107},"push",[97,1110,198],{"class":185},[97,1112,1113],{"class":107},"pull_request",[97,1115,729],{"class":185},[97,1117,1118],{"class":99,"line":339},[97,1119,343],{"emptyLinePlaceholder":342},[97,1121,1122,1125],{"class":99,"line":346},[97,1123,1124],{"class":1091},"permissions",[97,1126,392],{"class":185},[97,1128,1129,1132,1134],{"class":99,"line":355},[97,1130,1131],{"class":1091},"  contents",[97,1133,192],{"class":185},[97,1135,1136],{"class":107},"read\n",[97,1138,1139],{"class":99,"line":363},[97,1140,343],{"emptyLinePlaceholder":342},[97,1142,1143,1146],{"class":99,"line":368},[97,1144,1145],{"class":1091},"jobs",[97,1147,392],{"class":185},[97,1149,1150,1153],{"class":99,"line":373},[97,1151,1152],{"class":1091},"  ruff",[97,1154,392],{"class":185},[97,1156,1157,1160,1162],{"class":99,"line":395},[97,1158,1159],{"class":1091},"    runs-on",[97,1161,192],{"class":185},[97,1163,1164],{"class":107},"ubuntu-latest\n",[97,1166,1167,1170],{"class":99,"line":445},[97,1168,1169],{"class":1091},"    steps",[97,1171,392],{"class":185},[97,1173,1174,1177,1180,1182],{"class":99,"line":450},[97,1175,1176],{"class":185},"      - ",[97,1178,1179],{"class":1091},"uses",[97,1181,192],{"class":185},[97,1183,1184],{"class":107},"actions\u002Fcheckout@v4\n",[97,1186,1187,1189,1191,1193],{"class":99,"line":455},[97,1188,1176],{"class":185},[97,1190,1179],{"class":1091},[97,1192,192],{"class":185},[97,1194,1195],{"class":107},"astral-sh\u002Fsetup-uv@v6\n",[97,1197,1198,1200,1203,1205],{"class":99,"line":473},[97,1199,1176],{"class":185},[97,1201,1202],{"class":1091},"run",[97,1204,192],{"class":185},[97,1206,1207],{"class":107},"uvx ruff@0.16.10 check --output-format github .\n",[97,1209,1210,1212,1214,1216],{"class":99,"line":501},[97,1211,1176],{"class":185},[97,1213,1202],{"class":1091},[97,1215,192],{"class":185},[97,1217,1218],{"class":107},"uvx ruff@0.16.10 format --check --diff .\n",[97,1220,1221],{"class":99,"line":506},[97,1222,343],{"emptyLinePlaceholder":342},[97,1224,1225,1228],{"class":99,"line":511},[97,1226,1227],{"class":1091},"  mypy",[97,1229,392],{"class":185},[97,1231,1232,1234,1236],{"class":99,"line":531},[97,1233,1159],{"class":1091},[97,1235,192],{"class":185},[97,1237,1164],{"class":107},[97,1239,1240,1242],{"class":99,"line":572},[97,1241,1169],{"class":1091},[97,1243,392],{"class":185},[97,1245,1246,1248,1250,1252],{"class":99,"line":583},[97,1247,1176],{"class":185},[97,1249,1179],{"class":1091},[97,1251,192],{"class":185},[97,1253,1184],{"class":107},[97,1255,1256,1258,1260,1262],{"class":99,"line":597},[97,1257,1176],{"class":185},[97,1259,1179],{"class":1091},[97,1261,192],{"class":185},[97,1263,1195],{"class":107},[97,1265,1266,1269],{"class":99,"line":616},[97,1267,1268],{"class":1091},"        with",[97,1270,392],{"class":185},[97,1272,1273,1276,1278],{"class":99,"line":653},[97,1274,1275],{"class":1091},"          enable-cache",[97,1277,192],{"class":185},[97,1279,1280],{"class":114},"true\n",[97,1282,1283,1285,1287,1289],{"class":99,"line":690},[97,1284,1176],{"class":185},[97,1286,1202],{"class":1091},[97,1288,192],{"class":185},[97,1290,1291],{"class":107},"uv sync --locked --group lint\n",[97,1293,1294,1296,1298,1300],{"class":99,"line":696},[97,1295,1176],{"class":185},[97,1297,1202],{"class":1091},[97,1299,192],{"class":185},[97,1301,1302],{"class":107},"uv run mypy --output json src | python scripts\u002Fmypy_annotations.py\n",[10,1304,1305,1306,1309,1310,1313],{},"Ruff runs in its own job without installing the project — it needs no dependencies — so lint results arrive within seconds of a push. mypy needs the project and its dependencies installed to resolve types, so it gets the cached ",[64,1307,1308],{},"uv sync",". Pin both tool versions (here via ",[64,1311,1312],{},"ruff@…"," and the lint dependency group) so a new release with new rules lands as a deliberate change rather than a surprise failure on someone's unrelated pull request.",[77,1315],{"name":1316},"annot-terminal",[85,1318,1320],{"id":1319},"optional-sarif-for-code-scanning","Optional: SARIF for code scanning",[10,1322,1323],{},"For repositories with GitHub code scanning enabled, Ruff can write SARIF, which feeds the Security tab's alert list with history and dismissal tracking:",[56,1325,1327],{"className":1077,"code":1326,"language":1079,"meta":62,"style":62},"      - run: uvx ruff@0.16.10 check --output-format sarif -o ruff.sarif . || true\n      - uses: github\u002Fcodeql-action\u002Fupload-sarif@v3\n        with:\n          sarif_file: ruff.sarif\n          category: ruff\n",[64,1328,1329,1340,1351,1357,1367],{"__ignoreMap":62},[97,1330,1331,1333,1335,1337],{"class":99,"line":100},[97,1332,1176],{"class":185},[97,1334,1202],{"class":1091},[97,1336,192],{"class":185},[97,1338,1339],{"class":107},"uvx ruff@0.16.10 check --output-format sarif -o ruff.sarif . || true\n",[97,1341,1342,1344,1346,1348],{"class":99,"line":124},[97,1343,1176],{"class":185},[97,1345,1179],{"class":1091},[97,1347,192],{"class":185},[97,1349,1350],{"class":107},"github\u002Fcodeql-action\u002Fupload-sarif@v3\n",[97,1352,1353,1355],{"class":99,"line":323},[97,1354,1268],{"class":1091},[97,1356,392],{"class":185},[97,1358,1359,1362,1364],{"class":99,"line":339},[97,1360,1361],{"class":1091},"          sarif_file",[97,1363,192],{"class":185},[97,1365,1366],{"class":107},"ruff.sarif\n",[97,1368,1369,1372,1374],{"class":99,"line":346},[97,1370,1371],{"class":1091},"          category",[97,1373,192],{"class":185},[97,1375,1376],{"class":107},"ruff\n",[10,1378,1379,1380,1383,1384,1387],{},"That job needs ",[64,1381,1382],{},"security-events: write"," permission. SARIF suits security-relevant rules (Ruff's ",[64,1385,1386],{},"S"," rules from flake8-bandit, for example) better than style findings, which belong in the pull request annotations.",[25,1389,1391],{"id":1390},"ux-considerations","UX considerations",[10,1393,1394],{},"The users of a lint job are contributors trying to get a pull request green:",[30,1396,1397,1404,1415,1421,1427],{},[33,1398,1399,1403],{},[1400,1401,1402],"strong",{},"Fail with the fix."," Ruff's messages include a \"help\" line; the format check's diff shows the exact change. A contributor should never have to guess what the linter wants.",[33,1405,1406,1409,1410,1414],{},[1400,1407,1408],{},"Match local and CI."," The same Ruff and mypy versions and configuration in ",[19,1411,1413],{"href":1412},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fsetting-up-pre-commit-for-python-cli-repos\u002F","pre-commit"," and CI, so \"it passed locally\" means something.",[33,1416,1417,1420],{},[1400,1418,1419],{},"Keep it fast."," Separate jobs, no project install for Ruff, cached environments for mypy. A lint job that finishes before tests start is one people do not resent.",[33,1422,1423,1426],{},[1400,1424,1425],{},"Mind the annotation limits."," GitHub shows a limited number of annotations per step (currently 10 errors and 10 warnings per step in the diff view); fix a large backlog in a dedicated pull request rather than letting annotations scroll off.",[33,1428,1429,1436],{},[1400,1430,1431,1432,1435],{},"Use ",[64,1433,1434],{},"notice"," for advice."," Not every finding should block: emit non-blocking rules as notices so they inform without failing.",[77,1438],{"name":1439},"annot-severity",[25,1441,1443],{"id":1442},"testing-the-behaviour","Testing the behaviour",[10,1445,1446],{},"The converter is plain Python and worth a few tests, because a bug in it silently hides type errors:",[56,1448,1450],{"className":305,"code":1449,"language":307,"meta":62,"style":62},"# tests\u002Ftest_mypy_annotations.py\nimport io\nimport json\nimport sys\n\nfrom scripts.mypy_annotations import annotation, main\n\nFINDING = {\"file\": \"src\u002Fa,b.py\", \"line\": 4, \"column\": 10, \"end_line\": 4, \"end_column\": 12,\n           \"message\": \"Incompatible return value\\nsecond line\", \"hint\": None,\n           \"code\": \"return-value\", \"severity\": \"error\"}\n\n\ndef test_annotation_escapes_and_offsets_columns():\n    out = annotation(FINDING)\n    assert out.startswith(\"::error file=src\u002Fa%2Cb.py,line=4,col=11,\")\n    assert \"title=mypy (return-value)\" in out\n    assert out.endswith(\"::Incompatible return value%0Asecond line\")\n\n\ndef test_exit_code_reflects_errors(monkeypatch, capsys):\n    monkeypatch.setattr(sys, \"stdin\", io.StringIO(json.dumps(FINDING) + \"\\n\"))\n    assert main() == 1\n    monkeypatch.setattr(sys, \"stdin\", io.StringIO(\"Success: no issues found in 3 source files\\n\"))\n    assert main() == 0\n    assert \"Success\" in capsys.readouterr().out\n",[64,1451,1452,1457,1464,1470,1476,1480,1492,1496,1548,1574,1593,1597,1601,1611,1625,1638,1651,1663,1667,1671,1681,1707,1719,1737,1747],{"__ignoreMap":62},[97,1453,1454],{"class":99,"line":100},[97,1455,1456],{"class":314},"# tests\u002Ftest_mypy_annotations.py\n",[97,1458,1459,1461],{"class":99,"line":124},[97,1460,349],{"class":326},[97,1462,1463],{"class":185}," io\n",[97,1465,1466,1468],{"class":99,"line":323},[97,1467,349],{"class":326},[97,1469,352],{"class":185},[97,1471,1472,1474],{"class":99,"line":339},[97,1473,349],{"class":326},[97,1475,360],{"class":185},[97,1477,1478],{"class":99,"line":346},[97,1479,343],{"emptyLinePlaceholder":342},[97,1481,1482,1484,1487,1489],{"class":99,"line":355},[97,1483,327],{"class":326},[97,1485,1486],{"class":185}," scripts.mypy_annotations ",[97,1488,349],{"class":326},[97,1490,1491],{"class":185}," annotation, main\n",[97,1493,1494],{"class":99,"line":363},[97,1495,343],{"emptyLinePlaceholder":342},[97,1497,1498,1501,1504,1506,1508,1510,1513,1515,1517,1519,1521,1523,1525,1527,1530,1532,1534,1536,1538,1540,1542,1544,1546],{"class":99,"line":368},[97,1499,1500],{"class":114},"FINDING",[97,1502,1503],{"class":326}," =",[97,1505,540],{"class":185},[97,1507,189],{"class":107},[97,1509,192],{"class":185},[97,1511,1512],{"class":107},"\"src\u002Fa,b.py\"",[97,1514,198],{"class":185},[97,1516,201],{"class":107},[97,1518,192],{"class":185},[97,1520,206],{"class":114},[97,1522,198],{"class":185},[97,1524,211],{"class":107},[97,1526,192],{"class":185},[97,1528,1529],{"class":114},"10",[97,1531,198],{"class":185},[97,1533,221],{"class":107},[97,1535,192],{"class":185},[97,1537,206],{"class":114},[97,1539,198],{"class":185},[97,1541,230],{"class":107},[97,1543,192],{"class":185},[97,1545,235],{"class":114},[97,1547,650],{"class":185},[97,1549,1550,1553,1555,1558,1560,1563,1565,1567,1569,1572],{"class":99,"line":373},[97,1551,1552],{"class":107},"           \"message\"",[97,1554,192],{"class":185},[97,1556,1557],{"class":107},"\"Incompatible return value",[97,1559,432],{"class":114},[97,1561,1562],{"class":107},"second line\"",[97,1564,198],{"class":185},[97,1566,271],{"class":107},[97,1568,192],{"class":185},[97,1570,1571],{"class":114},"None",[97,1573,650],{"class":185},[97,1575,1576,1579,1581,1583,1585,1587,1589,1591],{"class":99,"line":395},[97,1577,1578],{"class":107},"           \"code\"",[97,1580,192],{"class":185},[97,1582,286],{"class":107},[97,1584,198],{"class":185},[97,1586,291],{"class":107},[97,1588,192],{"class":185},[97,1590,296],{"class":107},[97,1592,299],{"class":185},[97,1594,1595],{"class":99,"line":445},[97,1596,343],{"emptyLinePlaceholder":342},[97,1598,1599],{"class":99,"line":450},[97,1600,343],{"emptyLinePlaceholder":342},[97,1602,1603,1605,1608],{"class":99,"line":455},[97,1604,376],{"class":326},[97,1606,1607],{"class":103}," test_annotation_escapes_and_offsets_columns",[97,1609,1610],{"class":185},"():\n",[97,1612,1613,1616,1618,1621,1623],{"class":99,"line":473},[97,1614,1615],{"class":185},"    out ",[97,1617,537],{"class":326},[97,1619,1620],{"class":185}," annotation(",[97,1622,1500],{"class":114},[97,1624,442],{"class":185},[97,1626,1627,1630,1633,1636],{"class":99,"line":501},[97,1628,1629],{"class":326},"    assert",[97,1631,1632],{"class":185}," out.startswith(",[97,1634,1635],{"class":107},"\"::error file=src\u002Fa%2Cb.py,line=4,col=11,\"",[97,1637,442],{"class":185},[97,1639,1640,1642,1645,1648],{"class":99,"line":506},[97,1641,1629],{"class":326},[97,1643,1644],{"class":107}," \"title=mypy (return-value)\"",[97,1646,1647],{"class":326}," in",[97,1649,1650],{"class":185}," out\n",[97,1652,1653,1655,1658,1661],{"class":99,"line":511},[97,1654,1629],{"class":326},[97,1656,1657],{"class":185}," out.endswith(",[97,1659,1660],{"class":107},"\"::Incompatible return value%0Asecond line\"",[97,1662,442],{"class":185},[97,1664,1665],{"class":99,"line":531},[97,1666,343],{"emptyLinePlaceholder":342},[97,1668,1669],{"class":99,"line":572},[97,1670,343],{"emptyLinePlaceholder":342},[97,1672,1673,1675,1678],{"class":99,"line":583},[97,1674,376],{"class":326},[97,1676,1677],{"class":103}," test_exit_code_reflects_errors",[97,1679,1680],{"class":185},"(monkeypatch, capsys):\n",[97,1682,1683,1686,1689,1692,1694,1696,1698,1700,1702,1704],{"class":99,"line":597},[97,1684,1685],{"class":185},"    monkeypatch.setattr(sys, ",[97,1687,1688],{"class":107},"\"stdin\"",[97,1690,1691],{"class":185},", io.StringIO(json.dumps(",[97,1693,1500],{"class":114},[97,1695,641],{"class":185},[97,1697,644],{"class":326},[97,1699,766],{"class":107},[97,1701,432],{"class":114},[97,1703,415],{"class":107},[97,1705,1706],{"class":185},"))\n",[97,1708,1709,1711,1714,1716],{"class":99,"line":616},[97,1710,1629],{"class":326},[97,1712,1713],{"class":185}," main() ",[97,1715,994],{"class":326},[97,1717,1718],{"class":114}," 1\n",[97,1720,1721,1723,1725,1728,1731,1733,1735],{"class":99,"line":653},[97,1722,1685],{"class":185},[97,1724,1688],{"class":107},[97,1726,1727],{"class":185},", io.StringIO(",[97,1729,1730],{"class":107},"\"Success: no issues found in 3 source files",[97,1732,432],{"class":114},[97,1734,415],{"class":107},[97,1736,1706],{"class":185},[97,1738,1739,1741,1743,1745],{"class":99,"line":690},[97,1740,1629],{"class":326},[97,1742,1713],{"class":185},[97,1744,994],{"class":326},[97,1746,906],{"class":114},[97,1748,1749,1751,1754,1756],{"class":99,"line":696},[97,1750,1629],{"class":326},[97,1752,1753],{"class":107}," \"Success\"",[97,1755,1647],{"class":326},[97,1757,1758],{"class":185}," capsys.readouterr().out\n",[10,1760,1761],{},"Then prove the whole path once on a throwaway branch: introduce an unused import and a wrong return type, open a pull request, and check that both appear on the right lines in the diff view.",[25,1763,1765],{"id":1764},"conclusion","Conclusion",[10,1767,1768,1769,40,1771,1774,1775,1778],{},"Inline annotations make linters feel like reviewers rather than gatekeepers. Run Ruff with ",[64,1770,144],{},[64,1772,1773],{},"format --check --diff"," in a fast job of its own, pipe ",[64,1776,1777],{},"mypy --output json"," through a small converter that escapes correctly and keeps the exit code, pin both tools, and optionally send SARIF to code scanning for security rules. Contributors then see each problem next to the line that caused it, with the fix one glance away.",[25,1780,1782],{"id":1781},"frequently-asked-questions","Frequently asked questions",[85,1784,1786],{"id":1785},"can-i-get-annotations-without-writing-a-converter-for-mypy","Can I get annotations without writing a converter for mypy?",[10,1788,1789,1790,1793,1794,1797],{},"Yes: GitHub ",[14,1791,1792],{},"problem matchers"," are regular expressions registered for a job that turn matching log lines into annotations, and mypy's default ",[64,1795,1796],{},"file:line: error: message"," output is easy to match. The JSON converter is more robust against message formats containing colons, but a problem matcher needs no script.",[85,1799,1801],{"id":1800},"does-pyright-produce-annotations","Does Pyright produce annotations?",[10,1803,1804,1805,1808,1809,1813],{},"Pyright's ",[64,1806,1807],{},"--outputjson"," can be converted the same way, and community actions wrap Pyright with annotations built in. The setup in ",[19,1810,1812],{"href":1811},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-pyright-in-strict-mode-on-a-cli\u002F","running Pyright in strict mode on a CLI"," pairs well with this job.",[85,1815,1817],{"id":1816},"should-the-formatter-check-fail-the-build","Should the formatter check fail the build?",[10,1819,1820],{},"Yes, if the project uses a formatter at all. An unformatted file means local tooling is not set up, and failing early is kinder than accumulating formatting noise in later diffs.",[85,1822,1824],{"id":1823},"why-are-annotations-missing-on-some-findings","Why are annotations missing on some findings?",[10,1826,1827],{},"Findings on lines that are not part of the pull request's diff appear only in the job summary, not in the \"Files changed\" view. That is usually right — a pull request should not be blamed for existing problems — and it is why the lint job should run on the base branch too.",[85,1829,1831],{"id":1830},"should-ci-lint-only-the-files-a-pull-request-changed","Should CI lint only the files a pull request changed?",[10,1833,1834,1835,1838,1839,1842],{},"For Ruff, no: it lints a whole CLI codebase in well under a second, and linting everything catches problems a change causes in files it did not touch, such as an import that is now unused elsewhere. For mypy, also no — type errors are inherently cross-file — but its incremental cache (",[64,1836,1837],{},".mypy_cache",", restored between runs with ",[64,1840,1841],{},"actions\u002Fcache",") makes repeat runs fast. Restricting to changed files is an optimisation for much slower tools, not for these two.",[25,1844,1846],{"id":1845},"related","Related",[30,1848,1849,1855,1860,1865,1871],{},[33,1850,1851,1852],{},"Up: ",[19,1853,1854],{"href":21},"Linting and type checking CLI code",[33,1856,1857],{},[19,1858,1859],{"href":38},"Configuring Ruff for a CLI project",[33,1861,1862],{},[19,1863,1864],{"href":43},"Type-checking Click and Typer code with mypy",[33,1866,1867],{},[19,1868,1870],{"href":1869},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Frunning-pre-commit-in-ci\u002F","Running pre-commit in CI",[33,1872,1873],{},[19,1874,1876],{"href":1875},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci\u002F","Caching uv dependencies in CI",[1878,1879,1880],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .s9eBZ, html code.shiki .s9eBZ{--shiki-default:#22863A;--shiki-dark:#85E89D}",{"title":62,"searchDepth":124,"depth":124,"links":1882},[1883,1884,1885,1891,1892,1893,1894,1901],{"id":27,"depth":124,"text":28},{"id":50,"depth":124,"text":51},{"id":82,"depth":124,"text":83,"children":1886},[1887,1888,1889,1890],{"id":87,"depth":323,"text":88},{"id":165,"depth":323,"text":166},{"id":1073,"depth":323,"text":1074},{"id":1319,"depth":323,"text":1320},{"id":1390,"depth":124,"text":1391},{"id":1442,"depth":124,"text":1443},{"id":1764,"depth":124,"text":1765},{"id":1781,"depth":124,"text":1782,"children":1895},[1896,1897,1898,1899,1900],{"id":1785,"depth":323,"text":1786},{"id":1800,"depth":323,"text":1801},{"id":1816,"depth":323,"text":1817},{"id":1823,"depth":323,"text":1824},{"id":1830,"depth":323,"text":1831},{"id":1845,"depth":124,"text":1846},"2026-10-02","Run Ruff lint, Ruff format and mypy in GitHub Actions so findings appear inline on pull requests: github output, a mypy JSON converter, SARIF and fast jobs.","intermediate",false,"md",{},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations",{"title":5,"description":1903},"project-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations\u002Findex",[1912,1913,1914,1915,1916],"ruff","mypy","ci","github-actions","code-review","4MKvtcI094h-Vq_rCeLU1j_PoOqxqPvY0YcqH2YTIoU",[1919,1922,1925,1928,1931,1934,1937,1940,1943,1946,1949,1952,1955,1958,1961,1964,1967,1970,1973,1976,1979,1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024,2027,2030,2033,2036,2039,2042,2045,2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2078,2081,2084,2087,2090,2093,2096,2099,2102,2105,2108,2111,2114,2117,2120,2123,2126,2129,2132,2135,2138,2141,2144,2147,2150,2153,2156,2159,2162,2165,2168,2171,2174,2177,2180,2183,2186,2189,2192,2195,2198,2201,2204,2207,2210,2213,2216,2219,2222,2225,2228,2231,2234,2237,2240,2243,2246,2249,2252,2255,2258,2261,2264,2267,2270,2273,2276,2279,2282,2285,2288,2291,2294,2297,2300,2303,2306,2309,2312,2315,2318,2321,2324,2327,2330,2333,2336,2339,2342,2345,2348,2351,2354,2357,2360,2363,2366,2369,2372,2375,2378,2381,2384,2387,2390,2393,2396,2399,2402,2405,2408,2411,2414,2417,2420,2423,2426,2429,2432,2435,2438,2441,2444,2447,2450,2453,2456,2459,2462,2465,2468,2471,2474,2477,2480,2483,2486,2489,2492,2495,2498,2501,2504,2507,2510,2513,2516,2519,2522,2525,2528,2531,2534,2537,2540,2543,2546,2549,2552,2555,2558,2561,2564,2567,2570,2573,2576,2579,2582,2585,2588,2591,2594,2597,2600,2603,2606,2609,2612,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736,2739,2742,2745,2748,2751,2754,2757,2760],{"path":1920,"title":1921},"\u002Fabout","About Python CLI Toolcraft",{"path":1923,"title":1924},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1926,"title":1927},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1929,"title":1930},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dates-and-durations-in-cli-arguments","Validating Dates and Durations in Python CLI Arguments",{"path":1932,"title":1933},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1935,"title":1936},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1938,"title":1939},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1941,"title":1942},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1944,"title":1945},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1947,"title":1948},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbuilding-your-first-textual-app","Building Your First Textual App for a Python CLI",{"path":1950,"title":1951},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fchoosing-between-a-cli-a-prompt-flow-and-a-tui","Choosing Between a CLI, a Prompt Flow and a TUI",{"path":1953,"title":1954},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1956,"title":1957},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Frunning-background-work-in-textual-with-workers","Running Background Work in Textual with Workers",{"path":1959,"title":1960},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1962,"title":1963},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1965,"title":1966},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output","Adding Examples and Epilogs to Help Output",{"path":1968,"title":1969},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1971,"title":1972},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fgenerating-man-pages-and-docs-from-a-cli","Generating Man Pages and Docs from a CLI",{"path":1974,"title":1975},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1977,"title":1978},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Frich-formatted-help-with-rich-click","Rich-Formatted Help for Click CLIs with rich-click",{"path":1980,"title":1981},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1983,"title":1984},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1986,"title":1987},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1989,"title":1990},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1992,"title":1993},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Ffixing-unicode-and-encoding-errors-on-windows","Fixing Unicode and Encoding Errors on Windows in Python CLIs",{"path":1995,"title":1996},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1998,"title":1999},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2001,"title":2002},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color","Respecting NO_COLOR and FORCE_COLOR in Python CLIs",{"path":2004,"title":2005},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fsupporting-dumb-terminals-and-screen-readers","Supporting Dumb Terminals and Screen Readers in a Python CLI",{"path":2007,"title":2008},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2010,"title":2011},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdesigning-an-exception-hierarchy-for-a-cli","Designing an Exception Hierarchy for a Python CLI",{"path":2013,"title":2014},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fdid-you-mean-suggestions-for-mistyped-input","Did You Mean…? Suggestions for Mistyped CLI Input",{"path":2016,"title":2017},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2019,"title":2020},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2022,"title":2023},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2025,"title":2026},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Freporting-machine-readable-errors-in-json-mode","Reporting Machine-Readable Errors in JSON Mode",{"path":2028,"title":2029},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2031,"title":2032},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2034,"title":2035},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fdiscovering-project-config-files-by-walking-up-directories","Discovering Project Config Files by Walking Up Directories",{"path":2037,"title":2038},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2040,"title":2041},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Floading-yaml-configs-safely-in-cli-apps","Loading YAML configs safely in CLI apps",{"path":2043,"title":2044},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2046,"title":2047},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2049,"title":2050},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fvalidating-config-files-with-json-schema","Validating Config Files with JSON Schema in a Python CLI",{"path":2052,"title":2053},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fwriting-a-config-init-and-edit-command","Writing a Config Init and Edit Command for a Python CLI",{"path":2055,"title":2056},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2058,"title":2059},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fadding-progress-bars-and-spinners-to-python-clis","Progress Bars and Spinners for Python CLIs",{"path":2061,"title":2062},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2064,"title":2065},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-tree-views-with-rich","Building Tree Views with Rich in a Python CLI",{"path":2067,"title":2068},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2070,"title":2071},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2073,"title":2074},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-markdown-and-syntax-highlighting-with-rich","Rendering Markdown and Syntax Highlighting with Rich",{"path":2076,"title":2077},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2079,"title":2080},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2082,"title":2083},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fadding-a-format-flag-for-table-json-and-csv","Adding a Format Flag for Table, JSON and CSV Output",{"path":2085,"title":2086},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fcustom-output-templates-with-a-format-string","Custom Output Templates with a Format String in Python CLIs",{"path":2088,"title":2089},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fexporting-cli-results-to-files","Exporting CLI Results to Files from a Python CLI",{"path":2091,"title":2092},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2094,"title":2095},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fselecting-fields-and-columns-from-cli-output","Selecting Fields and Columns from Python CLI Output",{"path":2097,"title":2098},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis\u002Fwriting-csv-and-tsv-output-correctly","Writing CSV and TSV Output Correctly from a Python CLI",{"path":2100,"title":2101},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2103,"title":2104},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fdynamic-completion-values-from-apis-and-files","Dynamic Completion Values from APIs and Files",{"path":2106,"title":2107},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fenabling-tab-completion-in-click-and-typer","Enabling Tab Completion in Click and Typer",{"path":2109,"title":2110},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2112,"title":2113},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Finstalling-shell-completion-for-bash-zsh-fish","Installing Shell Completion for bash, zsh, fish",{"path":2115,"title":2116},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2118,"title":2119},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2121,"title":2122},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-trace-ids-and-context-to-cli-logs","Adding Trace IDs and Context to Python CLI Logs",{"path":2124,"title":2125},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2127,"title":2128},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2130,"title":2131},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2133,"title":2134},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fseparating-logs-from-program-output","Separating Logs from Program Output in a Python CLI",{"path":2136,"title":2137},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2139,"title":2140},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fwriting-rotating-log-files-from-a-cli","Writing Rotating Log Files from a Python CLI",{"path":2142,"title":2143},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2145,"title":2146},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2148,"title":2149},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2151,"title":2152},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2154,"title":2155},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fnull-delimited-input-and-xargs-compatibility","Null-Delimited Input and xargs Compatibility in Python CLIs",{"path":2157,"title":2158},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fprocessing-large-files-and-ndjson-streams","Processing Large Files and NDJSON Streams in Python CLIs",{"path":2160,"title":2161},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2163,"title":2164},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fbuilding-an-api-client-cli-with-httpx","Building an API Client CLI with httpx",{"path":2166,"title":2167},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2169,"title":2170},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2172,"title":2173},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx","Mocking HTTP in Python CLI Tests with respx",{"path":2175,"title":2176},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2178,"title":2179},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2181,"title":2182},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fretries-and-backoff-for-cli-http-calls","Retries and Backoff for CLI HTTP Calls",{"path":2184,"title":2185},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fuploading-files-with-multipart-and-progress","Uploading Files with Multipart and Progress in a Python CLI",{"path":2187,"title":2188},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fcancelling-async-tasks-on-ctrl-c","Cancelling Async Tasks on Ctrl+C in Python CLIs",{"path":2190,"title":2191},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2193,"title":2194},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2196,"title":2197},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2199,"title":2200},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2202,"title":2203},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frunning-async-code-in-typer-and-click","Running Async Code in Typer and Click",{"path":2205,"title":2206},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fshowing-progress-for-concurrent-tasks","Showing Progress for Concurrent Tasks in a Python CLI",{"path":2208,"title":2209},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2211,"title":2212},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2214,"title":2215},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2217,"title":2218},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fhandling-file-permissions-and-umask-in-clis","Handling File Permissions and umask in Python CLIs",{"path":2220,"title":2221},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2223,"title":2224},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2226,"title":2227},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2229,"title":2230},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwalking-directory-trees-with-ignore-rules","Walking Directory Trees with Ignore Rules in a Python CLI",{"path":2232,"title":2233},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2235,"title":2236},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2238,"title":2239},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fcaching-http-responses-on-disk-in-a-cli","Caching HTTP Responses on Disk in a Python CLI",{"path":2241,"title":2242},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2244,"title":2245},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fmigrating-a-cli-sqlite-schema","Migrating a CLI’s SQLite Schema Between Releases",{"path":2247,"title":2248},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Frecording-and-querying-cli-run-history","Recording and Querying CLI Run History in SQLite",{"path":2250,"title":2251},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis\u002Fstoring-cli-state-in-sqlite","Storing CLI State in SQLite with a Small Repository Class",{"path":2253,"title":2254},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fbuilding-a-watch-mode-with-watchfiles","Building a Watch Mode with watchfiles in Python",{"path":2256,"title":2257},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2259,"title":2260},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhealth-checks-and-heartbeats-for-long-running-clis","Health Checks and Heartbeats for Long-Running CLIs",{"path":2262,"title":2263},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2265,"title":2266},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2268,"title":2269},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-as-a-systemd-service","Running a Python CLI as a systemd Service",{"path":2271,"title":2272},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Frunning-a-cli-on-a-schedule-with-cron-and-systemd","Running a Python CLI on a Schedule with cron and systemd",{"path":2274,"title":2275},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fsending-cli-logs-to-journald-and-syslog","Sending Python CLI Logs to journald and syslog",{"path":2277,"title":2278},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2280,"title":2281},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2283,"title":2284},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2286,"title":2287},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2289,"title":2290},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Flaunching-the-users-editor-from-a-cli","Launching the User’s Editor from a Python CLI",{"path":2292,"title":2293},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2295,"title":2296},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2298,"title":2299},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fwrapping-git-and-other-tools-from-a-python-cli","Wrapping git and Other Tools from a Python CLI",{"path":2301,"title":2302},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2304,"title":2305},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2307,"title":2308},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Freading-secrets-from-env-and-files","Reading Secrets from Env Vars and Files in CLIs",{"path":2310,"title":2311},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fredacting-secrets-from-cli-output-and-logs","Redacting Secrets from CLI Output and Logs",{"path":2313,"title":2314},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2316,"title":2317},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2319,"title":2320},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2322,"title":2323},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version","Checking PyPI for a Newer Version of Your Python CLI",{"path":2325,"title":2326},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2328,"title":2329},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fopt-in-usage-telemetry-for-python-clis","Opt-In Usage Telemetry for Python CLIs Done Responsibly",{"path":2331,"title":2332},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fself-upgrading-a-cli-installed-with-pipx-or-uv","Self-Upgrading a Python CLI Installed with pipx or uv",{"path":2334,"title":2335},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fshowing-non-blocking-update-notices","Showing Non-Blocking Update Notices in a Python CLI",{"path":2337,"title":2338},"\u002F","Python CLI Toolcraft",{"path":2340,"title":2341},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2343,"title":2344},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2346,"title":2347},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2349,"title":2350},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2352,"title":2353},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fusage-string-driven-clis-with-docopt-ng","Usage-String Driven Python CLIs with docopt-ng",{"path":2355,"title":2356},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Favoiding-import-time-side-effects","Avoiding Import-Time Side Effects in a Python CLI",{"path":2358,"title":2359},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fcaching-expensive-work-between-cli-runs","Caching Expensive Work Between Python CLI Runs",{"path":2361,"title":2362},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2364,"title":2365},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2367,"title":2368},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2370,"title":2371},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2373,"title":2374},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2376,"title":2377},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2379,"title":2380},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2382,"title":2383},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargument-groups-and-help-formatting-in-argparse","Argument Groups and Help Formatting in argparse",{"path":2385,"title":2386},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2388,"title":2389},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2391,"title":2392},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2394,"title":2395},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Freading-arguments-from-files-with-fromfile-prefix-chars","Reading Arguments from Files with argparse’s fromfile_prefix_chars",{"path":2397,"title":2398},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2400,"title":2401},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fadding-dry-run-and-confirmation-to-destructive-commands","Adding Dry-Run and Confirmation to Destructive Commands",{"path":2403,"title":2404},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2406,"title":2407},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Ffollowing-posix-and-gnu-argument-conventions","Following POSIX and GNU Argument Conventions in Python",{"path":2409,"title":2410},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fglobal-options-vs-per-command-options","Global Options vs Per-Command Options in Python CLIs",{"path":2412,"title":2413},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2415,"title":2416},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2418,"title":2419},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2421,"title":2422},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2424,"title":2425},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2427,"title":2428},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2430,"title":2431},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2433,"title":2434},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2436,"title":2437},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2439,"title":2440},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2442,"title":2443},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fwriting-a-plugin-for-an-existing-cli","Writing a Plugin for an Existing CLI",{"path":2445,"title":2446},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fbest-practices-for-python-cli-entry-points","Best practices for Python CLI entry points",{"path":2448,"title":2449},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2451,"title":2452},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project","Structuring a Large Python CLI Project",{"path":2454,"title":2455},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2457,"title":2458},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Foffering-a-python-api-alongside-your-cli","Offering a Python API Alongside Your CLI",{"path":2460,"title":2461},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2463,"title":2464},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2466,"title":2467},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2469,"title":2470},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fend-to-end-testing-an-installed-cli","End-to-End Testing an Installed Python CLI",{"path":2472,"title":2473},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2475,"title":2476},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2478,"title":2479},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmocking-filesystem-and-network-in-cli-tests","Mocking the Filesystem and Network in CLI Tests",{"path":2481,"title":2482},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2484,"title":2485},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2487,"title":2488},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2490,"title":2491},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2493,"title":2494},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2496,"title":2497},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2499,"title":2500},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-a-cli-with-subcommands-in-click","Building a CLI with subcommands in Click",{"path":2502,"title":2503},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2505,"title":2506},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fchoices-and-enums-in-typer-and-click","Choices and Enums in Typer and Click Options",{"path":2508,"title":2509},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fclick-option-callbacks-and-eager-options","Click Option Callbacks and Eager Options Explained",{"path":2511,"title":2512},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fconverting-a-click-app-to-typer","Converting a Click App to Typer",{"path":2514,"title":2515},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2517,"title":2518},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Frich-markup-and-help-panels-in-typer","Rich Markup and Help Panels in Typer",{"path":2520,"title":2521},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2523,"title":2524},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2526,"title":2527},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2529,"title":2530},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2532,"title":2533},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2535,"title":2536},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-a-cli-docker-image-from-ci","Publishing a Python CLI as a Docker Image from CI",{"path":2538,"title":2539},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fpublishing-to-pypi-with-trusted-publishing","Publishing a CLI to PyPI with Trusted Publishing",{"path":2541,"title":2542},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Frunning-cli-tests-on-windows-and-macos-runners","Running Python CLI Tests on Windows and macOS Runners",{"path":2544,"title":2545},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fsmoke-testing-the-built-wheel-in-ci","Smoke-Testing the Built Wheel of a Python CLI in CI",{"path":2547,"title":2548},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Ftesting-a-cli-across-python-versions-with-github-actions","Testing a CLI Across Python Versions in GitHub Actions",{"path":2550,"title":2551},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2553,"title":2554},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2556,"title":2557},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2559,"title":2560},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2562,"title":2563},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2565,"title":2566},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2568,"title":2569},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2571,"title":2572},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2574,"title":2575},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2577,"title":2578},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2580,"title":2581},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2583,"title":2584},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2586,"title":2587},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2589,"title":2590},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2592,"title":2593},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fshipping-a-cli-as-a-zipapp-with-shiv","Shipping a CLI as a Zipapp with shiv",{"path":2595,"title":2596},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2598,"title":2599},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2601,"title":2602},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fenforcing-import-boundaries-in-a-cli-codebase","Enforcing Import Boundaries in a Python CLI Codebase",{"path":2604,"title":2605},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ffinding-unused-code-and-dependencies-with-vulture-and-deptry","Finding Unused Code and Dependencies with vulture and deptry",{"path":2607,"title":2608},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2610,"title":2611},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-pyright-in-strict-mode-on-a-cli","Running Pyright in Strict Mode on a Python CLI",{"path":1908,"title":5},{"path":2614,"title":2615},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Ftype-checking-click-and-typer-code-with-mypy","Type-Checking Click and Typer Code with mypy",{"path":2617,"title":2618},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2620,"title":2621},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2623,"title":2624},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fderiving-versions-from-git-tags-with-hatch-vcs","Deriving CLI Versions from Git Tags with hatch-vcs",{"path":2626,"title":2627},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2629,"title":2630},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2632,"title":2633},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2635,"title":2636},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fshipping-pre-releases-and-release-candidates","Shipping Pre-Releases and Release Candidates of a Python CLI",{"path":2638,"title":2639},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2641,"title":2642},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2644,"title":2645},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fchoosing-a-build-backend-for-a-python-cli","Choosing a Build Backend for a Python CLI",{"path":2647,"title":2648},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2650,"title":2651},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2653,"title":2654},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2656,"title":2657},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fwriting-pyproject-toml-metadata-for-a-cli","Writing pyproject.toml Metadata for a Python CLI",{"path":2662,"title":2663},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2665,"title":2666},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2668,"title":2669},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2671,"title":2672},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmigrating-a-cli-from-poetry-to-uv","Migrating a Python CLI from Poetry to uv",{"path":2674,"title":2675},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2677,"title":2678},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2680,"title":2681},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2683,"title":2684},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2686,"title":2687},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fkeeping-hook-versions-current-with-autoupdate","Keeping pre-commit Hook Versions Current with autoupdate",{"path":2689,"title":2690},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Frunning-pre-commit-in-ci","Running pre-commit in CI for a Python CLI Repository",{"path":2692,"title":2693},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fsetting-up-pre-commit-for-python-cli-repos","Setting up pre-commit for Python CLI repos",{"path":2695,"title":2696},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fshipping-your-cli-as-a-pre-commit-hook","Shipping Your Python CLI as a pre-commit Hook",{"path":2698,"title":2699},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fspeeding-up-slow-pre-commit-hooks","Speeding Up Slow pre-commit Hooks in a CLI Repository",{"path":2701,"title":2702},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects\u002Fwriting-local-pre-commit-hooks-in-python","Writing Local pre-commit Hooks in Python",{"path":2704,"title":2705},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fauditing-dependencies-with-pip-audit","Auditing a Python CLI’s Dependencies with pip-audit",{"path":2707,"title":2708},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fgenerating-an-sbom-for-a-python-cli","Generating an SBOM for a Python CLI Release",{"path":2710,"title":2711},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2713,"title":2714},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2716,"title":2717},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2719,"title":2720},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fbuilding-and-publishing-a-cli-with-uv","Building and Publishing a Python CLI with uv",{"path":2722,"title":2723},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2725,"title":2726},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Flocking-and-syncing-cli-dependencies-with-uv","Locking and Syncing a Python CLI’s Dependencies with uv",{"path":2728,"title":2729},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Frunning-one-off-cli-scripts-with-uv-run","Running One-Off CLI Scripts with uv run and PEP 723",{"path":2731,"title":2732},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fusing-private-package-indexes-with-uv","Using Private Package Indexes with uv for Internal CLIs",{"path":2734,"title":2735},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-init-vs-poetry-init-for-cli-tools","uv init vs poetry init for CLI tools",{"path":2737,"title":2738},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-tool-install-vs-pipx-for-clis","uv tool install vs pipx for CLIs",{"path":2740,"title":2741},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2743,"title":2744},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fdebugging-wrong-python-and-wrong-venv-problems","Debugging Wrong-Python and Wrong-Venv Problems in CLIs",{"path":2746,"title":2747},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668","PEP 668 and Python CLIs: the externally-managed-environment Error",{"path":2749,"title":2750},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2752,"title":2753},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2755,"title":2756},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2758,"title":2759},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2761,"title":2762},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967542609]