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