[{"data":1,"prerenderedAt":2793},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands\u002F":3,"content-directory":1948},{"id":4,"title":5,"body":6,"date":1933,"description":1934,"difficulty":1935,"draft":1936,"extension":1937,"meta":1938,"navigation":174,"path":1939,"seo":1940,"stem":1941,"tags":1942,"updated":1933,"__hash__":1947},"content\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands\u002Findex.md","Transcript Tests for Python CLI Commands",{"type":7,"value":8,"toc":1916},"minimark",[9,61,66,84,88,98,102,117,121,135,1347,1375,1378,1384,1395,1398,1402,1405,1412,1423,1427,1430,1477,1481,1484,1795,1810,1814,1817,1821,1826,1829,1833,1848,1852,1859,1863,1868,1872,1878,1882,1912],[10,11,12,13,17,18,17,21,24,25,28,29,33,34,38,39,42,43,46,47,50,51,54,55,60],"p",{},"Most CLI tests are written as Python: invoke the command with ",[14,15,16],"code",{},"CliRunner",", assert on ",[14,19,20],{},"result.output",[14,22,23],{},"result.exit_code",". That works, but for commands whose whole point is their output, the Python gets in the way. The expected text is buried in string literals, a ten-line table becomes ten ",[14,26,27],{},"in"," assertions, and nobody reading the test can see at a glance what the user would see. ",[30,31,32],"strong",{},"Transcript tests"," flip it around: the test ",[35,36,37],"em",{},"is"," a terminal session — a ",[14,40,41],{},"$ mytool …"," line, followed by exactly what should appear, followed by the exit code if it is not zero. Tools like ",[14,44,45],{},"cram"," and ",[14,48,49],{},"prysk"," popularised the format; with pytest's collection hooks, a CLI can support it in about eighty lines of ",[14,52,53],{},"conftest.py",", running commands in-process and showing a diff when output changes. This guide builds that collector and covers when transcripts beat ordinary tests and when they do not. It belongs to the ",[56,57,59],"a",{"href":58},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002F","CLI testing topic",".",[62,63,65],"h2",{"id":64},"prerequisites","Prerequisites",[67,68,69,78],"ul",{},[70,71,72,73,77],"li",{},"pytest and a Typer or Click CLI; ",[56,74,76],{"href":75},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner\u002F","testing Click commands with CliRunner"," covers the runner used underneath.",[70,79,80,81,83],{},"A rough idea of pytest plugins: ",[14,82,53],{}," hooks are enough here.",[62,85,87],{"id":86},"the-format","The format",[89,90,96],"pre",{"className":91,"code":93,"language":94,"meta":95},[92],"language-text","# tests\u002Ftranscripts\u002Fgreet.t — greeting basics\n$ mytool greet Ann\nhello Ann\n\n$ mytool greet Bo --times 2\nhello Bo\nhello Bo\n\n$ mytool greet\nUsage: mytool greet [OPTIONS] {name}\nTry 'mytool greet --help' for help.\n╭─ Error ──────────────────────────────────────────────────────────────────────╮\n│ Missing argument 'name'.                                                     │\n╰──────────────────────────────────────────────────────────────────────────────╯\n[exit 2]\n","text","",[14,97,93],{"__ignoreMap":95},[99,100],"inline-diagram",{"name":101},"transcript-format",[10,103,104,105,108,109,112,113,116],{},"Lines starting with ",[14,106,107],{},"$ "," are commands; everything up to the next command is the expected combined output; an ",[14,110,111],{},"[exit N]"," line states a non-zero exit code; ",[14,114,115],{},"#"," lines are comments; trailing blank lines are ignored. The transcript reads like documentation — which it partly is — and a reviewer sees immediately what changed in a pull request that alters output.",[62,118,120],{"id":119},"the-recipe","The recipe",[10,122,123,124,127,128,131,132,134],{},"The collector parses ",[14,125,126],{},".t"," files under ",[14,129,130],{},"tests\u002Ftranscripts\u002F",", turns each command into a pytest item, runs it in-process with ",[14,133,16],{},", and reports a unified diff when output or exit code differs:",[89,136,140],{"className":137,"code":138,"language":139,"meta":95,"style":95},"language-python shiki shiki-themes github-light github-dark","# tests\u002Fconftest.py\nfrom __future__ import annotations\n\nimport difflib\nimport shlex\nfrom dataclasses import dataclass, field\nfrom pathlib import Path\n\nimport pytest\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import app\n\n\n@dataclass\nclass Step:\n    line: int\n    args: list[str]\n    expected: list[str] = field(default_factory=list)\n    exit_code: int = 0\n\n\ndef parse_transcript(text: str) -> list[Step]:\n    steps: list[Step] = []\n    for number, raw in enumerate(text.splitlines(), start=1):\n        if raw.startswith(\"$ \"):\n            args = shlex.split(raw[2:])\n            if args[:1] != [\"mytool\"]:\n                raise ValueError(f\"line {number}: commands must start with 'mytool'\")\n            steps.append(Step(number, args[1:]))\n        elif raw.startswith(\"[exit \") and steps:\n            steps[-1].exit_code = int(raw[6:-1])\n        elif raw.startswith(\"#\") or not steps:\n            continue\n        else:\n            steps[-1].expected.append(raw)\n    for step in steps:\n        while step.expected and step.expected[-1] == \"\":\n            step.expected.pop()\n    return steps\n\n\ndef pytest_collect_file(parent, file_path: Path):\n    if file_path.suffix == \".t\" and \"transcripts\" in file_path.parts:\n        return TranscriptFile.from_parent(parent, path=file_path)\n\n\nclass TranscriptFile(pytest.File):\n    def collect(self):\n        for step in parse_transcript(self.path.read_text(encoding=\"utf-8\")):\n            yield TranscriptItem.from_parent(\n                self, name=f\"line{step.line}: {shlex.join(step.args)}\", step=step)\n\n\nclass TranscriptMismatch(AssertionError):\n    def __init__(self, step: Step, actual: list[str], code: int) -> None:\n        diff = \"\\n\".join(difflib.unified_diff(step.expected, actual, \"expected\", \"actual\",\n                                              lineterm=\"\"))\n        super().__init__(f\"$ mytool {shlex.join(step.args)}\\n\"\n                         f\"exit code: expected {step.exit_code}, got {code}\\n{diff}\")\n\n\nclass TranscriptItem(pytest.Item):\n    def __init__(self, *, step: Step, **kwargs) -> None:\n        super().__init__(**kwargs)\n        self.step = step\n\n    def runtest(self) -> None:\n        result = CliRunner().invoke(app, self.step.args, prog_name=\"mytool\",\n                                    env={\"COLUMNS\": \"80\", \"NO_COLOR\": \"1\"})\n        actual = result.output.rstrip(\"\\n\").splitlines()\n        if actual != self.step.expected or result.exit_code != self.step.exit_code:\n            raise TranscriptMismatch(self.step, actual, result.exit_code)\n\n    def repr_failure(self, excinfo):\n        if isinstance(excinfo.value, TranscriptMismatch):\n            return str(excinfo.value)\n        return super().repr_failure(excinfo)\n\n    def reportinfo(self):\n        return self.path, self.step.line - 1, self.name\n","python",[14,141,142,151,169,176,185,193,206,219,224,232,245,250,263,268,273,280,292,301,313,342,357,362,367,384,395,423,438,455,480,512,523,543,578,598,604,612,624,636,664,670,679,684,689,700,726,743,748,753,773,785,815,824,873,878,883,898,924,954,968,997,1032,1037,1042,1061,1087,1103,1117,1122,1137,1162,1193,1213,1241,1255,1260,1271,1282,1294,1305,1310,1320],{"__ignoreMap":95},[143,144,147],"span",{"class":145,"line":146},"line",1,[143,148,150],{"class":149},"sJ8bj","# tests\u002Fconftest.py\n",[143,152,154,158,162,165],{"class":145,"line":153},2,[143,155,157],{"class":156},"szBVR","from",[143,159,161],{"class":160},"sj4cs"," __future__",[143,163,164],{"class":156}," import",[143,166,168],{"class":167},"sVt8B"," annotations\n",[143,170,172],{"class":145,"line":171},3,[143,173,175],{"emptyLinePlaceholder":174},true,"\n",[143,177,179,182],{"class":145,"line":178},4,[143,180,181],{"class":156},"import",[143,183,184],{"class":167}," difflib\n",[143,186,188,190],{"class":145,"line":187},5,[143,189,181],{"class":156},[143,191,192],{"class":167}," shlex\n",[143,194,196,198,201,203],{"class":145,"line":195},6,[143,197,157],{"class":156},[143,199,200],{"class":167}," dataclasses ",[143,202,181],{"class":156},[143,204,205],{"class":167}," dataclass, field\n",[143,207,209,211,214,216],{"class":145,"line":208},7,[143,210,157],{"class":156},[143,212,213],{"class":167}," pathlib ",[143,215,181],{"class":156},[143,217,218],{"class":167}," Path\n",[143,220,222],{"class":145,"line":221},8,[143,223,175],{"emptyLinePlaceholder":174},[143,225,227,229],{"class":145,"line":226},9,[143,228,181],{"class":156},[143,230,231],{"class":167}," pytest\n",[143,233,235,237,240,242],{"class":145,"line":234},10,[143,236,157],{"class":156},[143,238,239],{"class":167}," typer.testing ",[143,241,181],{"class":156},[143,243,244],{"class":167}," CliRunner\n",[143,246,248],{"class":145,"line":247},11,[143,249,175],{"emptyLinePlaceholder":174},[143,251,253,255,258,260],{"class":145,"line":252},12,[143,254,157],{"class":156},[143,256,257],{"class":167}," mytool.cli ",[143,259,181],{"class":156},[143,261,262],{"class":167}," app\n",[143,264,266],{"class":145,"line":265},13,[143,267,175],{"emptyLinePlaceholder":174},[143,269,271],{"class":145,"line":270},14,[143,272,175],{"emptyLinePlaceholder":174},[143,274,276],{"class":145,"line":275},15,[143,277,279],{"class":278},"sScJk","@dataclass\n",[143,281,283,286,289],{"class":145,"line":282},16,[143,284,285],{"class":156},"class",[143,287,288],{"class":278}," Step",[143,290,291],{"class":167},":\n",[143,293,295,298],{"class":145,"line":294},17,[143,296,297],{"class":167},"    line: ",[143,299,300],{"class":160},"int\n",[143,302,304,307,310],{"class":145,"line":303},18,[143,305,306],{"class":167},"    args: list[",[143,308,309],{"class":160},"str",[143,311,312],{"class":167},"]\n",[143,314,316,319,321,324,327,330,334,336,339],{"class":145,"line":315},19,[143,317,318],{"class":167},"    expected: list[",[143,320,309],{"class":160},[143,322,323],{"class":167},"] ",[143,325,326],{"class":156},"=",[143,328,329],{"class":167}," field(",[143,331,333],{"class":332},"s4XuR","default_factory",[143,335,326],{"class":156},[143,337,338],{"class":160},"list",[143,340,341],{"class":167},")\n",[143,343,345,348,351,354],{"class":145,"line":344},20,[143,346,347],{"class":167},"    exit_code: ",[143,349,350],{"class":160},"int",[143,352,353],{"class":156}," =",[143,355,356],{"class":160}," 0\n",[143,358,360],{"class":145,"line":359},21,[143,361,175],{"emptyLinePlaceholder":174},[143,363,365],{"class":145,"line":364},22,[143,366,175],{"emptyLinePlaceholder":174},[143,368,370,373,376,379,381],{"class":145,"line":369},23,[143,371,372],{"class":156},"def",[143,374,375],{"class":278}," parse_transcript",[143,377,378],{"class":167},"(text: ",[143,380,309],{"class":160},[143,382,383],{"class":167},") -> list[Step]:\n",[143,385,387,390,392],{"class":145,"line":386},24,[143,388,389],{"class":167},"    steps: list[Step] ",[143,391,326],{"class":156},[143,393,394],{"class":167}," []\n",[143,396,398,401,404,406,409,412,415,417,420],{"class":145,"line":397},25,[143,399,400],{"class":156},"    for",[143,402,403],{"class":167}," number, raw ",[143,405,27],{"class":156},[143,407,408],{"class":160}," enumerate",[143,410,411],{"class":167},"(text.splitlines(), ",[143,413,414],{"class":332},"start",[143,416,326],{"class":156},[143,418,419],{"class":160},"1",[143,421,422],{"class":167},"):\n",[143,424,426,429,432,436],{"class":145,"line":425},26,[143,427,428],{"class":156},"        if",[143,430,431],{"class":167}," raw.startswith(",[143,433,435],{"class":434},"sZZnC","\"$ \"",[143,437,422],{"class":167},[143,439,441,444,446,449,452],{"class":145,"line":440},27,[143,442,443],{"class":167},"            args ",[143,445,326],{"class":156},[143,447,448],{"class":167}," shlex.split(raw[",[143,450,451],{"class":160},"2",[143,453,454],{"class":167},":])\n",[143,456,458,461,464,466,468,471,474,477],{"class":145,"line":457},28,[143,459,460],{"class":156},"            if",[143,462,463],{"class":167}," args[:",[143,465,419],{"class":160},[143,467,323],{"class":167},[143,469,470],{"class":156},"!=",[143,472,473],{"class":167}," [",[143,475,476],{"class":434},"\"mytool\"",[143,478,479],{"class":167},"]:\n",[143,481,483,486,489,492,495,498,501,504,507,510],{"class":145,"line":482},29,[143,484,485],{"class":156},"                raise",[143,487,488],{"class":160}," ValueError",[143,490,491],{"class":167},"(",[143,493,494],{"class":156},"f",[143,496,497],{"class":434},"\"line ",[143,499,500],{"class":160},"{",[143,502,503],{"class":167},"number",[143,505,506],{"class":160},"}",[143,508,509],{"class":434},": commands must start with 'mytool'\"",[143,511,341],{"class":167},[143,513,515,518,520],{"class":145,"line":514},30,[143,516,517],{"class":167},"            steps.append(Step(number, args[",[143,519,419],{"class":160},[143,521,522],{"class":167},":]))\n",[143,524,526,529,531,534,537,540],{"class":145,"line":525},31,[143,527,528],{"class":156},"        elif",[143,530,431],{"class":167},[143,532,533],{"class":434},"\"[exit \"",[143,535,536],{"class":167},") ",[143,538,539],{"class":156},"and",[143,541,542],{"class":167}," steps:\n",[143,544,546,549,552,554,557,559,562,565,568,571,573,575],{"class":145,"line":545},32,[143,547,548],{"class":167},"            steps[",[143,550,551],{"class":156},"-",[143,553,419],{"class":160},[143,555,556],{"class":167},"].exit_code ",[143,558,326],{"class":156},[143,560,561],{"class":160}," int",[143,563,564],{"class":167},"(raw[",[143,566,567],{"class":160},"6",[143,569,570],{"class":167},":",[143,572,551],{"class":156},[143,574,419],{"class":160},[143,576,577],{"class":167},"])\n",[143,579,581,583,585,588,590,593,596],{"class":145,"line":580},33,[143,582,528],{"class":156},[143,584,431],{"class":167},[143,586,587],{"class":434},"\"#\"",[143,589,536],{"class":167},[143,591,592],{"class":156},"or",[143,594,595],{"class":156}," not",[143,597,542],{"class":167},[143,599,601],{"class":145,"line":600},34,[143,602,603],{"class":156},"            continue\n",[143,605,607,610],{"class":145,"line":606},35,[143,608,609],{"class":156},"        else",[143,611,291],{"class":167},[143,613,615,617,619,621],{"class":145,"line":614},36,[143,616,548],{"class":167},[143,618,551],{"class":156},[143,620,419],{"class":160},[143,622,623],{"class":167},"].expected.append(raw)\n",[143,625,627,629,632,634],{"class":145,"line":626},37,[143,628,400],{"class":156},[143,630,631],{"class":167}," step ",[143,633,27],{"class":156},[143,635,542],{"class":167},[143,637,639,642,645,647,650,652,654,656,659,662],{"class":145,"line":638},38,[143,640,641],{"class":156},"        while",[143,643,644],{"class":167}," step.expected ",[143,646,539],{"class":156},[143,648,649],{"class":167}," step.expected[",[143,651,551],{"class":156},[143,653,419],{"class":160},[143,655,323],{"class":167},[143,657,658],{"class":156},"==",[143,660,661],{"class":434}," \"\"",[143,663,291],{"class":167},[143,665,667],{"class":145,"line":666},39,[143,668,669],{"class":167},"            step.expected.pop()\n",[143,671,673,676],{"class":145,"line":672},40,[143,674,675],{"class":156},"    return",[143,677,678],{"class":167}," steps\n",[143,680,682],{"class":145,"line":681},41,[143,683,175],{"emptyLinePlaceholder":174},[143,685,687],{"class":145,"line":686},42,[143,688,175],{"emptyLinePlaceholder":174},[143,690,692,694,697],{"class":145,"line":691},43,[143,693,372],{"class":156},[143,695,696],{"class":278}," pytest_collect_file",[143,698,699],{"class":167},"(parent, file_path: Path):\n",[143,701,703,706,709,711,714,717,720,723],{"class":145,"line":702},44,[143,704,705],{"class":156},"    if",[143,707,708],{"class":167}," file_path.suffix ",[143,710,658],{"class":156},[143,712,713],{"class":434}," \".t\"",[143,715,716],{"class":156}," and",[143,718,719],{"class":434}," \"transcripts\"",[143,721,722],{"class":156}," in",[143,724,725],{"class":167}," file_path.parts:\n",[143,727,729,732,735,738,740],{"class":145,"line":728},45,[143,730,731],{"class":156},"        return",[143,733,734],{"class":167}," TranscriptFile.from_parent(parent, ",[143,736,737],{"class":332},"path",[143,739,326],{"class":156},[143,741,742],{"class":167},"file_path)\n",[143,744,746],{"class":145,"line":745},46,[143,747,175],{"emptyLinePlaceholder":174},[143,749,751],{"class":145,"line":750},47,[143,752,175],{"emptyLinePlaceholder":174},[143,754,756,758,761,763,766,768,771],{"class":145,"line":755},48,[143,757,285],{"class":156},[143,759,760],{"class":278}," TranscriptFile",[143,762,491],{"class":167},[143,764,765],{"class":278},"pytest",[143,767,60],{"class":167},[143,769,770],{"class":278},"File",[143,772,422],{"class":167},[143,774,776,779,782],{"class":145,"line":775},49,[143,777,778],{"class":156},"    def",[143,780,781],{"class":278}," collect",[143,783,784],{"class":167},"(self):\n",[143,786,788,791,793,795,798,801,804,807,809,812],{"class":145,"line":787},50,[143,789,790],{"class":156},"        for",[143,792,631],{"class":167},[143,794,27],{"class":156},[143,796,797],{"class":167}," parse_transcript(",[143,799,800],{"class":160},"self",[143,802,803],{"class":167},".path.read_text(",[143,805,806],{"class":332},"encoding",[143,808,326],{"class":156},[143,810,811],{"class":434},"\"utf-8\"",[143,813,814],{"class":167},")):\n",[143,816,818,821],{"class":145,"line":817},51,[143,819,820],{"class":156},"            yield",[143,822,823],{"class":167}," TranscriptItem.from_parent(\n",[143,825,827,830,833,836,838,840,843,845,848,850,853,855,858,860,863,865,868,870],{"class":145,"line":826},52,[143,828,829],{"class":160},"                self",[143,831,832],{"class":167},", ",[143,834,835],{"class":332},"name",[143,837,326],{"class":156},[143,839,494],{"class":156},[143,841,842],{"class":434},"\"line",[143,844,500],{"class":160},[143,846,847],{"class":167},"step.line",[143,849,506],{"class":160},[143,851,852],{"class":434},": ",[143,854,500],{"class":160},[143,856,857],{"class":167},"shlex.join(step.args)",[143,859,506],{"class":160},[143,861,862],{"class":434},"\"",[143,864,832],{"class":167},[143,866,867],{"class":332},"step",[143,869,326],{"class":156},[143,871,872],{"class":167},"step)\n",[143,874,876],{"class":145,"line":875},53,[143,877,175],{"emptyLinePlaceholder":174},[143,879,881],{"class":145,"line":880},54,[143,882,175],{"emptyLinePlaceholder":174},[143,884,886,888,891,893,896],{"class":145,"line":885},55,[143,887,285],{"class":156},[143,889,890],{"class":278}," TranscriptMismatch",[143,892,491],{"class":167},[143,894,895],{"class":160},"AssertionError",[143,897,422],{"class":167},[143,899,901,903,906,909,911,914,916,919,922],{"class":145,"line":900},56,[143,902,778],{"class":156},[143,904,905],{"class":160}," __init__",[143,907,908],{"class":167},"(self, step: Step, actual: list[",[143,910,309],{"class":160},[143,912,913],{"class":167},"], code: ",[143,915,350],{"class":160},[143,917,918],{"class":167},") -> ",[143,920,921],{"class":160},"None",[143,923,291],{"class":167},[143,925,927,930,932,935,938,940,943,946,948,951],{"class":145,"line":926},57,[143,928,929],{"class":167},"        diff ",[143,931,326],{"class":156},[143,933,934],{"class":434}," \"",[143,936,937],{"class":160},"\\n",[143,939,862],{"class":434},[143,941,942],{"class":167},".join(difflib.unified_diff(step.expected, actual, ",[143,944,945],{"class":434},"\"expected\"",[143,947,832],{"class":167},[143,949,950],{"class":434},"\"actual\"",[143,952,953],{"class":167},",\n",[143,955,957,960,962,965],{"class":145,"line":956},58,[143,958,959],{"class":332},"                                              lineterm",[143,961,326],{"class":156},[143,963,964],{"class":434},"\"\"",[143,966,967],{"class":167},"))\n",[143,969,971,974,977,980,982,984,987,989,991,994],{"class":145,"line":970},59,[143,972,973],{"class":160},"        super",[143,975,976],{"class":167},"().",[143,978,979],{"class":160},"__init__",[143,981,491],{"class":167},[143,983,494],{"class":156},[143,985,986],{"class":434},"\"$ mytool ",[143,988,500],{"class":160},[143,990,857],{"class":167},[143,992,993],{"class":160},"}\\n",[143,995,996],{"class":434},"\"\n",[143,998,1000,1003,1006,1008,1011,1013,1016,1018,1020,1023,1026,1028,1030],{"class":145,"line":999},60,[143,1001,1002],{"class":156},"                         f",[143,1004,1005],{"class":434},"\"exit code: expected ",[143,1007,500],{"class":160},[143,1009,1010],{"class":167},"step.exit_code",[143,1012,506],{"class":160},[143,1014,1015],{"class":434},", got ",[143,1017,500],{"class":160},[143,1019,14],{"class":167},[143,1021,1022],{"class":160},"}\\n{",[143,1024,1025],{"class":167},"diff",[143,1027,506],{"class":160},[143,1029,862],{"class":434},[143,1031,341],{"class":167},[143,1033,1035],{"class":145,"line":1034},61,[143,1036,175],{"emptyLinePlaceholder":174},[143,1038,1040],{"class":145,"line":1039},62,[143,1041,175],{"emptyLinePlaceholder":174},[143,1043,1045,1047,1050,1052,1054,1056,1059],{"class":145,"line":1044},63,[143,1046,285],{"class":156},[143,1048,1049],{"class":278}," TranscriptItem",[143,1051,491],{"class":167},[143,1053,765],{"class":278},[143,1055,60],{"class":167},[143,1057,1058],{"class":278},"Item",[143,1060,422],{"class":167},[143,1062,1064,1066,1068,1071,1074,1077,1080,1083,1085],{"class":145,"line":1063},64,[143,1065,778],{"class":156},[143,1067,905],{"class":160},[143,1069,1070],{"class":167},"(self, ",[143,1072,1073],{"class":156},"*",[143,1075,1076],{"class":167},", step: Step, ",[143,1078,1079],{"class":156},"**",[143,1081,1082],{"class":167},"kwargs) -> ",[143,1084,921],{"class":160},[143,1086,291],{"class":167},[143,1088,1090,1092,1094,1096,1098,1100],{"class":145,"line":1089},65,[143,1091,973],{"class":160},[143,1093,976],{"class":167},[143,1095,979],{"class":160},[143,1097,491],{"class":167},[143,1099,1079],{"class":156},[143,1101,1102],{"class":167},"kwargs)\n",[143,1104,1106,1109,1112,1114],{"class":145,"line":1105},66,[143,1107,1108],{"class":160},"        self",[143,1110,1111],{"class":167},".step ",[143,1113,326],{"class":156},[143,1115,1116],{"class":167}," step\n",[143,1118,1120],{"class":145,"line":1119},67,[143,1121,175],{"emptyLinePlaceholder":174},[143,1123,1125,1127,1130,1133,1135],{"class":145,"line":1124},68,[143,1126,778],{"class":156},[143,1128,1129],{"class":278}," runtest",[143,1131,1132],{"class":167},"(self) -> ",[143,1134,921],{"class":160},[143,1136,291],{"class":167},[143,1138,1140,1143,1145,1148,1150,1153,1156,1158,1160],{"class":145,"line":1139},69,[143,1141,1142],{"class":167},"        result ",[143,1144,326],{"class":156},[143,1146,1147],{"class":167}," CliRunner().invoke(app, ",[143,1149,800],{"class":160},[143,1151,1152],{"class":167},".step.args, ",[143,1154,1155],{"class":332},"prog_name",[143,1157,326],{"class":156},[143,1159,476],{"class":434},[143,1161,953],{"class":167},[143,1163,1165,1168,1170,1172,1175,1177,1180,1182,1185,1187,1190],{"class":145,"line":1164},70,[143,1166,1167],{"class":332},"                                    env",[143,1169,326],{"class":156},[143,1171,500],{"class":167},[143,1173,1174],{"class":434},"\"COLUMNS\"",[143,1176,852],{"class":167},[143,1178,1179],{"class":434},"\"80\"",[143,1181,832],{"class":167},[143,1183,1184],{"class":434},"\"NO_COLOR\"",[143,1186,852],{"class":167},[143,1188,1189],{"class":434},"\"1\"",[143,1191,1192],{"class":167},"})\n",[143,1194,1196,1199,1201,1204,1206,1208,1210],{"class":145,"line":1195},71,[143,1197,1198],{"class":167},"        actual ",[143,1200,326],{"class":156},[143,1202,1203],{"class":167}," result.output.rstrip(",[143,1205,862],{"class":434},[143,1207,937],{"class":160},[143,1209,862],{"class":434},[143,1211,1212],{"class":167},").splitlines()\n",[143,1214,1216,1218,1221,1223,1226,1229,1231,1234,1236,1238],{"class":145,"line":1215},72,[143,1217,428],{"class":156},[143,1219,1220],{"class":167}," actual ",[143,1222,470],{"class":156},[143,1224,1225],{"class":160}," self",[143,1227,1228],{"class":167},".step.expected ",[143,1230,592],{"class":156},[143,1232,1233],{"class":167}," result.exit_code ",[143,1235,470],{"class":156},[143,1237,1225],{"class":160},[143,1239,1240],{"class":167},".step.exit_code:\n",[143,1242,1244,1247,1250,1252],{"class":145,"line":1243},73,[143,1245,1246],{"class":156},"            raise",[143,1248,1249],{"class":167}," TranscriptMismatch(",[143,1251,800],{"class":160},[143,1253,1254],{"class":167},".step, actual, result.exit_code)\n",[143,1256,1258],{"class":145,"line":1257},74,[143,1259,175],{"emptyLinePlaceholder":174},[143,1261,1263,1265,1268],{"class":145,"line":1262},75,[143,1264,778],{"class":156},[143,1266,1267],{"class":278}," repr_failure",[143,1269,1270],{"class":167},"(self, excinfo):\n",[143,1272,1274,1276,1279],{"class":145,"line":1273},76,[143,1275,428],{"class":156},[143,1277,1278],{"class":160}," isinstance",[143,1280,1281],{"class":167},"(excinfo.value, TranscriptMismatch):\n",[143,1283,1285,1288,1291],{"class":145,"line":1284},77,[143,1286,1287],{"class":156},"            return",[143,1289,1290],{"class":160}," str",[143,1292,1293],{"class":167},"(excinfo.value)\n",[143,1295,1297,1299,1302],{"class":145,"line":1296},78,[143,1298,731],{"class":156},[143,1300,1301],{"class":160}," super",[143,1303,1304],{"class":167},"().repr_failure(excinfo)\n",[143,1306,1308],{"class":145,"line":1307},79,[143,1309,175],{"emptyLinePlaceholder":174},[143,1311,1313,1315,1318],{"class":145,"line":1312},80,[143,1314,778],{"class":156},[143,1316,1317],{"class":278}," reportinfo",[143,1319,784],{"class":167},[143,1321,1323,1325,1327,1330,1332,1335,1337,1340,1342,1344],{"class":145,"line":1322},81,[143,1324,731],{"class":156},[143,1326,1225],{"class":160},[143,1328,1329],{"class":167},".path, ",[143,1331,800],{"class":160},[143,1333,1334],{"class":167},".step.line ",[143,1336,551],{"class":156},[143,1338,1339],{"class":160}," 1",[143,1341,832],{"class":167},[143,1343,800],{"class":160},[143,1345,1346],{"class":167},".name\n",[10,1348,1349,1350,1353,1354,1357,1358,1361,1362,1365,1366,1370,1371,1374],{},"Three details make it pleasant to use. Each command is its own pytest item, named after its line number and arguments, so failures point straight at the right place and ",[14,1351,1352],{},"-k greet"," selects transcripts like any other test. ",[14,1355,1356],{},"repr_failure"," replaces pytest's default traceback with the command and a diff — the only things you need to see. And the environment is pinned: ",[14,1359,1360],{},"COLUMNS=80"," makes wrapping deterministic and ",[14,1363,1364],{},"NO_COLOR=1"," keeps escape codes out of the comparison, the same precautions as in ",[56,1367,1369],{"href":1368},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output\u002F","snapshot testing CLI output",". ",[14,1372,1373],{},"prog_name=\"mytool\""," makes usage lines show the real command name instead of the runner's default.",[10,1376,1377],{},"When output drifts, the failure reads like a code review:",[89,1379,1382],{"className":1380,"code":1381,"language":94,"meta":95},[92],"$ mytool greet\nexit code: expected 2, got 2\n--- expected\n+++ actual\n@@ -1,5 +1,5 @@\n-Usage: mytool greet [OPTIONS] NAME\n+Usage: mytool greet [OPTIONS] {name}\n",[14,1383,1381],{"__ignoreMap":95},[10,1385,1386,1387,1390,1391,1394],{},"That diff is what you get when a transcript written for an older Typer runs against a release that renders required arguments as ",[14,1388,1389],{},"{name}"," in usage lines instead of ",[14,1392,1393],{},"NAME",". Nothing in your code changed, yet users will see different output — and whether that matters is a human decision, which is exactly what a transcript test is for.",[99,1396],{"name":1397},"transcript-terminal",[62,1399,1401],{"id":1400},"when-transcripts-fit-and-when-they-do-not","When transcripts fit, and when they do not",[99,1403],{"name":1404},"transcript-fit",[10,1406,1407,1408,1411],{},"Transcripts are excellent for ",[30,1409,1410],{},"user-visible behaviour that should change rarely and deliberately",": help output, error messages, table layouts, the walkthrough in your README. They double as executable documentation — some projects generate a \"Usage examples\" page straight from the transcript files.",[10,1413,1414,1415,1418,1419,1422],{},"They are a poor fit for ",[30,1416,1417],{},"output that varies",": timestamps, durations, temporary paths, random IDs. Either keep those out of transcript tests, or extend the format with a placeholder such as ",[14,1420,1421],{},"\u003CANY>"," that matches any text on a line. They also exercise only the command line, so they complement rather than replace unit tests of the logic underneath. And because they pin exact text, they need updating when the framework changes its formatting — a small, honest cost that is usually worth paying for output users depend on.",[62,1424,1426],{"id":1425},"ux-considerations","UX considerations",[10,1428,1429],{},"The users of transcripts are developers and reviewers:",[67,1431,1432,1448,1461,1467],{},[70,1433,1434,1437,1438,832,1441,832,1444,1447],{},[30,1435,1436],{},"Keep files short and themed"," — ",[14,1439,1440],{},"greet.t",[14,1442,1443],{},"errors.t",[14,1445,1446],{},"json-output.t"," — so a failing file name already says what broke.",[70,1449,1450,1453,1454,1456,1457,1460],{},[30,1451,1452],{},"Comment the intent."," A ",[14,1455,115],{}," line saying ",[35,1458,1459],{},"why"," an error message matters (\"scripts grep for 'not found'\") stops someone from \"fixing\" it casually.",[70,1462,1463,1466],{},[30,1464,1465],{},"Treat a transcript diff as a product change."," If the diff is intended, update the transcript in the same pull request, and mention user-visible output changes in the changelog.",[70,1468,1469,1472,1473,60],{},[30,1470,1471],{},"Run transcripts in CI on every supported platform"," if output includes paths or line endings, as in ",[56,1474,1476],{"href":1475},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Frunning-cli-tests-on-windows-and-macos-runners\u002F","running CLI tests on Windows and macOS runners",[62,1478,1480],{"id":1479},"testing-the-behaviour","Testing the behaviour",[10,1482,1483],{},"The parser is the part worth unit-testing, since a parsing bug would make transcripts silently test the wrong thing:",[89,1485,1487],{"className":137,"code":1486,"language":139,"meta":95,"style":95},"# tests\u002Ftest_transcript_parser.py\nimport pytest\n\nfrom conftest import parse_transcript\n\nSAMPLE = \"\"\"\\\n# comment\n$ mytool greet Ann\nhello Ann\n\n$ mytool greet \"Ann Lee\" --times 2\nhello Ann Lee\nhello Ann Lee\n[exit 0]\n$ mytool greet\nerror\n[exit 2]\n\"\"\"\n\n\ndef test_steps_outputs_and_exit_codes():\n    steps = parse_transcript(SAMPLE)\n    assert [s.args for s in steps] == [[\"greet\", \"Ann\"], [\"greet\", \"Ann Lee\", \"--times\", \"2\"],\n                                       [\"greet\"]]\n    assert steps[0].expected == [\"hello Ann\"]\n    assert steps[2].expected == [\"error\"] and steps[2].exit_code == 2\n\n\ndef test_commands_must_name_the_tool():\n    with pytest.raises(ValueError, match=\"must start with 'mytool'\"):\n        parse_transcript(\"$ othertool run\\n\")\n",[14,1488,1489,1494,1500,1504,1516,1520,1533,1538,1543,1548,1552,1557,1562,1566,1571,1576,1581,1586,1591,1595,1599,1609,1622,1677,1687,1709,1741,1745,1749,1758,1781],{"__ignoreMap":95},[143,1490,1491],{"class":145,"line":146},[143,1492,1493],{"class":149},"# tests\u002Ftest_transcript_parser.py\n",[143,1495,1496,1498],{"class":145,"line":153},[143,1497,181],{"class":156},[143,1499,231],{"class":167},[143,1501,1502],{"class":145,"line":171},[143,1503,175],{"emptyLinePlaceholder":174},[143,1505,1506,1508,1511,1513],{"class":145,"line":178},[143,1507,157],{"class":156},[143,1509,1510],{"class":167}," conftest ",[143,1512,181],{"class":156},[143,1514,1515],{"class":167}," parse_transcript\n",[143,1517,1518],{"class":145,"line":187},[143,1519,175],{"emptyLinePlaceholder":174},[143,1521,1522,1525,1527,1530],{"class":145,"line":195},[143,1523,1524],{"class":160},"SAMPLE",[143,1526,353],{"class":156},[143,1528,1529],{"class":434}," \"\"\"",[143,1531,1532],{"class":160},"\\\n",[143,1534,1535],{"class":145,"line":208},[143,1536,1537],{"class":434},"# comment\n",[143,1539,1540],{"class":145,"line":221},[143,1541,1542],{"class":434},"$ mytool greet Ann\n",[143,1544,1545],{"class":145,"line":226},[143,1546,1547],{"class":434},"hello Ann\n",[143,1549,1550],{"class":145,"line":234},[143,1551,175],{"emptyLinePlaceholder":174},[143,1553,1554],{"class":145,"line":247},[143,1555,1556],{"class":434},"$ mytool greet \"Ann Lee\" --times 2\n",[143,1558,1559],{"class":145,"line":252},[143,1560,1561],{"class":434},"hello Ann Lee\n",[143,1563,1564],{"class":145,"line":265},[143,1565,1561],{"class":434},[143,1567,1568],{"class":145,"line":270},[143,1569,1570],{"class":434},"[exit 0]\n",[143,1572,1573],{"class":145,"line":275},[143,1574,1575],{"class":434},"$ mytool greet\n",[143,1577,1578],{"class":145,"line":282},[143,1579,1580],{"class":434},"error\n",[143,1582,1583],{"class":145,"line":294},[143,1584,1585],{"class":434},"[exit 2]\n",[143,1587,1588],{"class":145,"line":303},[143,1589,1590],{"class":434},"\"\"\"\n",[143,1592,1593],{"class":145,"line":315},[143,1594,175],{"emptyLinePlaceholder":174},[143,1596,1597],{"class":145,"line":344},[143,1598,175],{"emptyLinePlaceholder":174},[143,1600,1601,1603,1606],{"class":145,"line":359},[143,1602,372],{"class":156},[143,1604,1605],{"class":278}," test_steps_outputs_and_exit_codes",[143,1607,1608],{"class":167},"():\n",[143,1610,1611,1614,1616,1618,1620],{"class":145,"line":364},[143,1612,1613],{"class":167},"    steps ",[143,1615,326],{"class":156},[143,1617,797],{"class":167},[143,1619,1524],{"class":160},[143,1621,341],{"class":167},[143,1623,1624,1627,1630,1633,1636,1638,1641,1643,1646,1649,1651,1654,1657,1659,1661,1664,1666,1669,1671,1674],{"class":145,"line":369},[143,1625,1626],{"class":156},"    assert",[143,1628,1629],{"class":167}," [s.args ",[143,1631,1632],{"class":156},"for",[143,1634,1635],{"class":167}," s ",[143,1637,27],{"class":156},[143,1639,1640],{"class":167}," steps] ",[143,1642,658],{"class":156},[143,1644,1645],{"class":167}," [[",[143,1647,1648],{"class":434},"\"greet\"",[143,1650,832],{"class":167},[143,1652,1653],{"class":434},"\"Ann\"",[143,1655,1656],{"class":167},"], [",[143,1658,1648],{"class":434},[143,1660,832],{"class":167},[143,1662,1663],{"class":434},"\"Ann Lee\"",[143,1665,832],{"class":167},[143,1667,1668],{"class":434},"\"--times\"",[143,1670,832],{"class":167},[143,1672,1673],{"class":434},"\"2\"",[143,1675,1676],{"class":167},"],\n",[143,1678,1679,1682,1684],{"class":145,"line":386},[143,1680,1681],{"class":167},"                                       [",[143,1683,1648],{"class":434},[143,1685,1686],{"class":167},"]]\n",[143,1688,1689,1691,1694,1697,1700,1702,1704,1707],{"class":145,"line":397},[143,1690,1626],{"class":156},[143,1692,1693],{"class":167}," steps[",[143,1695,1696],{"class":160},"0",[143,1698,1699],{"class":167},"].expected ",[143,1701,658],{"class":156},[143,1703,473],{"class":167},[143,1705,1706],{"class":434},"\"hello Ann\"",[143,1708,312],{"class":167},[143,1710,1711,1713,1715,1717,1719,1721,1723,1726,1728,1730,1732,1734,1736,1738],{"class":145,"line":425},[143,1712,1626],{"class":156},[143,1714,1693],{"class":167},[143,1716,451],{"class":160},[143,1718,1699],{"class":167},[143,1720,658],{"class":156},[143,1722,473],{"class":167},[143,1724,1725],{"class":434},"\"error\"",[143,1727,323],{"class":167},[143,1729,539],{"class":156},[143,1731,1693],{"class":167},[143,1733,451],{"class":160},[143,1735,556],{"class":167},[143,1737,658],{"class":156},[143,1739,1740],{"class":160}," 2\n",[143,1742,1743],{"class":145,"line":440},[143,1744,175],{"emptyLinePlaceholder":174},[143,1746,1747],{"class":145,"line":457},[143,1748,175],{"emptyLinePlaceholder":174},[143,1750,1751,1753,1756],{"class":145,"line":482},[143,1752,372],{"class":156},[143,1754,1755],{"class":278}," test_commands_must_name_the_tool",[143,1757,1608],{"class":167},[143,1759,1760,1763,1766,1769,1771,1774,1776,1779],{"class":145,"line":514},[143,1761,1762],{"class":156},"    with",[143,1764,1765],{"class":167}," pytest.raises(",[143,1767,1768],{"class":160},"ValueError",[143,1770,832],{"class":167},[143,1772,1773],{"class":332},"match",[143,1775,326],{"class":156},[143,1777,1778],{"class":434},"\"must start with 'mytool'\"",[143,1780,422],{"class":167},[143,1782,1783,1786,1789,1791,1793],{"class":145,"line":525},[143,1784,1785],{"class":167},"        parse_transcript(",[143,1787,1788],{"class":434},"\"$ othertool run",[143,1790,937],{"class":160},[143,1792,862],{"class":434},[143,1794,341],{"class":167},[10,1796,1797,1798,1801,1802,1805,1806,1809],{},"Importing from ",[14,1799,1800],{},"conftest"," works because pytest puts the test directory on ",[14,1803,1804],{},"sys.path","; if you prefer, move the parser into a small ",[14,1807,1808],{},"tests\u002Ftranscripts.py"," module and import it from both places.",[62,1811,1813],{"id":1812},"conclusion","Conclusion",[10,1815,1816],{},"Transcript tests make CLI output reviewable: a plain-text file of commands, expected output and exit codes, collected by a short pytest plugin that runs each command in-process and shows a diff when anything changes. Use them for help, errors and documented examples — the output users depend on — pin the terminal width and colour, keep varying values out, and keep unit tests for the logic underneath. A changed transcript then becomes what it should be: a visible, deliberate product decision.",[62,1818,1820],{"id":1819},"frequently-asked-questions","Frequently asked questions",[1822,1823,1825],"h3",{"id":1824},"why-not-use-cram-or-prysk-directly","Why not use cram or prysk directly?",[10,1827,1828],{},"They are mature and language-agnostic, and run commands through a real shell. The in-process collector here is faster, needs no installed console script, works on Windows without a POSIX shell, and integrates with pytest's selection and reporting. Use the external tools when you specifically want to test through a shell.",[1822,1830,1832],{"id":1831},"can-transcripts-include-stdin","Can transcripts include stdin?",[10,1834,1835,1836,1839,1840,1843,1844,1847],{},"Extend the format with a ",[14,1837,1838],{},"\u003C text"," line that feeds input to the command, and pass it as ",[14,1841,1842],{},"input="," to ",[14,1845,1846],{},"CliRunner.invoke",". Keep it simple: a line or two of input per command.",[1822,1849,1851],{"id":1850},"how-do-i-update-many-transcripts-after-an-intended-change","How do I update many transcripts after an intended change?",[10,1853,1854,1855,1858],{},"Add an opt-in update mode — for example an environment variable that makes ",[14,1856,1857],{},"runtest"," write the actual output back into the file instead of failing — and review the resulting diff with git before committing. Snapshot tools such as syrupy offer the same workflow for Python-based tests.",[1822,1860,1862],{"id":1861},"should-stderr-and-stdout-be-separated-in-transcripts","Should stderr and stdout be separated in transcripts?",[10,1864,1865,1866,60],{},"The runner here compares combined output, which matches what a user sees in a terminal. If stream separation matters for a command — machine output on stdout, diagnostics on stderr — test that with an ordinary pytest test, as in ",[56,1867,76],{"href":75},[1822,1869,1871],{"id":1870},"do-transcripts-slow-the-test-suite-down","Do transcripts slow the test suite down?",[10,1873,1874,1875,1877],{},"Barely. Each command runs in-process through ",[14,1876,16],{},", so a transcript step costs about as much as an ordinary CLI test — milliseconds. Only commands that genuinely do slow work (network calls, large files) are slow, and those should use the same fakes and fixtures as your other tests, injected through environment variables the transcript runner sets.",[62,1879,1881],{"id":1880},"related","Related",[67,1883,1884,1890,1895,1900,1906],{},[70,1885,1886,1887],{},"Up: ",[56,1888,1889],{"href":58},"Testing Python CLI applications",[70,1891,1892],{},[56,1893,1894],{"href":1368},"Snapshot testing CLI output",[70,1896,1897],{},[56,1898,1899],{"href":75},"Testing Click commands with CliRunner",[70,1901,1902],{},[56,1903,1905],{"href":1904},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses\u002F","Testing commands that call subprocesses",[70,1907,1908],{},[56,1909,1911],{"href":1910},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fadding-examples-and-epilogs-to-help-output\u002F","Adding examples and epilogs to help output",[1913,1914,1915],"style",{},"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 .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}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);}",{"title":95,"searchDepth":153,"depth":153,"links":1917},[1918,1919,1920,1921,1922,1923,1924,1925,1932],{"id":64,"depth":153,"text":65},{"id":86,"depth":153,"text":87},{"id":119,"depth":153,"text":120},{"id":1400,"depth":153,"text":1401},{"id":1425,"depth":153,"text":1426},{"id":1479,"depth":153,"text":1480},{"id":1812,"depth":153,"text":1813},{"id":1819,"depth":153,"text":1820,"children":1926},[1927,1928,1929,1930,1931],{"id":1824,"depth":171,"text":1825},{"id":1831,"depth":171,"text":1832},{"id":1850,"depth":171,"text":1851},{"id":1861,"depth":171,"text":1862},{"id":1870,"depth":171,"text":1871},{"id":1880,"depth":153,"text":1881},"2026-10-02","Write CLI tests as terminal transcripts — commands, expected output and exit codes in plain text files — collected by a small pytest plugin with readable diffs on failure.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands",{"title":5,"description":1934},"modern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands\u002Findex",[1943,765,1944,1945,1946],"testing","transcripts","cli-output","documentation","4YqYEXPGs6xitmhvSUjcSc8APCI7Ti4b0521bTEcg8E",[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,2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,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,2763,2766,2769,2772,2775,2778,2781,2784,2787,2790],{"path":1950,"title":1951},"\u002Fabout","About Python CLI Toolcraft",{"path":1953,"title":1954},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1956,"title":1957},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1959,"title":1960},"\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":1962,"title":1963},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1965,"title":1966},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1968,"title":1969},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1971,"title":1972},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1974,"title":1975},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1977,"title":1978},"\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":1980,"title":1981},"\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":1983,"title":1984},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1986,"title":1987},"\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":1989,"title":1990},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1992,"title":1993},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1995,"title":1996},"\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":1998,"title":1999},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2001,"title":2002},"\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":2004,"title":2005},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2007,"title":2008},"\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":2010,"title":2011},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2013,"title":2014},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2016,"title":2017},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2019,"title":2020},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2022,"title":2023},"\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":2025,"title":2026},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2028,"title":2029},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2031,"title":2032},"\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":2034,"title":2035},"\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":2037,"title":2038},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2040,"title":2041},"\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":2043,"title":2044},"\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":2046,"title":2047},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2049,"title":2050},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2052,"title":2053},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2055,"title":2056},"\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":2058,"title":2059},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2061,"title":2062},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2064,"title":2065},"\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":2067,"title":2068},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2070,"title":2071},"\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":2073,"title":2074},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2076,"title":2077},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2079,"title":2080},"\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":2082,"title":2083},"\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":2085,"title":2086},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2088,"title":2089},"\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":2091,"title":2092},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2094,"title":2095},"\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":2097,"title":2098},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2100,"title":2101},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2103,"title":2104},"\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":2106,"title":2107},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2109,"title":2110},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2112,"title":2113},"\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":2115,"title":2116},"\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":2118,"title":2119},"\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":2121,"title":2122},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2124,"title":2125},"\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":2127,"title":2128},"\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":2130,"title":2131},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2133,"title":2134},"\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":2136,"title":2137},"\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":2139,"title":2140},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2142,"title":2143},"\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":2145,"title":2146},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2148,"title":2149},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2151,"title":2152},"\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":2154,"title":2155},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2157,"title":2158},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2160,"title":2161},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2163,"title":2164},"\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":2166,"title":2167},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2169,"title":2170},"\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":2172,"title":2173},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2175,"title":2176},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2178,"title":2179},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2181,"title":2182},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2184,"title":2185},"\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":2187,"title":2188},"\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":2190,"title":2191},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2193,"title":2194},"\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":2196,"title":2197},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2199,"title":2200},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2202,"title":2203},"\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":2205,"title":2206},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2208,"title":2209},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2211,"title":2212},"\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":2214,"title":2215},"\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":2217,"title":2218},"\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":2220,"title":2221},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2223,"title":2224},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2226,"title":2227},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2229,"title":2230},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2232,"title":2233},"\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":2235,"title":2236},"\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":2238,"title":2239},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2241,"title":2242},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2244,"title":2245},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2247,"title":2248},"\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":2250,"title":2251},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2253,"title":2254},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2256,"title":2257},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2259,"title":2260},"\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":2262,"title":2263},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2265,"title":2266},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2268,"title":2269},"\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":2271,"title":2272},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2274,"title":2275},"\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":2277,"title":2278},"\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":2280,"title":2281},"\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":2283,"title":2284},"\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":2286,"title":2287},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2289,"title":2290},"\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":2292,"title":2293},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2295,"title":2296},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2298,"title":2299},"\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":2301,"title":2302},"\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":2304,"title":2305},"\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":2307,"title":2308},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2310,"title":2311},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2313,"title":2314},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2316,"title":2317},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2319,"title":2320},"\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":2322,"title":2323},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2325,"title":2326},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2328,"title":2329},"\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":2331,"title":2332},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2334,"title":2335},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2337,"title":2338},"\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":2340,"title":2341},"\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":2343,"title":2344},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2346,"title":2347},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2349,"title":2350},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2352,"title":2353},"\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":2355,"title":2356},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2358,"title":2359},"\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":2361,"title":2362},"\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":2364,"title":2365},"\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":2367,"title":2368},"\u002F","Python CLI Toolcraft",{"path":2370,"title":2371},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2373,"title":2374},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2376,"title":2377},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2379,"title":2380},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2382,"title":2383},"\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":2385,"title":2386},"\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":2388,"title":2389},"\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":2391,"title":2392},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2394,"title":2395},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2397,"title":2398},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2400,"title":2401},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2403,"title":2404},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2406,"title":2407},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2409,"title":2410},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2412,"title":2413},"\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":2415,"title":2416},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2418,"title":2419},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2421,"title":2422},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2424,"title":2425},"\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":2427,"title":2428},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2430,"title":2431},"\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":2433,"title":2434},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2436,"title":2437},"\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":2439,"title":2440},"\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":2442,"title":2443},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2445,"title":2446},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2448,"title":2449},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2451,"title":2452},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2454,"title":2455},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2457,"title":2458},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2460,"title":2461},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2463,"title":2464},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2466,"title":2467},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2469,"title":2470},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2472,"title":2473},"\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":2475,"title":2476},"\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":2478,"title":2479},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2481,"title":2482},"\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":2484,"title":2485},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2487,"title":2488},"\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":2490,"title":2491},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2493,"title":2494},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2496,"title":2497},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2499,"title":2500},"\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":2502,"title":2503},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2505,"title":2506},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2508,"title":2509},"\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":2511,"title":2512},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2514,"title":2515},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2517,"title":2518},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2520,"title":2521},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2523,"title":2524},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":1939,"title":5},{"path":2527,"title":2528},"\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":2530,"title":2531},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2533,"title":2534},"\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":2536,"title":2537},"\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":2539,"title":2540},"\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":2542,"title":2543},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2545,"title":2546},"\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":2548,"title":2549},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2551,"title":2552},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2554,"title":2555},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2557,"title":2558},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2560,"title":2561},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2563,"title":2564},"\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":2566,"title":2567},"\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":2569,"title":2570},"\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":2572,"title":2573},"\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":2575,"title":2576},"\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":2578,"title":2579},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2581,"title":2582},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2584,"title":2585},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2587,"title":2588},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2590,"title":2591},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2593,"title":2594},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2596,"title":2597},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2599,"title":2600},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2602,"title":2603},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2605,"title":2606},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2608,"title":2609},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2611,"title":2612},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2614,"title":2615},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2617,"title":2618},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2620,"title":2621},"\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":2623,"title":2624},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2626,"title":2627},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2629,"title":2630},"\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":2632,"title":2633},"\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":2635,"title":2636},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2638,"title":2639},"\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":2641,"title":2642},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Frunning-ruff-and-mypy-in-ci-with-annotations","Running Ruff and mypy in CI with Inline Annotations",{"path":2644,"title":2645},"\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":2647,"title":2648},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2650,"title":2651},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2653,"title":2654},"\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":2656,"title":2657},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2659,"title":2660},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2662,"title":2663},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2665,"title":2666},"\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":2668,"title":2669},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2671,"title":2672},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2674,"title":2675},"\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":2677,"title":2678},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2680,"title":2681},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2683,"title":2684},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2686,"title":2687},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2689,"title":2690},"\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":2692,"title":2693},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2695,"title":2696},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2698,"title":2699},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2701,"title":2702},"\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":2704,"title":2705},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2707,"title":2708},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2710,"title":2711},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2713,"title":2714},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2716,"title":2717},"\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":2719,"title":2720},"\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":2722,"title":2723},"\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":2725,"title":2726},"\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":2728,"title":2729},"\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":2731,"title":2732},"\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":2734,"title":2735},"\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":2737,"title":2738},"\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":2740,"title":2741},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2743,"title":2744},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2746,"title":2747},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2749,"title":2750},"\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":2752,"title":2753},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2755,"title":2756},"\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":2758,"title":2759},"\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":2761,"title":2762},"\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":2764,"title":2765},"\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":2767,"title":2768},"\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":2770,"title":2771},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2773,"title":2774},"\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":2776,"title":2777},"\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":2779,"title":2780},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2782,"title":2783},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2785,"title":2786},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2788,"title":2789},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2791,"title":2792},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967541880]