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