[{"data":1,"prerenderedAt":3050},["ShallowReactive",2],{"page-\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live\u002F":3,"content-directory":2206},{"id":4,"title":5,"body":6,"date":2191,"description":2192,"difficulty":2193,"draft":2194,"extension":2195,"meta":2196,"navigation":122,"path":2197,"seo":2198,"stem":2199,"tags":2200,"updated":2191,"__hash__":2205},"content\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live\u002Findex.md","Live Dashboards with Rich Live in Python CLIs",{"type":7,"value":8,"toc":2171},"minimark",[9,24,29,43,47,51,77,81,1037,1040,1225,1230,1244,1261,1273,1279,1282,1286,1289,1306,1310,1370,1374,1377,2012,2019,2023,2031,2035,2039,2060,2064,2082,2086,2095,2099,2106,2110,2117,2121,2131,2135,2167],[10,11,12,13,17,18,23],"p",{},"A deploy that rolls out across five regions, a batch of twenty migrations, a test run over a dozen services: when several things progress at once, a single progress bar is not enough and a scrolling log is too much. What people want is a small table that updates in place — one row per task with its state, progress and elapsed time — and that stays on screen as a summary when everything is done. Rich's ",[14,15,16],"code",{},"Live"," display does exactly that inside an ordinary command, without a full-screen TUI. This guide builds such a dashboard, keeps rendering separate from data so it is testable, makes it fall back to plain log lines when there is no terminal, and covers the details that make live displays behave: refresh rates, printing while live, and Ctrl+C. It belongs to the ",[19,20,22],"a",{"href":21},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002F","interactive terminal UI with Rich topic",".",[25,26,28],"h2",{"id":27},"prerequisites","Prerequisites",[30,31,32,36],"ul",{},[33,34,35],"li",{},"Python 3.10+ and Rich 13+ (included with Typer).",[33,37,38,39,23],{},"A source of status for several concurrent tasks — an API to poll, or results from a thread pool as in ",[19,40,42],{"href":41},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools\u002F","parallelising CLI work with thread pools",[25,44,46],{"id":45},"how-live-works","How Live works",[48,49],"inline-diagram",{"name":50},"lv-loop",[10,52,53,55,56,60,61,64,65,68,69,72,73,76],{},[14,54,16],{}," takes over a region of the terminal — not the whole screen — and redraws a renderable (a table, a panel, a group of them) in that region, several times a second. Your code fetches new data, builds a ",[57,58,59],"strong",{},"new"," renderable and hands it to ",[14,62,63],{},"live.update()",". When the ",[14,66,67],{},"with"," block ends, the last frame stays in the scrollback as a permanent summary (unless ",[14,70,71],{},"transient=True",", which erases it). Everything printed through the live console appears ",[57,74,75],{},"above"," the display, so log messages and the dashboard coexist.",[25,78,80],{"id":79},"the-recipe","The recipe",[82,83,88],"pre",{"className":84,"code":85,"language":86,"meta":87,"style":87},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fdashboard.py\nfrom __future__ import annotations\n\nimport sys\nimport time\nfrom collections.abc import Callable\nfrom dataclasses import dataclass\n\nfrom rich.console import Console\nfrom rich.live import Live\nfrom rich.table import Table\n\n\n@dataclass(frozen=True)\nclass RegionState:\n    region: str\n    state: str          # waiting | rolling | done | failed\n    done: int\n    total: int\n    elapsed: float | None\n\n\nSTYLE = {\"waiting\": \"dim\", \"rolling\": \"yellow\", \"done\": \"green\", \"failed\": \"bold red\"}\n\n\ndef render(states: list[RegionState]) -> Table:\n    \"\"\"Pure function: data in, renderable out. Easy to test and reuse.\"\"\"\n    table = Table(\"REGION\", \"STATE\", \"PROGRESS\", \"ELAPSED\", box=None, header_style=\"bold\")\n    for s in states:\n        elapsed = \"-\" if s.elapsed is None else f\"{int(s.elapsed \u002F\u002F 60)}:{int(s.elapsed % 60):02d}\"\n        table.add_row(s.region, f\"[{STYLE[s.state]}]{s.state}[\u002F]\", f\"{s.done}\u002F{s.total}\", elapsed)\n    return table\n\n\ndef finished(states: list[RegionState]) -> bool:\n    return all(s.state in (\"done\", \"failed\") for s in states)\n\n\ndef watch(fetch: Callable[[], list[RegionState]], *, interval: float = 1.0,\n          console: Console | None = None, sleep: Callable[[float], None] = time.sleep) -> list[RegionState]:\n    \"\"\"Redraw in place on a terminal; print one line per change everywhere else.\"\"\"\n    console = console or Console()\n    states = fetch()\n    if console.is_terminal:\n        with Live(render(states), console=console, refresh_per_second=4, transient=False) as live:\n            while not finished(states):\n                sleep(interval)\n                states = fetch()\n                live.update(render(states))\n        return states\n    last: dict[str, str] = {}\n    while True:\n        for s in states:\n            if last.get(s.region) != s.state:\n                print(f\"{s.region}: {s.state} ({s.done}\u002F{s.total})\", file=sys.stderr, flush=True)\n                last[s.region] = s.state\n        if finished(states):\n            return states\n        sleep(interval)\n        states = fetch()\n","python","",[14,89,90,99,117,124,133,141,154,167,172,185,198,211,216,221,244,256,265,277,286,294,309,314,319,375,380,385,397,403,454,469,541,603,612,617,622,638,673,678,683,710,743,749,766,777,786,829,841,847,857,863,872,891,902,914,929,994,1005,1013,1021,1027],{"__ignoreMap":87},[91,92,95],"span",{"class":93,"line":94},"line",1,[91,96,98],{"class":97},"sJ8bj","# src\u002Fmytool\u002Fdashboard.py\n",[91,100,102,106,110,113],{"class":93,"line":101},2,[91,103,105],{"class":104},"szBVR","from",[91,107,109],{"class":108},"sj4cs"," __future__",[91,111,112],{"class":104}," import",[91,114,116],{"class":115},"sVt8B"," annotations\n",[91,118,120],{"class":93,"line":119},3,[91,121,123],{"emptyLinePlaceholder":122},true,"\n",[91,125,127,130],{"class":93,"line":126},4,[91,128,129],{"class":104},"import",[91,131,132],{"class":115}," sys\n",[91,134,136,138],{"class":93,"line":135},5,[91,137,129],{"class":104},[91,139,140],{"class":115}," time\n",[91,142,144,146,149,151],{"class":93,"line":143},6,[91,145,105],{"class":104},[91,147,148],{"class":115}," collections.abc ",[91,150,129],{"class":104},[91,152,153],{"class":115}," Callable\n",[91,155,157,159,162,164],{"class":93,"line":156},7,[91,158,105],{"class":104},[91,160,161],{"class":115}," dataclasses ",[91,163,129],{"class":104},[91,165,166],{"class":115}," dataclass\n",[91,168,170],{"class":93,"line":169},8,[91,171,123],{"emptyLinePlaceholder":122},[91,173,175,177,180,182],{"class":93,"line":174},9,[91,176,105],{"class":104},[91,178,179],{"class":115}," rich.console ",[91,181,129],{"class":104},[91,183,184],{"class":115}," Console\n",[91,186,188,190,193,195],{"class":93,"line":187},10,[91,189,105],{"class":104},[91,191,192],{"class":115}," rich.live ",[91,194,129],{"class":104},[91,196,197],{"class":115}," Live\n",[91,199,201,203,206,208],{"class":93,"line":200},11,[91,202,105],{"class":104},[91,204,205],{"class":115}," rich.table ",[91,207,129],{"class":104},[91,209,210],{"class":115}," Table\n",[91,212,214],{"class":93,"line":213},12,[91,215,123],{"emptyLinePlaceholder":122},[91,217,219],{"class":93,"line":218},13,[91,220,123],{"emptyLinePlaceholder":122},[91,222,224,228,231,235,238,241],{"class":93,"line":223},14,[91,225,227],{"class":226},"sScJk","@dataclass",[91,229,230],{"class":115},"(",[91,232,234],{"class":233},"s4XuR","frozen",[91,236,237],{"class":104},"=",[91,239,240],{"class":108},"True",[91,242,243],{"class":115},")\n",[91,245,247,250,253],{"class":93,"line":246},15,[91,248,249],{"class":104},"class",[91,251,252],{"class":226}," RegionState",[91,254,255],{"class":115},":\n",[91,257,259,262],{"class":93,"line":258},16,[91,260,261],{"class":115},"    region: ",[91,263,264],{"class":108},"str\n",[91,266,268,271,274],{"class":93,"line":267},17,[91,269,270],{"class":115},"    state: ",[91,272,273],{"class":108},"str",[91,275,276],{"class":97},"          # waiting | rolling | done | failed\n",[91,278,280,283],{"class":93,"line":279},18,[91,281,282],{"class":115},"    done: ",[91,284,285],{"class":108},"int\n",[91,287,289,292],{"class":93,"line":288},19,[91,290,291],{"class":115},"    total: ",[91,293,285],{"class":108},[91,295,297,300,303,306],{"class":93,"line":296},20,[91,298,299],{"class":115},"    elapsed: ",[91,301,302],{"class":108},"float",[91,304,305],{"class":104}," |",[91,307,308],{"class":108}," None\n",[91,310,312],{"class":93,"line":311},21,[91,313,123],{"emptyLinePlaceholder":122},[91,315,317],{"class":93,"line":316},22,[91,318,123],{"emptyLinePlaceholder":122},[91,320,322,325,328,331,335,338,341,344,347,349,352,354,357,359,362,364,367,369,372],{"class":93,"line":321},23,[91,323,324],{"class":108},"STYLE",[91,326,327],{"class":104}," =",[91,329,330],{"class":115}," {",[91,332,334],{"class":333},"sZZnC","\"waiting\"",[91,336,337],{"class":115},": ",[91,339,340],{"class":333},"\"dim\"",[91,342,343],{"class":115},", ",[91,345,346],{"class":333},"\"rolling\"",[91,348,337],{"class":115},[91,350,351],{"class":333},"\"yellow\"",[91,353,343],{"class":115},[91,355,356],{"class":333},"\"done\"",[91,358,337],{"class":115},[91,360,361],{"class":333},"\"green\"",[91,363,343],{"class":115},[91,365,366],{"class":333},"\"failed\"",[91,368,337],{"class":115},[91,370,371],{"class":333},"\"bold red\"",[91,373,374],{"class":115},"}\n",[91,376,378],{"class":93,"line":377},24,[91,379,123],{"emptyLinePlaceholder":122},[91,381,383],{"class":93,"line":382},25,[91,384,123],{"emptyLinePlaceholder":122},[91,386,388,391,394],{"class":93,"line":387},26,[91,389,390],{"class":104},"def",[91,392,393],{"class":226}," render",[91,395,396],{"class":115},"(states: list[RegionState]) -> Table:\n",[91,398,400],{"class":93,"line":399},27,[91,401,402],{"class":333},"    \"\"\"Pure function: data in, renderable out. Easy to test and reuse.\"\"\"\n",[91,404,406,409,411,414,417,419,422,424,427,429,432,434,437,439,442,444,447,449,452],{"class":93,"line":405},28,[91,407,408],{"class":115},"    table ",[91,410,237],{"class":104},[91,412,413],{"class":115}," Table(",[91,415,416],{"class":333},"\"REGION\"",[91,418,343],{"class":115},[91,420,421],{"class":333},"\"STATE\"",[91,423,343],{"class":115},[91,425,426],{"class":333},"\"PROGRESS\"",[91,428,343],{"class":115},[91,430,431],{"class":333},"\"ELAPSED\"",[91,433,343],{"class":115},[91,435,436],{"class":233},"box",[91,438,237],{"class":104},[91,440,441],{"class":108},"None",[91,443,343],{"class":115},[91,445,446],{"class":233},"header_style",[91,448,237],{"class":104},[91,450,451],{"class":333},"\"bold\"",[91,453,243],{"class":115},[91,455,457,460,463,466],{"class":93,"line":456},29,[91,458,459],{"class":104},"    for",[91,461,462],{"class":115}," s ",[91,464,465],{"class":104},"in",[91,467,468],{"class":115}," states:\n",[91,470,472,475,477,480,483,486,489,492,495,498,501,504,507,510,513,516,519,522,524,526,529,531,533,536,538],{"class":93,"line":471},30,[91,473,474],{"class":115},"        elapsed ",[91,476,237],{"class":104},[91,478,479],{"class":333}," \"-\"",[91,481,482],{"class":104}," if",[91,484,485],{"class":115}," s.elapsed ",[91,487,488],{"class":104},"is",[91,490,491],{"class":108}," None",[91,493,494],{"class":104}," else",[91,496,497],{"class":104}," f",[91,499,500],{"class":333},"\"",[91,502,503],{"class":108},"{int",[91,505,506],{"class":115},"(s.elapsed ",[91,508,509],{"class":104},"\u002F\u002F",[91,511,512],{"class":108}," 60",[91,514,515],{"class":115},")",[91,517,518],{"class":108},"}",[91,520,521],{"class":333},":",[91,523,503],{"class":108},[91,525,506],{"class":115},[91,527,528],{"class":104},"%",[91,530,512],{"class":108},[91,532,515],{"class":115},[91,534,535],{"class":104},":02d",[91,537,518],{"class":108},[91,539,540],{"class":333},"\"\n",[91,542,544,547,550,553,556,559,561,564,567,570,572,575,577,579,581,583,586,588,591,593,596,598,600],{"class":93,"line":543},31,[91,545,546],{"class":115},"        table.add_row(s.region, ",[91,548,549],{"class":104},"f",[91,551,552],{"class":333},"\"[",[91,554,555],{"class":108},"{STYLE",[91,557,558],{"class":115},"[s.state]",[91,560,518],{"class":108},[91,562,563],{"class":333},"]",[91,565,566],{"class":108},"{",[91,568,569],{"class":115},"s.state",[91,571,518],{"class":108},[91,573,574],{"class":333},"[\u002F]\"",[91,576,343],{"class":115},[91,578,549],{"class":104},[91,580,500],{"class":333},[91,582,566],{"class":108},[91,584,585],{"class":115},"s.done",[91,587,518],{"class":108},[91,589,590],{"class":333},"\u002F",[91,592,566],{"class":108},[91,594,595],{"class":115},"s.total",[91,597,518],{"class":108},[91,599,500],{"class":333},[91,601,602],{"class":115},", elapsed)\n",[91,604,606,609],{"class":93,"line":605},32,[91,607,608],{"class":104},"    return",[91,610,611],{"class":115}," table\n",[91,613,615],{"class":93,"line":614},33,[91,616,123],{"emptyLinePlaceholder":122},[91,618,620],{"class":93,"line":619},34,[91,621,123],{"emptyLinePlaceholder":122},[91,623,625,627,630,633,636],{"class":93,"line":624},35,[91,626,390],{"class":104},[91,628,629],{"class":226}," finished",[91,631,632],{"class":115},"(states: list[RegionState]) -> ",[91,634,635],{"class":108},"bool",[91,637,255],{"class":115},[91,639,641,643,646,649,651,654,656,658,660,663,666,668,670],{"class":93,"line":640},36,[91,642,608],{"class":104},[91,644,645],{"class":108}," all",[91,647,648],{"class":115},"(s.state ",[91,650,465],{"class":104},[91,652,653],{"class":115}," (",[91,655,356],{"class":333},[91,657,343],{"class":115},[91,659,366],{"class":333},[91,661,662],{"class":115},") ",[91,664,665],{"class":104},"for",[91,667,462],{"class":115},[91,669,465],{"class":104},[91,671,672],{"class":115}," states)\n",[91,674,676],{"class":93,"line":675},37,[91,677,123],{"emptyLinePlaceholder":122},[91,679,681],{"class":93,"line":680},38,[91,682,123],{"emptyLinePlaceholder":122},[91,684,686,688,691,694,697,700,702,704,707],{"class":93,"line":685},39,[91,687,390],{"class":104},[91,689,690],{"class":226}," watch",[91,692,693],{"class":115},"(fetch: Callable[[], list[RegionState]], ",[91,695,696],{"class":104},"*",[91,698,699],{"class":115},", interval: ",[91,701,302],{"class":108},[91,703,327],{"class":104},[91,705,706],{"class":108}," 1.0",[91,708,709],{"class":115},",\n",[91,711,713,716,719,721,723,725,728,730,733,735,738,740],{"class":93,"line":712},40,[91,714,715],{"class":115},"          console: Console ",[91,717,718],{"class":104},"|",[91,720,491],{"class":108},[91,722,327],{"class":104},[91,724,491],{"class":108},[91,726,727],{"class":115},", sleep: Callable[[",[91,729,302],{"class":108},[91,731,732],{"class":115},"], ",[91,734,441],{"class":108},[91,736,737],{"class":115},"] ",[91,739,237],{"class":104},[91,741,742],{"class":115}," time.sleep) -> list[RegionState]:\n",[91,744,746],{"class":93,"line":745},41,[91,747,748],{"class":333},"    \"\"\"Redraw in place on a terminal; print one line per change everywhere else.\"\"\"\n",[91,750,752,755,757,760,763],{"class":93,"line":751},42,[91,753,754],{"class":115},"    console ",[91,756,237],{"class":104},[91,758,759],{"class":115}," console ",[91,761,762],{"class":104},"or",[91,764,765],{"class":115}," Console()\n",[91,767,769,772,774],{"class":93,"line":768},43,[91,770,771],{"class":115},"    states ",[91,773,237],{"class":104},[91,775,776],{"class":115}," fetch()\n",[91,778,780,783],{"class":93,"line":779},44,[91,781,782],{"class":104},"    if",[91,784,785],{"class":115}," console.is_terminal:\n",[91,787,789,792,795,798,800,803,806,808,811,813,816,818,821,823,826],{"class":93,"line":788},45,[91,790,791],{"class":104},"        with",[91,793,794],{"class":115}," Live(render(states), ",[91,796,797],{"class":233},"console",[91,799,237],{"class":104},[91,801,802],{"class":115},"console, ",[91,804,805],{"class":233},"refresh_per_second",[91,807,237],{"class":104},[91,809,810],{"class":108},"4",[91,812,343],{"class":115},[91,814,815],{"class":233},"transient",[91,817,237],{"class":104},[91,819,820],{"class":108},"False",[91,822,662],{"class":115},[91,824,825],{"class":104},"as",[91,827,828],{"class":115}," live:\n",[91,830,832,835,838],{"class":93,"line":831},46,[91,833,834],{"class":104},"            while",[91,836,837],{"class":104}," not",[91,839,840],{"class":115}," finished(states):\n",[91,842,844],{"class":93,"line":843},47,[91,845,846],{"class":115},"                sleep(interval)\n",[91,848,850,853,855],{"class":93,"line":849},48,[91,851,852],{"class":115},"                states ",[91,854,237],{"class":104},[91,856,776],{"class":115},[91,858,860],{"class":93,"line":859},49,[91,861,862],{"class":115},"                live.update(render(states))\n",[91,864,866,869],{"class":93,"line":865},50,[91,867,868],{"class":104},"        return",[91,870,871],{"class":115}," states\n",[91,873,875,878,880,882,884,886,888],{"class":93,"line":874},51,[91,876,877],{"class":115},"    last: dict[",[91,879,273],{"class":108},[91,881,343],{"class":115},[91,883,273],{"class":108},[91,885,737],{"class":115},[91,887,237],{"class":104},[91,889,890],{"class":115}," {}\n",[91,892,894,897,900],{"class":93,"line":893},52,[91,895,896],{"class":104},"    while",[91,898,899],{"class":108}," True",[91,901,255],{"class":115},[91,903,905,908,910,912],{"class":93,"line":904},53,[91,906,907],{"class":104},"        for",[91,909,462],{"class":115},[91,911,465],{"class":104},[91,913,468],{"class":115},[91,915,917,920,923,926],{"class":93,"line":916},54,[91,918,919],{"class":104},"            if",[91,921,922],{"class":115}," last.get(s.region) ",[91,924,925],{"class":104},"!=",[91,927,928],{"class":115}," s.state:\n",[91,930,932,935,937,939,941,943,946,948,950,952,954,956,958,960,962,964,966,968,970,972,975,977,980,982,985,988,990,992],{"class":93,"line":931},55,[91,933,934],{"class":108},"                print",[91,936,230],{"class":115},[91,938,549],{"class":104},[91,940,500],{"class":333},[91,942,566],{"class":108},[91,944,945],{"class":115},"s.region",[91,947,518],{"class":108},[91,949,337],{"class":333},[91,951,566],{"class":108},[91,953,569],{"class":115},[91,955,518],{"class":108},[91,957,653],{"class":333},[91,959,566],{"class":108},[91,961,585],{"class":115},[91,963,518],{"class":108},[91,965,590],{"class":333},[91,967,566],{"class":108},[91,969,595],{"class":115},[91,971,518],{"class":108},[91,973,974],{"class":333},")\"",[91,976,343],{"class":115},[91,978,979],{"class":233},"file",[91,981,237],{"class":104},[91,983,984],{"class":115},"sys.stderr, ",[91,986,987],{"class":233},"flush",[91,989,237],{"class":104},[91,991,240],{"class":108},[91,993,243],{"class":115},[91,995,997,1000,1002],{"class":93,"line":996},56,[91,998,999],{"class":115},"                last[s.region] ",[91,1001,237],{"class":104},[91,1003,1004],{"class":115}," s.state\n",[91,1006,1008,1011],{"class":93,"line":1007},57,[91,1009,1010],{"class":104},"        if",[91,1012,840],{"class":115},[91,1014,1016,1019],{"class":93,"line":1015},58,[91,1017,1018],{"class":104},"            return",[91,1020,871],{"class":115},[91,1022,1024],{"class":93,"line":1023},59,[91,1025,1026],{"class":115},"        sleep(interval)\n",[91,1028,1030,1033,1035],{"class":93,"line":1029},60,[91,1031,1032],{"class":115},"        states ",[91,1034,237],{"class":104},[91,1036,776],{"class":115},[10,1038,1039],{},"A command calls it with a function that returns the current state — polling an API, or reading results collected by worker threads:",[82,1041,1043],{"className":84,"code":1042,"language":86,"meta":87,"style":87},"import typer\n\nfrom mytool.dashboard import watch\n\napp = typer.Typer()\n\n\n@app.command()\ndef deploy(all_regions: bool = typer.Option(False, \"--all-regions\")) -> None:\n    \"\"\"Deploy and show progress per region.\"\"\"\n    job = start_rollout(all_regions)                 # returns a handle with .status()\n    final = watch(job.status, interval=2.0)\n    failed = [s.region for s in final if s.state == \"failed\"]\n    raise typer.Exit(1 if failed else 0)\n",[14,1044,1045,1052,1056,1068,1072,1082,1086,1090,1098,1129,1134,1147,1167,1201],{"__ignoreMap":87},[91,1046,1047,1049],{"class":93,"line":94},[91,1048,129],{"class":104},[91,1050,1051],{"class":115}," typer\n",[91,1053,1054],{"class":93,"line":101},[91,1055,123],{"emptyLinePlaceholder":122},[91,1057,1058,1060,1063,1065],{"class":93,"line":119},[91,1059,105],{"class":104},[91,1061,1062],{"class":115}," mytool.dashboard ",[91,1064,129],{"class":104},[91,1066,1067],{"class":115}," watch\n",[91,1069,1070],{"class":93,"line":126},[91,1071,123],{"emptyLinePlaceholder":122},[91,1073,1074,1077,1079],{"class":93,"line":135},[91,1075,1076],{"class":115},"app ",[91,1078,237],{"class":104},[91,1080,1081],{"class":115}," typer.Typer()\n",[91,1083,1084],{"class":93,"line":143},[91,1085,123],{"emptyLinePlaceholder":122},[91,1087,1088],{"class":93,"line":156},[91,1089,123],{"emptyLinePlaceholder":122},[91,1091,1092,1095],{"class":93,"line":169},[91,1093,1094],{"class":226},"@app.command",[91,1096,1097],{"class":115},"()\n",[91,1099,1100,1102,1105,1108,1110,1112,1115,1117,1119,1122,1125,1127],{"class":93,"line":174},[91,1101,390],{"class":104},[91,1103,1104],{"class":226}," deploy",[91,1106,1107],{"class":115},"(all_regions: ",[91,1109,635],{"class":108},[91,1111,327],{"class":104},[91,1113,1114],{"class":115}," typer.Option(",[91,1116,820],{"class":108},[91,1118,343],{"class":115},[91,1120,1121],{"class":333},"\"--all-regions\"",[91,1123,1124],{"class":115},")) -> ",[91,1126,441],{"class":108},[91,1128,255],{"class":115},[91,1130,1131],{"class":93,"line":187},[91,1132,1133],{"class":333},"    \"\"\"Deploy and show progress per region.\"\"\"\n",[91,1135,1136,1139,1141,1144],{"class":93,"line":200},[91,1137,1138],{"class":115},"    job ",[91,1140,237],{"class":104},[91,1142,1143],{"class":115}," start_rollout(all_regions)                 ",[91,1145,1146],{"class":97},"# returns a handle with .status()\n",[91,1148,1149,1152,1154,1157,1160,1162,1165],{"class":93,"line":213},[91,1150,1151],{"class":115},"    final ",[91,1153,237],{"class":104},[91,1155,1156],{"class":115}," watch(job.status, ",[91,1158,1159],{"class":233},"interval",[91,1161,237],{"class":104},[91,1163,1164],{"class":108},"2.0",[91,1166,243],{"class":115},[91,1168,1169,1172,1174,1177,1179,1181,1183,1186,1189,1192,1195,1198],{"class":93,"line":218},[91,1170,1171],{"class":115},"    failed ",[91,1173,237],{"class":104},[91,1175,1176],{"class":115}," [s.region ",[91,1178,665],{"class":104},[91,1180,462],{"class":115},[91,1182,465],{"class":104},[91,1184,1185],{"class":115}," final ",[91,1187,1188],{"class":104},"if",[91,1190,1191],{"class":115}," s.state ",[91,1193,1194],{"class":104},"==",[91,1196,1197],{"class":333}," \"failed\"",[91,1199,1200],{"class":115},"]\n",[91,1202,1203,1206,1209,1212,1214,1217,1220,1223],{"class":93,"line":223},[91,1204,1205],{"class":104},"    raise",[91,1207,1208],{"class":115}," typer.Exit(",[91,1210,1211],{"class":108},"1",[91,1213,482],{"class":104},[91,1215,1216],{"class":115}," failed ",[91,1218,1219],{"class":104},"else",[91,1221,1222],{"class":108}," 0",[91,1224,243],{"class":115},[1226,1227,1229],"h3",{"id":1228},"why-it-is-built-this-way","Why it is built this way",[10,1231,1232,1235,1236,1239,1240,1243],{},[57,1233,1234],{},"Render is a pure function."," ",[14,1237,1238],{},"render(states)"," turns data into a ",[14,1241,1242],{},"Table"," and does nothing else. Building a fresh renderable per tick avoids mutating a table while Rich is drawing it, and makes the visual logic testable without a terminal.",[10,1245,1246,1235,1249,1252,1253,1256,1257,23],{},[57,1247,1248],{},"One code path decides the mode.",[14,1250,1251],{},"console.is_terminal"," is false in pipes, CI logs and files. There, a live display would write a stream of redraws; instead the dashboard prints one line ",[57,1254,1255],{},"per state change",", which is exactly the information someone reading a log needs. The broader rules are in ",[19,1258,1260],{"href":1259},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells\u002F","detecting CI environments and non-interactive shells",[10,1262,1263,1235,1266,1269,1270,1272],{},[57,1264,1265],{},"Refresh rate is decoupled from polling.",[14,1267,1268],{},"refresh_per_second=4"," controls redrawing (spinners and elapsed times stay smooth); ",[14,1271,1159],{}," controls how often data is fetched — usually much less often, to be kind to the API.",[10,1274,1275,1278],{},[57,1276,1277],{},"Sleep is injected."," Tests pass a no-op sleep and a scripted fetch function, so the whole loop runs in milliseconds.",[48,1280],{"name":1281},"lv-terminal",[25,1283,1285],{"id":1284},"live-display-or-full-tui","Live display or full TUI?",[48,1287],{"name":1288},"lv-vs-tui",[10,1290,1291,1292,343,1295,1297,1298,1301,1302,23],{},"If the user only ",[57,1293,1294],{},"watches",[14,1296,16],{}," is enough and a fraction of the code of a TUI. The moment they need to ",[57,1299,1300],{},"act"," on the display — select a row, cancel a task, filter — a Textual application is the better tool; see ",[19,1303,1305],{"href":1304},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002F","building terminal UIs with Textual",[25,1307,1309],{"id":1308},"ux-considerations","UX considerations",[30,1311,1312,1325,1341,1347,1360],{},[33,1313,1314,1317,1318,1321,1322,1324],{},[57,1315,1316],{},"Leave a summary."," With ",[14,1319,1320],{},"transient=False",", the final table remains after the command finishes — a free report of what happened. Use ",[14,1323,71],{}," only for purely transitional displays.",[33,1326,1327,1235,1330,1333,1334,1337,1338,1340],{},[57,1328,1329],{},"Print through the live console.",[14,1331,1332],{},"live.console.print(\"warning: ...\")"," puts messages above the table. Bare ",[14,1335,1336],{},"print()"," while a ",[14,1339,16],{}," is active corrupts the display.",[33,1342,1343,1346],{},[57,1344,1345],{},"Keep the table short."," A live region taller than the terminal cannot be redrawn in place and degrades into scrolling. For many tasks, show the active and failed ones plus a summary line (\"37 done, 2 failed, 11 waiting\").",[33,1348,1349,1352,1353,1355,1356,1359],{},[57,1350,1351],{},"Handle Ctrl+C."," Leaving the ",[14,1354,67],{}," block — including through ",[14,1357,1358],{},"KeyboardInterrupt"," — stops the display cleanly and leaves the last frame. Catch the interrupt in the command to report what was still running and exit 130.",[33,1361,1362,1365,1366,23],{},[57,1363,1364],{},"Colour is a hint, not the message."," The state column says \"failed\", not just red; see ",[19,1367,1369],{"href":1368},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Frespecting-no-color-and-force-color\u002F","respecting NO_COLOR and FORCE_COLOR",[25,1371,1373],{"id":1372},"testing-the-behaviour","Testing the behaviour",[10,1375,1376],{},"With rendering pure and fetch and sleep injected, every behaviour is testable: the table's content, the live loop running to completion, and the non-terminal fallback printing one line per change:",[82,1378,1380],{"className":84,"code":1379,"language":86,"meta":87,"style":87},"# tests\u002Ftest_dashboard.py\nimport io\n\nfrom rich.console import Console\n\nfrom mytool.dashboard import RegionState, render, watch\n\n\ndef scripted(*frames):\n    it = iter(frames)\n    last = []\n\n    def fetch():\n        nonlocal last\n        last = next(it, last)\n        return last\n    return fetch\n\n\nF1 = [RegionState(\"eu-west-1\", \"rolling\", 3, 10, 20.0), RegionState(\"us-east-1\", \"waiting\", 0, 10, None)]\nF2 = [RegionState(\"eu-west-1\", \"done\", 10, 10, 41.0), RegionState(\"us-east-1\", \"rolling\", 6, 10, 33.0)]\nF3 = [RegionState(\"eu-west-1\", \"done\", 10, 10, 41.0), RegionState(\"us-east-1\", \"done\", 10, 10, 52.0)]\n\n\ndef text_of(renderable) -> str:\n    console = Console(file=io.StringIO(), width=80, color_system=None)\n    console.print(renderable)\n    return console.file.getvalue()\n\n\ndef test_render_is_plain_data_to_table():\n    out = text_of(render(F2))\n    assert \"eu-west-1\" in out and \"10\u002F10\" in out and \"0:41\" in out\n\n\ndef test_terminal_mode_redraws_until_finished():\n    console = Console(file=io.StringIO(), force_terminal=True, width=80)\n    final = watch(scripted(F1, F2, F3), console=console, sleep=lambda s: None)\n    assert final == F3\n\n\ndef test_non_terminal_prints_one_line_per_change(capsys):\n    console = Console(file=io.StringIO(), force_terminal=False)\n    watch(scripted(F1, F2, F2, F3), console=console, sleep=lambda s: None)\n    lines = capsys.readouterr().err.splitlines()\n    assert lines == [\"eu-west-1: rolling (3\u002F10)\", \"us-east-1: waiting (0\u002F10)\",\n                     \"eu-west-1: done (10\u002F10)\", \"us-east-1: rolling (6\u002F10)\", \"us-east-1: done (10\u002F10)\"]\n",[14,1381,1382,1387,1394,1398,1408,1412,1423,1427,1431,1445,1458,1468,1472,1483,1491,1504,1510,1517,1521,1525,1583,1635,1685,1689,1693,1707,1742,1747,1754,1758,1762,1771,1781,1815,1819,1823,1832,1863,1891,1902,1906,1910,1920,1942,1963,1973,1995],{"__ignoreMap":87},[91,1383,1384],{"class":93,"line":94},[91,1385,1386],{"class":97},"# tests\u002Ftest_dashboard.py\n",[91,1388,1389,1391],{"class":93,"line":101},[91,1390,129],{"class":104},[91,1392,1393],{"class":115}," io\n",[91,1395,1396],{"class":93,"line":119},[91,1397,123],{"emptyLinePlaceholder":122},[91,1399,1400,1402,1404,1406],{"class":93,"line":126},[91,1401,105],{"class":104},[91,1403,179],{"class":115},[91,1405,129],{"class":104},[91,1407,184],{"class":115},[91,1409,1410],{"class":93,"line":135},[91,1411,123],{"emptyLinePlaceholder":122},[91,1413,1414,1416,1418,1420],{"class":93,"line":143},[91,1415,105],{"class":104},[91,1417,1062],{"class":115},[91,1419,129],{"class":104},[91,1421,1422],{"class":115}," RegionState, render, watch\n",[91,1424,1425],{"class":93,"line":156},[91,1426,123],{"emptyLinePlaceholder":122},[91,1428,1429],{"class":93,"line":169},[91,1430,123],{"emptyLinePlaceholder":122},[91,1432,1433,1435,1438,1440,1442],{"class":93,"line":174},[91,1434,390],{"class":104},[91,1436,1437],{"class":226}," scripted",[91,1439,230],{"class":115},[91,1441,696],{"class":104},[91,1443,1444],{"class":115},"frames):\n",[91,1446,1447,1450,1452,1455],{"class":93,"line":187},[91,1448,1449],{"class":115},"    it ",[91,1451,237],{"class":104},[91,1453,1454],{"class":108}," iter",[91,1456,1457],{"class":115},"(frames)\n",[91,1459,1460,1463,1465],{"class":93,"line":200},[91,1461,1462],{"class":115},"    last ",[91,1464,237],{"class":104},[91,1466,1467],{"class":115}," []\n",[91,1469,1470],{"class":93,"line":213},[91,1471,123],{"emptyLinePlaceholder":122},[91,1473,1474,1477,1480],{"class":93,"line":218},[91,1475,1476],{"class":104},"    def",[91,1478,1479],{"class":226}," fetch",[91,1481,1482],{"class":115},"():\n",[91,1484,1485,1488],{"class":93,"line":223},[91,1486,1487],{"class":104},"        nonlocal",[91,1489,1490],{"class":115}," last\n",[91,1492,1493,1496,1498,1501],{"class":93,"line":246},[91,1494,1495],{"class":115},"        last ",[91,1497,237],{"class":104},[91,1499,1500],{"class":108}," next",[91,1502,1503],{"class":115},"(it, last)\n",[91,1505,1506,1508],{"class":93,"line":258},[91,1507,868],{"class":104},[91,1509,1490],{"class":115},[91,1511,1512,1514],{"class":93,"line":267},[91,1513,608],{"class":104},[91,1515,1516],{"class":115}," fetch\n",[91,1518,1519],{"class":93,"line":279},[91,1520,123],{"emptyLinePlaceholder":122},[91,1522,1523],{"class":93,"line":288},[91,1524,123],{"emptyLinePlaceholder":122},[91,1526,1527,1530,1532,1535,1538,1540,1542,1544,1547,1549,1552,1554,1557,1560,1563,1565,1567,1569,1572,1574,1576,1578,1580],{"class":93,"line":296},[91,1528,1529],{"class":115},"F1 ",[91,1531,237],{"class":104},[91,1533,1534],{"class":115}," [RegionState(",[91,1536,1537],{"class":333},"\"eu-west-1\"",[91,1539,343],{"class":115},[91,1541,346],{"class":333},[91,1543,343],{"class":115},[91,1545,1546],{"class":108},"3",[91,1548,343],{"class":115},[91,1550,1551],{"class":108},"10",[91,1553,343],{"class":115},[91,1555,1556],{"class":108},"20.0",[91,1558,1559],{"class":115},"), RegionState(",[91,1561,1562],{"class":333},"\"us-east-1\"",[91,1564,343],{"class":115},[91,1566,334],{"class":333},[91,1568,343],{"class":115},[91,1570,1571],{"class":108},"0",[91,1573,343],{"class":115},[91,1575,1551],{"class":108},[91,1577,343],{"class":115},[91,1579,441],{"class":108},[91,1581,1582],{"class":115},")]\n",[91,1584,1585,1588,1590,1592,1594,1596,1598,1600,1602,1604,1606,1608,1611,1613,1615,1617,1619,1621,1624,1626,1628,1630,1633],{"class":93,"line":311},[91,1586,1587],{"class":115},"F2 ",[91,1589,237],{"class":104},[91,1591,1534],{"class":115},[91,1593,1537],{"class":333},[91,1595,343],{"class":115},[91,1597,356],{"class":333},[91,1599,343],{"class":115},[91,1601,1551],{"class":108},[91,1603,343],{"class":115},[91,1605,1551],{"class":108},[91,1607,343],{"class":115},[91,1609,1610],{"class":108},"41.0",[91,1612,1559],{"class":115},[91,1614,1562],{"class":333},[91,1616,343],{"class":115},[91,1618,346],{"class":333},[91,1620,343],{"class":115},[91,1622,1623],{"class":108},"6",[91,1625,343],{"class":115},[91,1627,1551],{"class":108},[91,1629,343],{"class":115},[91,1631,1632],{"class":108},"33.0",[91,1634,1582],{"class":115},[91,1636,1637,1640,1642,1644,1646,1648,1650,1652,1654,1656,1658,1660,1662,1664,1666,1668,1670,1672,1674,1676,1678,1680,1683],{"class":93,"line":316},[91,1638,1639],{"class":115},"F3 ",[91,1641,237],{"class":104},[91,1643,1534],{"class":115},[91,1645,1537],{"class":333},[91,1647,343],{"class":115},[91,1649,356],{"class":333},[91,1651,343],{"class":115},[91,1653,1551],{"class":108},[91,1655,343],{"class":115},[91,1657,1551],{"class":108},[91,1659,343],{"class":115},[91,1661,1610],{"class":108},[91,1663,1559],{"class":115},[91,1665,1562],{"class":333},[91,1667,343],{"class":115},[91,1669,356],{"class":333},[91,1671,343],{"class":115},[91,1673,1551],{"class":108},[91,1675,343],{"class":115},[91,1677,1551],{"class":108},[91,1679,343],{"class":115},[91,1681,1682],{"class":108},"52.0",[91,1684,1582],{"class":115},[91,1686,1687],{"class":93,"line":321},[91,1688,123],{"emptyLinePlaceholder":122},[91,1690,1691],{"class":93,"line":377},[91,1692,123],{"emptyLinePlaceholder":122},[91,1694,1695,1697,1700,1703,1705],{"class":93,"line":382},[91,1696,390],{"class":104},[91,1698,1699],{"class":226}," text_of",[91,1701,1702],{"class":115},"(renderable) -> ",[91,1704,273],{"class":108},[91,1706,255],{"class":115},[91,1708,1709,1711,1713,1716,1718,1720,1723,1726,1728,1731,1733,1736,1738,1740],{"class":93,"line":387},[91,1710,754],{"class":115},[91,1712,237],{"class":104},[91,1714,1715],{"class":115}," Console(",[91,1717,979],{"class":233},[91,1719,237],{"class":104},[91,1721,1722],{"class":115},"io.StringIO(), ",[91,1724,1725],{"class":233},"width",[91,1727,237],{"class":104},[91,1729,1730],{"class":108},"80",[91,1732,343],{"class":115},[91,1734,1735],{"class":233},"color_system",[91,1737,237],{"class":104},[91,1739,441],{"class":108},[91,1741,243],{"class":115},[91,1743,1744],{"class":93,"line":399},[91,1745,1746],{"class":115},"    console.print(renderable)\n",[91,1748,1749,1751],{"class":93,"line":405},[91,1750,608],{"class":104},[91,1752,1753],{"class":115}," console.file.getvalue()\n",[91,1755,1756],{"class":93,"line":456},[91,1757,123],{"emptyLinePlaceholder":122},[91,1759,1760],{"class":93,"line":471},[91,1761,123],{"emptyLinePlaceholder":122},[91,1763,1764,1766,1769],{"class":93,"line":543},[91,1765,390],{"class":104},[91,1767,1768],{"class":226}," test_render_is_plain_data_to_table",[91,1770,1482],{"class":115},[91,1772,1773,1776,1778],{"class":93,"line":605},[91,1774,1775],{"class":115},"    out ",[91,1777,237],{"class":104},[91,1779,1780],{"class":115}," text_of(render(F2))\n",[91,1782,1783,1786,1789,1792,1795,1798,1801,1803,1805,1807,1810,1812],{"class":93,"line":614},[91,1784,1785],{"class":104},"    assert",[91,1787,1788],{"class":333}," \"eu-west-1\"",[91,1790,1791],{"class":104}," in",[91,1793,1794],{"class":115}," out ",[91,1796,1797],{"class":104},"and",[91,1799,1800],{"class":333}," \"10\u002F10\"",[91,1802,1791],{"class":104},[91,1804,1794],{"class":115},[91,1806,1797],{"class":104},[91,1808,1809],{"class":333}," \"0:41\"",[91,1811,1791],{"class":104},[91,1813,1814],{"class":115}," out\n",[91,1816,1817],{"class":93,"line":619},[91,1818,123],{"emptyLinePlaceholder":122},[91,1820,1821],{"class":93,"line":624},[91,1822,123],{"emptyLinePlaceholder":122},[91,1824,1825,1827,1830],{"class":93,"line":640},[91,1826,390],{"class":104},[91,1828,1829],{"class":226}," test_terminal_mode_redraws_until_finished",[91,1831,1482],{"class":115},[91,1833,1834,1836,1838,1840,1842,1844,1846,1849,1851,1853,1855,1857,1859,1861],{"class":93,"line":675},[91,1835,754],{"class":115},[91,1837,237],{"class":104},[91,1839,1715],{"class":115},[91,1841,979],{"class":233},[91,1843,237],{"class":104},[91,1845,1722],{"class":115},[91,1847,1848],{"class":233},"force_terminal",[91,1850,237],{"class":104},[91,1852,240],{"class":108},[91,1854,343],{"class":115},[91,1856,1725],{"class":233},[91,1858,237],{"class":104},[91,1860,1730],{"class":108},[91,1862,243],{"class":115},[91,1864,1865,1867,1869,1872,1874,1876,1878,1881,1884,1887,1889],{"class":93,"line":680},[91,1866,1151],{"class":115},[91,1868,237],{"class":104},[91,1870,1871],{"class":115}," watch(scripted(F1, F2, F3), ",[91,1873,797],{"class":233},[91,1875,237],{"class":104},[91,1877,802],{"class":115},[91,1879,1880],{"class":233},"sleep",[91,1882,1883],{"class":104},"=lambda",[91,1885,1886],{"class":115}," s: ",[91,1888,441],{"class":108},[91,1890,243],{"class":115},[91,1892,1893,1895,1897,1899],{"class":93,"line":685},[91,1894,1785],{"class":104},[91,1896,1185],{"class":115},[91,1898,1194],{"class":104},[91,1900,1901],{"class":115}," F3\n",[91,1903,1904],{"class":93,"line":712},[91,1905,123],{"emptyLinePlaceholder":122},[91,1907,1908],{"class":93,"line":745},[91,1909,123],{"emptyLinePlaceholder":122},[91,1911,1912,1914,1917],{"class":93,"line":751},[91,1913,390],{"class":104},[91,1915,1916],{"class":226}," test_non_terminal_prints_one_line_per_change",[91,1918,1919],{"class":115},"(capsys):\n",[91,1921,1922,1924,1926,1928,1930,1932,1934,1936,1938,1940],{"class":93,"line":768},[91,1923,754],{"class":115},[91,1925,237],{"class":104},[91,1927,1715],{"class":115},[91,1929,979],{"class":233},[91,1931,237],{"class":104},[91,1933,1722],{"class":115},[91,1935,1848],{"class":233},[91,1937,237],{"class":104},[91,1939,820],{"class":108},[91,1941,243],{"class":115},[91,1943,1944,1947,1949,1951,1953,1955,1957,1959,1961],{"class":93,"line":779},[91,1945,1946],{"class":115},"    watch(scripted(F1, F2, F2, F3), ",[91,1948,797],{"class":233},[91,1950,237],{"class":104},[91,1952,802],{"class":115},[91,1954,1880],{"class":233},[91,1956,1883],{"class":104},[91,1958,1886],{"class":115},[91,1960,441],{"class":108},[91,1962,243],{"class":115},[91,1964,1965,1968,1970],{"class":93,"line":788},[91,1966,1967],{"class":115},"    lines ",[91,1969,237],{"class":104},[91,1971,1972],{"class":115}," capsys.readouterr().err.splitlines()\n",[91,1974,1975,1977,1980,1982,1985,1988,1990,1993],{"class":93,"line":831},[91,1976,1785],{"class":104},[91,1978,1979],{"class":115}," lines ",[91,1981,1194],{"class":104},[91,1983,1984],{"class":115}," [",[91,1986,1987],{"class":333},"\"eu-west-1: rolling (3\u002F10)\"",[91,1989,343],{"class":115},[91,1991,1992],{"class":333},"\"us-east-1: waiting (0\u002F10)\"",[91,1994,709],{"class":115},[91,1996,1997,2000,2002,2005,2007,2010],{"class":93,"line":843},[91,1998,1999],{"class":333},"                     \"eu-west-1: done (10\u002F10)\"",[91,2001,343],{"class":115},[91,2003,2004],{"class":333},"\"us-east-1: rolling (6\u002F10)\"",[91,2006,343],{"class":115},[91,2008,2009],{"class":333},"\"us-east-1: done (10\u002F10)\"",[91,2011,1200],{"class":115},[10,2013,2014,2015,2018],{},"The last test is the one that protects CI logs: repeated identical frames (",[14,2016,2017],{},"F2, F2",") produce no extra lines, and every transition appears exactly once.",[25,2020,2022],{"id":2021},"conclusion","Conclusion",[10,2024,2025,2027,2028,2030],{},[14,2026,16],{}," gives a command a compact, in-place dashboard with very little code: fetch state, build a fresh table from it, hand it to ",[14,2029,63],{},", and let the final frame remain as a summary. Keep rendering pure, decouple refresh from polling, print through the live console, fall back to one log line per state change when there is no terminal, and inject fetch and sleep so the loop is testable. For watching many things at once, that is usually all the interface a CLI needs.",[25,2032,2034],{"id":2033},"frequently-asked-questions","Frequently asked questions",[1226,2036,2038],{"id":2037},"can-live-combine-a-progress-bar-and-a-table","Can Live combine a progress bar and a table?",[10,2040,2041,2042,2045,2046,2048,2049,2052,2053,2056,2057,2059],{},"Yes. Put a ",[14,2043,2044],{},"Progress"," instance and a ",[14,2047,1242],{}," in a ",[14,2050,2051],{},"rich.console.Group"," (or a ",[14,2054,2055],{},"Layout",") and pass the group to ",[14,2058,16],{},"; update the progress normally and rebuild the table per tick.",[1226,2061,2063],{"id":2062},"how-do-i-feed-the-dashboard-from-concurrent-workers","How do I feed the dashboard from concurrent workers?",[10,2065,2066,2067,2070,2071,2074,2075,2077,2078,2081],{},"Let workers write their latest state into a dictionary keyed by task (guarded by a lock, or via a ",[14,2068,2069],{},"queue.Queue"," drained by the main thread), and make ",[14,2072,2073],{},"fetch"," return a snapshot of it. The main thread then owns the ",[14,2076,16],{}," display entirely, workers never touch the terminal, and the same ",[14,2079,2080],{},"watch"," function works whether states come from threads, asyncio tasks or a remote API.",[1226,2083,2085],{"id":2084},"why-does-my-live-display-flicker","Why does my live display flicker?",[10,2087,2088,2089,2091,2092,23],{},"Usually because the renderable is rebuilt far more often than the data changes, or because something prints with ",[14,2090,1336],{}," while live. Fetch at a sensible interval, update only when data changes, and print through ",[14,2093,2094],{},"live.console",[1226,2096,2098],{"id":2097},"should-the-final-frame-go-to-stdout-or-stderr","Should the final frame go to stdout or stderr?",[10,2100,2101,2102,2105],{},"A live dashboard is narration, so create its console with ",[14,2103,2104],{},"stderr=True"," when the command also prints results on stdout. The final summary then stays visible in the terminal while a script capturing stdout receives only the data it asked for.",[1226,2107,2109],{"id":2108},"does-live-work-over-ssh-and-in-tmux","Does Live work over SSH and in tmux?",[10,2111,2112,2113,2116],{},"Yes. It uses standard cursor movement, which works in any modern terminal, multiplexer or SSH session. With ",[14,2114,2115],{},"TERM=dumb"," Rich treats the output as non-interactive.",[1226,2118,2120],{"id":2119},"how-do-i-stop-the-display-from-a-worker-thread","How do I stop the display from a worker thread?",[10,2122,2123,2124,2126,2127,2130],{},"Set an event that the watching loop checks, and let the loop exit its ",[14,2125,67],{}," block on the main thread. Do not call ",[14,2128,2129],{},"live.stop()"," from other threads.",[25,2132,2134],{"id":2133},"related","Related",[30,2136,2137,2143,2149,2155,2161],{},[33,2138,2139,2140],{},"Up: ",[19,2141,2142],{"href":21},"Interactive terminal UI with Rich",[33,2144,2145],{},[19,2146,2148],{"href":2147},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fadding-progress-bars-and-spinners-to-python-clis\u002F","Adding progress bars and spinners to Python CLIs",[33,2150,2151],{},[19,2152,2154],{"href":2153},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich\u002F","Rendering tables and JSON with Rich",[33,2156,2157],{},[19,2158,2160],{"href":2159},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently\u002F","Theming Rich output consistently",[33,2162,2163],{},[19,2164,2166],{"href":2165},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhealth-checks-and-heartbeats-for-long-running-clis\u002F","Health checks and heartbeats for long-running CLIs",[2168,2169,2170],"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":87,"searchDepth":101,"depth":101,"links":2172},[2173,2174,2175,2178,2179,2180,2181,2182,2190],{"id":27,"depth":101,"text":28},{"id":45,"depth":101,"text":46},{"id":79,"depth":101,"text":80,"children":2176},[2177],{"id":1228,"depth":119,"text":1229},{"id":1284,"depth":101,"text":1285},{"id":1308,"depth":101,"text":1309},{"id":1372,"depth":101,"text":1373},{"id":2021,"depth":101,"text":2022},{"id":2033,"depth":101,"text":2034,"children":2183},[2184,2185,2186,2187,2188,2189],{"id":2037,"depth":119,"text":2038},{"id":2062,"depth":119,"text":2063},{"id":2084,"depth":119,"text":2085},{"id":2097,"depth":119,"text":2098},{"id":2108,"depth":119,"text":2109},{"id":2119,"depth":119,"text":2120},{"id":2133,"depth":101,"text":2134},"2026-09-18","Show progress across many tasks with a Rich Live table that redraws in place, falls back to one log line per change without a terminal, and is fully testable.","intermediate",false,"md",{},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live",{"title":5,"description":2192},"advanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live\u002Findex",[2201,2202,2203,2204],"rich","live","progress","terminal-ux","gZMFWhRfJOVSpeZEfmq0_ExL3t4X2zIBrBtGTyR1hHk",[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,2358,2361,2364,2367,2370,2373,2376,2379,2382,2385,2388,2391,2394,2397,2400,2403,2406,2409,2412,2415,2418,2421,2424,2427,2430,2433,2436,2439,2442,2445,2448,2451,2454,2457,2460,2463,2466,2469,2472,2475,2478,2481,2484,2487,2490,2493,2496,2499,2502,2505,2508,2511,2514,2517,2520,2523,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,2624,2627,2630,2633,2636,2639,2642,2645,2648,2651,2654,2657,2660,2663,2666,2669,2672,2675,2678,2681,2684,2687,2690,2693,2696,2699,2702,2705,2708,2711,2714,2717,2720,2723,2726,2729,2732,2735,2738,2741,2744,2747,2750,2753,2756,2759,2762,2765,2768,2771,2774,2777,2780,2783,2786,2789,2792,2795,2798,2801,2804,2807,2810,2813,2816,2819,2822,2825,2828,2831,2834,2837,2840,2843,2846,2849,2852,2855,2858,2861,2864,2867,2870,2873,2876,2879,2882,2885,2888,2891,2894,2897,2900,2903,2906,2909,2912,2915,2918,2921,2924,2927,2930,2933,2936,2939,2942,2945,2948,2951,2954,2957,2960,2963,2966,2969,2972,2975,2978,2981,2984,2987,2990,2993,2996,2999,3002,3005,3008,3011,3014,3017,3020,3023,3026,3029,3032,3035,3038,3041,3044,3047],{"path":2208,"title":2209},"\u002Fabout","About Python CLI Toolcraft",{"path":2211,"title":2212},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2214,"title":2215},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2217,"title":2218},"\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":2220,"title":2221},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2223,"title":2224},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2226,"title":2227},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2229,"title":2230},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2232,"title":2233},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2235,"title":2236},"\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":2238,"title":2239},"\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":2241,"title":2242},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2244,"title":2245},"\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":2247,"title":2248},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2250,"title":2251},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2253,"title":2254},"\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":2256,"title":2257},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2259,"title":2260},"\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":2262,"title":2263},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2265,"title":2266},"\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":2268,"title":2269},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2271,"title":2272},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2274,"title":2275},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2277,"title":2278},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2280,"title":2281},"\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":2283,"title":2284},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2286,"title":2287},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2289,"title":2290},"\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":2292,"title":2293},"\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":2295,"title":2296},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2298,"title":2299},"\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":2301,"title":2302},"\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":2304,"title":2305},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2307,"title":2308},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2310,"title":2311},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2313,"title":2314},"\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":2316,"title":2317},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2319,"title":2320},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2322,"title":2323},"\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":2325,"title":2326},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2328,"title":2329},"\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":2331,"title":2332},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2334,"title":2335},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2337,"title":2338},"\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":2340,"title":2341},"\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":2343,"title":2344},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2346,"title":2347},"\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":2349,"title":2350},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2352,"title":2353},"\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":2355,"title":2356},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2197,"title":5},{"path":2359,"title":2360},"\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":2362,"title":2363},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2365,"title":2366},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2368,"title":2369},"\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":2371,"title":2372},"\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":2374,"title":2375},"\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":2377,"title":2378},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2380,"title":2381},"\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":2383,"title":2384},"\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":2386,"title":2387},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2389,"title":2390},"\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":2392,"title":2393},"\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":2395,"title":2396},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2398,"title":2399},"\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":2401,"title":2402},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2404,"title":2405},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2407,"title":2408},"\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":2410,"title":2411},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2413,"title":2414},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2416,"title":2417},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2419,"title":2420},"\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":2422,"title":2423},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2425,"title":2426},"\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":2428,"title":2429},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2431,"title":2432},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2434,"title":2435},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2437,"title":2438},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2440,"title":2441},"\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":2443,"title":2444},"\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":2446,"title":2447},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2449,"title":2450},"\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":2452,"title":2453},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2455,"title":2456},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2458,"title":2459},"\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":2461,"title":2462},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2464,"title":2465},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2467,"title":2468},"\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":2470,"title":2471},"\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":2473,"title":2474},"\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":2476,"title":2477},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2479,"title":2480},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2482,"title":2483},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2485,"title":2486},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2488,"title":2489},"\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":2491,"title":2492},"\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":2494,"title":2495},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2497,"title":2498},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2500,"title":2501},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2503,"title":2504},"\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":2506,"title":2507},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2509,"title":2510},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2512,"title":2513},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2515,"title":2516},"\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":2518,"title":2519},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2521,"title":2522},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2524,"title":2525},"\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":2527,"title":2528},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2530,"title":2531},"\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":2533,"title":2534},"\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":2536,"title":2537},"\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":2539,"title":2540},"\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":2542,"title":2543},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2545,"title":2546},"\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":2548,"title":2549},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2551,"title":2552},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2554,"title":2555},"\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":2557,"title":2558},"\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":2560,"title":2561},"\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":2563,"title":2564},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2566,"title":2567},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2569,"title":2570},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2572,"title":2573},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2575,"title":2576},"\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":2578,"title":2579},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2581,"title":2582},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2584,"title":2585},"\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":2587,"title":2588},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2590,"title":2591},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2593,"title":2594},"\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":2596,"title":2597},"\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":2599,"title":2600},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2602,"title":2603},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2605,"title":2606},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2608,"title":2609},"\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":2611,"title":2612},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2614,"title":2615},"\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":2617,"title":2618},"\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":2620,"title":2621},"\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":590,"title":2623},"Python CLI Toolcraft",{"path":2625,"title":2626},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2628,"title":2629},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2631,"title":2632},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2634,"title":2635},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2637,"title":2638},"\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":2640,"title":2641},"\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":2643,"title":2644},"\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":2646,"title":2647},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2649,"title":2650},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2652,"title":2653},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2655,"title":2656},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2658,"title":2659},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2661,"title":2662},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2664,"title":2665},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2667,"title":2668},"\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":2670,"title":2671},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2673,"title":2674},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2676,"title":2677},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2679,"title":2680},"\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":2682,"title":2683},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2685,"title":2686},"\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":2688,"title":2689},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2691,"title":2692},"\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":2694,"title":2695},"\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":2697,"title":2698},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2700,"title":2701},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2703,"title":2704},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2706,"title":2707},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2709,"title":2710},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2712,"title":2713},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2715,"title":2716},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2718,"title":2719},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2721,"title":2722},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2724,"title":2725},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2727,"title":2728},"\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":2730,"title":2731},"\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":2733,"title":2734},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2736,"title":2737},"\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":2739,"title":2740},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2742,"title":2743},"\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":2745,"title":2746},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":2748,"title":2749},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2751,"title":2752},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2754,"title":2755},"\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":2757,"title":2758},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2760,"title":2761},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2763,"title":2764},"\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":2766,"title":2767},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2769,"title":2770},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2772,"title":2773},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2775,"title":2776},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2778,"title":2779},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2781,"title":2782},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2784,"title":2785},"\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":2787,"title":2788},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2790,"title":2791},"\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":2793,"title":2794},"\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":2796,"title":2797},"\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":2799,"title":2800},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2802,"title":2803},"\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":2805,"title":2806},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2808,"title":2809},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2811,"title":2812},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2814,"title":2815},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2817,"title":2818},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2820,"title":2821},"\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":2823,"title":2824},"\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":2826,"title":2827},"\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":2829,"title":2830},"\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":2832,"title":2833},"\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":2835,"title":2836},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2838,"title":2839},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2841,"title":2842},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2844,"title":2845},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2847,"title":2848},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2850,"title":2851},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2853,"title":2854},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2856,"title":2857},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2859,"title":2860},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2862,"title":2863},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2865,"title":2866},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2868,"title":2869},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2871,"title":2872},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2874,"title":2875},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2877,"title":2878},"\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":2880,"title":2881},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2883,"title":2884},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2886,"title":2887},"\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":2889,"title":2890},"\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":2892,"title":2893},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2895,"title":2896},"\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":2898,"title":2899},"\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":2901,"title":2902},"\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":2904,"title":2905},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2907,"title":2908},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2910,"title":2911},"\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":2913,"title":2914},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2916,"title":2917},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2919,"title":2920},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2922,"title":2923},"\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":2925,"title":2926},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2928,"title":2929},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2931,"title":2932},"\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":2934,"title":2935},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2937,"title":2938},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2940,"title":2941},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2943,"title":2944},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2946,"title":2947},"\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":2949,"title":2950},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2952,"title":2953},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2955,"title":2956},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2958,"title":2959},"\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":2961,"title":2962},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2964,"title":2965},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2967,"title":2968},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2970,"title":2971},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2973,"title":2974},"\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":2976,"title":2977},"\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":2979,"title":2980},"\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":2982,"title":2983},"\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":2985,"title":2986},"\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":2988,"title":2989},"\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":2991,"title":2992},"\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":2994,"title":2995},"\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":2997,"title":2998},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":3000,"title":3001},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":3003,"title":3004},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":3006,"title":3007},"\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":3009,"title":3010},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":3012,"title":3013},"\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":3015,"title":3016},"\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":3018,"title":3019},"\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":3021,"title":3022},"\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":3024,"title":3025},"\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":3027,"title":3028},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3030,"title":3031},"\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":3033,"title":3034},"\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":3036,"title":3037},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3039,"title":3040},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3042,"title":3043},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3045,"title":3046},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3048,"title":3049},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967537211]