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