[{"data":1,"prerenderedAt":2415},["ShallowReactive",2],{"page-\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically\u002F":3,"content-directory":1570},{"id":4,"title":5,"body":6,"date":1556,"description":1557,"difficulty":1558,"draft":1559,"extension":1560,"meta":1561,"navigation":129,"path":1562,"seo":1563,"stem":1564,"tags":1565,"updated":1556,"__hash__":1569},"content\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically\u002Findex.md","Registering CLI Commands from Modules Automatically",{"type":7,"value":8,"toc":1535},"minimark",[9,36,41,53,57,61,76,86,90,524,538,629,632,637,652,656,669,673,699,836,850,854,867,897,914,918,921,952,955,1006,1009,1012,1016,1019,1053,1057,1385,1403,1407,1423,1427,1431,1461,1465,1475,1479,1486,1490,1497,1501,1531],[10,11,12,13,17,18,21,22,25,26,29,30,35],"p",{},"A CLI with five command groups registers them by hand in one file and nobody minds. A CLI with forty, maintained by several teams, ends up with a ",[14,15,16],"code",{},"cli.py"," that is mostly imports and ",[14,19,20],{},"add_typer"," calls — a merge-conflict magnet where forgetting one line means a finished command silently never appears. Automatic registration removes that file: every module dropped into a ",[14,23,24],{},"commands\u002F"," package that follows a simple convention becomes a command group, discovered at startup with the standard library's ",[14,27,28],{},"pkgutil",". It is the internal cousin of a plugin system — same idea, but for code in your own package, with none of the trust concerns. This guide builds it, covers naming and ordering, explains the one environment where it breaks (frozen binaries), and compares it with the explicit-registry alternative. It belongs to the ",[31,32,34],"a",{"href":33},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002F","multi-command structure topic",".",[37,38,40],"h2",{"id":39},"prerequisites","Prerequisites",[42,43,44],"ul",{},[45,46,47,48,52],"li",{},"A Typer (or Click) CLI using the layout from ",[31,49,51],{"href":50},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fhow-to-structure-a-large-python-cli-project\u002F","how to structure a large Python CLI project",", with command modules in a package.",[37,54,56],{"id":55},"the-convention","The convention",[58,59],"inline-diagram",{"name":60},"autoreg-convention",[10,62,63,64,67,68,71,72,75],{},"Each module in ",[14,65,66],{},"mytool\u002Fcommands\u002F"," that defines a module-level ",[14,69,70],{},"app = typer.Typer(...)"," becomes a subcommand group. The group's name is the module name with underscores turned into dashes, unless the module sets ",[14,73,74],{},"COMMAND_NAME",". Modules whose names start with an underscore are private helpers and are skipped. That is the whole contract, and it fits in the package's docstring.",[77,78,84],"pre",{"className":79,"code":81,"language":82,"meta":83},[80],"language-text","src\u002Fmytool\u002F\n├── cli.py\n└── commands\u002F\n    ├── __init__.py        # \"\"\"Every module here that defines `app` becomes a command group.\"\"\"\n    ├── users.py           # app = typer.Typer(help=\"Manage users.\")        -> mytool users\n    ├── db_tools.py        # app = ...; COMMAND_NAME = \"db\"                 -> mytool db\n    └── _helpers.py        # skipped: private\n","text","",[14,85,81],{"__ignoreMap":83},[37,87,89],{"id":88},"the-recipe","The recipe",[77,91,95],{"className":92,"code":93,"language":94,"meta":83,"style":83},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fcli.py\nfrom __future__ import annotations\n\nimport importlib\nimport pkgutil\n\nimport typer\n\nfrom mytool import commands\n\n\ndef discover_command_modules() -> list[str]:\n    return sorted(m.name for m in pkgutil.iter_modules(commands.__path__)\n                  if not m.name.startswith(\"_\"))\n\n\ndef build_app() -> typer.Typer:\n    app = typer.Typer(no_args_is_help=True)\n\n    @app.callback()\n    def main() -> None:\n        \"\"\"mytool.\"\"\"\n\n    for name in discover_command_modules():\n        module = importlib.import_module(f\"{commands.__name__}.{name}\")\n        sub = getattr(module, \"app\", None)\n        if not isinstance(sub, typer.Typer):\n            raise TypeError(f\"{module.__name__} must define `app = typer.Typer(...)`\")\n        app.add_typer(sub, name=getattr(module, \"COMMAND_NAME\", name.replace(\"_\", \"-\")))\n    return app\n\n\napp = build_app()\n","python",[14,96,97,106,124,131,140,148,153,161,166,179,184,189,208,238,257,262,267,278,301,306,315,333,339,344,358,398,422,436,464,495,503,508,513],{"__ignoreMap":83},[98,99,102],"span",{"class":100,"line":101},"line",1,[98,103,105],{"class":104},"sJ8bj","# src\u002Fmytool\u002Fcli.py\n",[98,107,109,113,117,120],{"class":100,"line":108},2,[98,110,112],{"class":111},"szBVR","from",[98,114,116],{"class":115},"sj4cs"," __future__",[98,118,119],{"class":111}," import",[98,121,123],{"class":122},"sVt8B"," annotations\n",[98,125,127],{"class":100,"line":126},3,[98,128,130],{"emptyLinePlaceholder":129},true,"\n",[98,132,134,137],{"class":100,"line":133},4,[98,135,136],{"class":111},"import",[98,138,139],{"class":122}," importlib\n",[98,141,143,145],{"class":100,"line":142},5,[98,144,136],{"class":111},[98,146,147],{"class":122}," pkgutil\n",[98,149,151],{"class":100,"line":150},6,[98,152,130],{"emptyLinePlaceholder":129},[98,154,156,158],{"class":100,"line":155},7,[98,157,136],{"class":111},[98,159,160],{"class":122}," typer\n",[98,162,164],{"class":100,"line":163},8,[98,165,130],{"emptyLinePlaceholder":129},[98,167,169,171,174,176],{"class":100,"line":168},9,[98,170,112],{"class":111},[98,172,173],{"class":122}," mytool ",[98,175,136],{"class":111},[98,177,178],{"class":122}," commands\n",[98,180,182],{"class":100,"line":181},10,[98,183,130],{"emptyLinePlaceholder":129},[98,185,187],{"class":100,"line":186},11,[98,188,130],{"emptyLinePlaceholder":129},[98,190,192,195,199,202,205],{"class":100,"line":191},12,[98,193,194],{"class":111},"def",[98,196,198],{"class":197},"sScJk"," discover_command_modules",[98,200,201],{"class":122},"() -> list[",[98,203,204],{"class":115},"str",[98,206,207],{"class":122},"]:\n",[98,209,211,214,217,220,223,226,229,232,235],{"class":100,"line":210},13,[98,212,213],{"class":111},"    return",[98,215,216],{"class":115}," sorted",[98,218,219],{"class":122},"(m.name ",[98,221,222],{"class":111},"for",[98,224,225],{"class":122}," m ",[98,227,228],{"class":111},"in",[98,230,231],{"class":122}," pkgutil.iter_modules(commands.",[98,233,234],{"class":115},"__path__",[98,236,237],{"class":122},")\n",[98,239,241,244,247,250,254],{"class":100,"line":240},14,[98,242,243],{"class":111},"                  if",[98,245,246],{"class":111}," not",[98,248,249],{"class":122}," m.name.startswith(",[98,251,253],{"class":252},"sZZnC","\"_\"",[98,255,256],{"class":122},"))\n",[98,258,260],{"class":100,"line":259},15,[98,261,130],{"emptyLinePlaceholder":129},[98,263,265],{"class":100,"line":264},16,[98,266,130],{"emptyLinePlaceholder":129},[98,268,270,272,275],{"class":100,"line":269},17,[98,271,194],{"class":111},[98,273,274],{"class":197}," build_app",[98,276,277],{"class":122},"() -> typer.Typer:\n",[98,279,281,284,287,290,294,296,299],{"class":100,"line":280},18,[98,282,283],{"class":122},"    app ",[98,285,286],{"class":111},"=",[98,288,289],{"class":122}," typer.Typer(",[98,291,293],{"class":292},"s4XuR","no_args_is_help",[98,295,286],{"class":111},[98,297,298],{"class":115},"True",[98,300,237],{"class":122},[98,302,304],{"class":100,"line":303},19,[98,305,130],{"emptyLinePlaceholder":129},[98,307,309,312],{"class":100,"line":308},20,[98,310,311],{"class":197},"    @app.callback",[98,313,314],{"class":122},"()\n",[98,316,318,321,324,327,330],{"class":100,"line":317},21,[98,319,320],{"class":111},"    def",[98,322,323],{"class":197}," main",[98,325,326],{"class":122},"() -> ",[98,328,329],{"class":115},"None",[98,331,332],{"class":122},":\n",[98,334,336],{"class":100,"line":335},22,[98,337,338],{"class":252},"        \"\"\"mytool.\"\"\"\n",[98,340,342],{"class":100,"line":341},23,[98,343,130],{"emptyLinePlaceholder":129},[98,345,347,350,353,355],{"class":100,"line":346},24,[98,348,349],{"class":111},"    for",[98,351,352],{"class":122}," name ",[98,354,228],{"class":111},[98,356,357],{"class":122}," discover_command_modules():\n",[98,359,361,364,366,369,372,375,378,381,384,386,388,391,394,396],{"class":100,"line":360},25,[98,362,363],{"class":122},"        module ",[98,365,286],{"class":111},[98,367,368],{"class":122}," importlib.import_module(",[98,370,371],{"class":111},"f",[98,373,374],{"class":252},"\"",[98,376,377],{"class":115},"{",[98,379,380],{"class":122},"commands.",[98,382,383],{"class":115},"__name__}",[98,385,35],{"class":252},[98,387,377],{"class":115},[98,389,390],{"class":122},"name",[98,392,393],{"class":115},"}",[98,395,374],{"class":252},[98,397,237],{"class":122},[98,399,401,404,406,409,412,415,418,420],{"class":100,"line":400},26,[98,402,403],{"class":122},"        sub ",[98,405,286],{"class":111},[98,407,408],{"class":115}," getattr",[98,410,411],{"class":122},"(module, ",[98,413,414],{"class":252},"\"app\"",[98,416,417],{"class":122},", ",[98,419,329],{"class":115},[98,421,237],{"class":122},[98,423,425,428,430,433],{"class":100,"line":424},27,[98,426,427],{"class":111},"        if",[98,429,246],{"class":111},[98,431,432],{"class":115}," isinstance",[98,434,435],{"class":122},"(sub, typer.Typer):\n",[98,437,439,442,445,448,450,452,454,457,459,462],{"class":100,"line":438},28,[98,440,441],{"class":111},"            raise",[98,443,444],{"class":115}," TypeError",[98,446,447],{"class":122},"(",[98,449,371],{"class":111},[98,451,374],{"class":252},[98,453,377],{"class":115},[98,455,456],{"class":122},"module.",[98,458,383],{"class":115},[98,460,461],{"class":252}," must define `app = typer.Typer(...)`\"",[98,463,237],{"class":122},[98,465,467,470,472,474,477,479,482,485,487,489,492],{"class":100,"line":466},29,[98,468,469],{"class":122},"        app.add_typer(sub, ",[98,471,390],{"class":292},[98,473,286],{"class":111},[98,475,476],{"class":115},"getattr",[98,478,411],{"class":122},[98,480,481],{"class":252},"\"COMMAND_NAME\"",[98,483,484],{"class":122},", name.replace(",[98,486,253],{"class":252},[98,488,417],{"class":122},[98,490,491],{"class":252},"\"-\"",[98,493,494],{"class":122},")))\n",[98,496,498,500],{"class":100,"line":497},30,[98,499,213],{"class":111},[98,501,502],{"class":122}," app\n",[98,504,506],{"class":100,"line":505},31,[98,507,130],{"emptyLinePlaceholder":129},[98,509,511],{"class":100,"line":510},32,[98,512,130],{"emptyLinePlaceholder":129},[98,514,516,519,521],{"class":100,"line":515},33,[98,517,518],{"class":122},"app ",[98,520,286],{"class":111},[98,522,523],{"class":122}," build_app()\n",[10,525,526,529,530,533,534,35],{},[14,527,528],{},"pkgutil.iter_modules(commands.__path__)"," lists the modules and subpackages directly inside the package without importing them — it reads directory listings (or a zip's index). Sorting makes the order deterministic, so help output and tests do not depend on filesystem ordering. A module that does not follow the convention is a programming error, so it fails loudly with a ",[14,531,532],{},"TypeError"," naming the module rather than being skipped silently — the opposite of the policy for third-party plugins in ",[31,535,537],{"href":536},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures\u002F","isolating plugin failures",[77,539,541],{"className":92,"code":540,"language":94,"meta":83,"style":83},"# src\u002Fmytool\u002Fcommands\u002Fdb_tools.py\nimport typer\n\napp = typer.Typer(help=\"Database maintenance.\")\nCOMMAND_NAME = \"db\"\n\n\n@app.command()\ndef vacuum() -> None:\n    \"\"\"Reclaim space.\"\"\"\n    typer.echo(\"vacuumed\")\n",[14,542,543,548,554,558,576,586,590,594,601,614,619],{"__ignoreMap":83},[98,544,545],{"class":100,"line":101},[98,546,547],{"class":104},"# src\u002Fmytool\u002Fcommands\u002Fdb_tools.py\n",[98,549,550,552],{"class":100,"line":108},[98,551,136],{"class":111},[98,553,160],{"class":122},[98,555,556],{"class":100,"line":126},[98,557,130],{"emptyLinePlaceholder":129},[98,559,560,562,564,566,569,571,574],{"class":100,"line":133},[98,561,518],{"class":122},[98,563,286],{"class":111},[98,565,289],{"class":122},[98,567,568],{"class":292},"help",[98,570,286],{"class":111},[98,572,573],{"class":252},"\"Database maintenance.\"",[98,575,237],{"class":122},[98,577,578,580,583],{"class":100,"line":142},[98,579,74],{"class":115},[98,581,582],{"class":111}," =",[98,584,585],{"class":252}," \"db\"\n",[98,587,588],{"class":100,"line":150},[98,589,130],{"emptyLinePlaceholder":129},[98,591,592],{"class":100,"line":155},[98,593,130],{"emptyLinePlaceholder":129},[98,595,596,599],{"class":100,"line":163},[98,597,598],{"class":197},"@app.command",[98,600,314],{"class":122},[98,602,603,605,608,610,612],{"class":100,"line":168},[98,604,194],{"class":111},[98,606,607],{"class":197}," vacuum",[98,609,326],{"class":122},[98,611,329],{"class":115},[98,613,332],{"class":122},[98,615,616],{"class":100,"line":181},[98,617,618],{"class":252},"    \"\"\"Reclaim space.\"\"\"\n",[98,620,621,624,627],{"class":100,"line":186},[98,622,623],{"class":122},"    typer.echo(",[98,625,626],{"class":252},"\"vacuumed\"",[98,628,237],{"class":122},[58,630],{"name":631},"autoreg-terminal",[633,634,636],"h3",{"id":635},"ordering-commands-in-help","Ordering commands in help",[10,638,639,640,643,644,647,648,651],{},"Typer lists commands in registration order, so alphabetical discovery gives alphabetical help — usually fine. If some commands should come first, let modules declare a ",[14,641,642],{},"COMMAND_ORDER"," integer and sort by ",[14,645,646],{},"(order, name)",", or use Rich help panels (",[14,649,650],{},"rich_help_panel=",") to group commands under headings, which reads better than any ordering trick once there are more than a dozen.",[633,653,655],{"id":654},"lazy-loading","Lazy loading",[10,657,658,659,663,664,668],{},"Discovery imports every command module at startup, which is cheap only if command modules keep heavy imports inside their functions. If they cannot, combine discovery with lazy loading: list module ",[660,661,662],"em",{},"names"," at startup to build the help and command list, and import a module only when its command is invoked, using a lazy group as in ",[31,665,667],{"href":666},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup\u002F","lazy-loading subcommands for faster startup",". The cost is that each group's one-line help must then be available without importing it — for example from a small metadata mapping.",[633,670,672],{"id":671},"subpackages-as-nested-groups","Subpackages as nested groups",[10,674,675,676,417,679,682,683,686,687,690,691,694,695,698],{},"When one area grows its own family of commands — ",[14,677,678],{},"mytool cloud aws …",[14,680,681],{},"mytool cloud gcp …"," — a subpackage can apply the same convention one level down. ",[14,684,685],{},"pkgutil.iter_modules"," reports subpackages with ",[14,688,689],{},"ispkg=True","; the subpackage's ",[14,692,693],{},"__init__.py"," defines its own ",[14,696,697],{},"app",", discovers its own modules with the same helper, and is mounted like any other module:",[77,700,702],{"className":92,"code":701,"language":94,"meta":83,"style":83},"def discover(package) -> list[tuple[str, typer.Typer]]:\n    found = []\n    for info in sorted(pkgutil.iter_modules(package.__path__), key=lambda i: i.name):\n        if info.name.startswith(\"_\"):\n            continue\n        module = importlib.import_module(f\"{package.__name__}.{info.name}\")\n        found.append((getattr(module, \"COMMAND_NAME\", info.name.replace(\"_\", \"-\")), module.app))\n    return found\n",[14,703,704,719,729,757,769,774,806,829],{"__ignoreMap":83},[98,705,706,708,711,714,716],{"class":100,"line":101},[98,707,194],{"class":111},[98,709,710],{"class":197}," discover",[98,712,713],{"class":122},"(package) -> list[tuple[",[98,715,204],{"class":115},[98,717,718],{"class":122},", typer.Typer]]:\n",[98,720,721,724,726],{"class":100,"line":108},[98,722,723],{"class":122},"    found ",[98,725,286],{"class":111},[98,727,728],{"class":122}," []\n",[98,730,731,733,736,738,740,743,745,748,751,754],{"class":100,"line":126},[98,732,349],{"class":111},[98,734,735],{"class":122}," info ",[98,737,228],{"class":111},[98,739,216],{"class":115},[98,741,742],{"class":122},"(pkgutil.iter_modules(package.",[98,744,234],{"class":115},[98,746,747],{"class":122},"), ",[98,749,750],{"class":292},"key",[98,752,753],{"class":111},"=lambda",[98,755,756],{"class":122}," i: i.name):\n",[98,758,759,761,764,766],{"class":100,"line":133},[98,760,427],{"class":111},[98,762,763],{"class":122}," info.name.startswith(",[98,765,253],{"class":252},[98,767,768],{"class":122},"):\n",[98,770,771],{"class":100,"line":142},[98,772,773],{"class":111},"            continue\n",[98,775,776,778,780,782,784,786,788,791,793,795,797,800,802,804],{"class":100,"line":150},[98,777,363],{"class":122},[98,779,286],{"class":111},[98,781,368],{"class":122},[98,783,371],{"class":111},[98,785,374],{"class":252},[98,787,377],{"class":115},[98,789,790],{"class":122},"package.",[98,792,383],{"class":115},[98,794,35],{"class":252},[98,796,377],{"class":115},[98,798,799],{"class":122},"info.name",[98,801,393],{"class":115},[98,803,374],{"class":252},[98,805,237],{"class":122},[98,807,808,811,813,815,817,820,822,824,826],{"class":100,"line":155},[98,809,810],{"class":122},"        found.append((",[98,812,476],{"class":115},[98,814,411],{"class":122},[98,816,481],{"class":252},[98,818,819],{"class":122},", info.name.replace(",[98,821,253],{"class":252},[98,823,417],{"class":122},[98,825,491],{"class":252},[98,827,828],{"class":122},")), module.app))\n",[98,830,831,833],{"class":100,"line":163},[98,832,213],{"class":111},[98,834,835],{"class":122}," found\n",[10,837,838,839,842,843,845,846,849],{},"Each package then mounts what ",[14,840,841],{},"discover(...)"," returns onto its own ",[14,844,697],{},". Keeping the recursion explicit — each level calls the helper for its own children — means the command tree mirrors the package tree exactly, and a reader can always answer \"where does ",[14,847,848],{},"mytool cloud aws"," come from?\" by following directories.",[37,851,853],{"id":852},"frozen-binaries-need-help","Frozen binaries need help",[10,855,856,857,859,860,863,864,866],{},"PyInstaller and similar tools decide what to bundle by following ",[14,858,136],{}," statements. Modules that are only ever imported by name through ",[14,861,862],{},"importlib.import_module"," are invisible to that analysis, so a frozen binary contains ",[14,865,16],{}," but not the command modules — and starts with no commands at all. Tell the bundler explicitly:",[77,868,872],{"className":869,"code":870,"language":871,"meta":83,"style":83},"language-bash shiki shiki-themes github-light github-dark","pyinstaller --onefile --collect-submodules mytool.commands -n mytool src\u002Fmytool\u002F__main__.py\n","bash",[14,873,874],{"__ignoreMap":83},[98,875,876,879,882,885,888,891,894],{"class":100,"line":101},[98,877,878],{"class":197},"pyinstaller",[98,880,881],{"class":115}," --onefile",[98,883,884],{"class":115}," --collect-submodules",[98,886,887],{"class":252}," mytool.commands",[98,889,890],{"class":115}," -n",[98,892,893],{"class":252}," mytool",[98,895,896],{"class":252}," src\u002Fmytool\u002F__main__.py\n",[10,898,899,902,903,905,906,909,910,35],{},[14,900,901],{},"--collect-submodules"," bundles every module in the package, and PyInstaller's import machinery supports ",[14,904,685],{}," inside the frozen app. Add a smoke test of the built binary that checks at least one auto-registered command appears in ",[14,907,908],{},"--help",", as in ",[31,911,913],{"href":912},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller\u002F","bundling a Python CLI with PyInstaller",[37,915,917],{"id":916},"explicit-registry-the-alternative","Explicit registry: the alternative",[10,919,920],{},"Automatic discovery trades explicitness for convenience. The alternative keeps a single list:",[77,922,924],{"className":92,"code":923,"language":94,"meta":83,"style":83},"COMMAND_MODULES = [\"users\", \"db_tools\", \"reports\"]\n",[14,925,926],{"__ignoreMap":83},[98,927,928,931,933,936,939,941,944,946,949],{"class":100,"line":101},[98,929,930],{"class":115},"COMMAND_MODULES",[98,932,582],{"class":111},[98,934,935],{"class":122}," [",[98,937,938],{"class":252},"\"users\"",[98,940,417],{"class":122},[98,942,943],{"class":252},"\"db_tools\"",[98,945,417],{"class":122},[98,947,948],{"class":252},"\"reports\"",[98,950,951],{"class":122},"]\n",[10,953,954],{},"An explicit list works with every bundler and type checker, makes \"where is this command registered?\" a text search away, and lets you control order exactly. The weakness is forgetting to add a module — which a test fixes cheaply:",[77,956,958],{"className":92,"code":957,"language":94,"meta":83,"style":83},"def test_every_command_module_is_registered():\n    from mytool.cli import COMMAND_MODULES, discover_command_modules\n    assert sorted(COMMAND_MODULES) == discover_command_modules()\n",[14,959,960,970,986],{"__ignoreMap":83},[98,961,962,964,967],{"class":100,"line":101},[98,963,194],{"class":111},[98,965,966],{"class":197}," test_every_command_module_is_registered",[98,968,969],{"class":122},"():\n",[98,971,972,975,978,980,983],{"class":100,"line":108},[98,973,974],{"class":111},"    from",[98,976,977],{"class":122}," mytool.cli ",[98,979,136],{"class":111},[98,981,982],{"class":115}," COMMAND_MODULES",[98,984,985],{"class":122},", discover_command_modules\n",[98,987,988,991,993,995,997,1000,1003],{"class":100,"line":126},[98,989,990],{"class":111},"    assert",[98,992,216],{"class":115},[98,994,447],{"class":122},[98,996,930],{"class":115},[98,998,999],{"class":122},") ",[98,1001,1002],{"class":111},"==",[98,1004,1005],{"class":122}," discover_command_modules()\n",[58,1007],{"name":1008},"autoreg-compare",[10,1010,1011],{},"Choose discovery for large CLIs where many people add commands and the convention is easy to state; choose the explicit list with a guard test for smaller CLIs, or ones shipped as frozen binaries where every extra build flag is a liability.",[37,1013,1015],{"id":1014},"ux-considerations","UX considerations",[10,1017,1018],{},"The users of this mechanism are the developers adding commands:",[42,1020,1021,1032,1041,1047],{},[45,1022,1023,1027,1028,1031],{},[1024,1025,1026],"strong",{},"Document the convention where they will look"," — the ",[14,1029,1030],{},"commands\u002F__init__.py"," docstring and the contributing guide — in two sentences.",[45,1033,1034,1037,1038,1040],{},[1024,1035,1036],{},"Fail loudly on violations."," A module without ",[14,1039,697],{},", or two modules mapping to the same command name, should break at startup with a message naming the files involved.",[45,1042,1043,1046],{},[1024,1044,1045],{},"Keep helpers private by name."," The underscore rule means shared helpers never accidentally become commands.",[45,1048,1049,1052],{},[1024,1050,1051],{},"Do not discover recursively by default."," One level keeps the mapping from files to commands obvious; nested groups can register their own children explicitly.",[37,1054,1056],{"id":1055},"testing-the-behaviour","Testing the behaviour",[77,1058,1060],{"className":92,"code":1059,"language":94,"meta":83,"style":83},"# tests\u002Ftest_registration.py\nfrom typer.testing import CliRunner\n\nfrom mytool.cli import build_app, discover_command_modules\n\n\ndef test_private_modules_are_skipped():\n    assert \"_helpers\" not in discover_command_modules()\n\n\ndef test_names_come_from_modules_or_command_name():\n    result = CliRunner().invoke(build_app(), [\"--help\"])\n    assert \"users\" in result.output and \" db \" in result.output\n    assert \"db-tools\" not in result.output\n\n\ndef test_auto_registered_command_runs():\n    assert CliRunner().invoke(build_app(), [\"db\", \"vacuum\"]).output == \"vacuumed\\n\"\n\n\ndef test_no_duplicate_command_names():\n    import importlib\n\n    from mytool import commands\n    names = []\n    for module_name in discover_command_modules():\n        module = importlib.import_module(f\"{commands.__name__}.{module_name}\")\n        names.append(getattr(module, \"COMMAND_NAME\", module_name.replace(\"_\", \"-\")))\n    assert len(names) == len(set(names)), f\"duplicate command names: {names}\"\n",[14,1061,1062,1067,1079,1083,1094,1098,1102,1111,1125,1129,1133,1142,1158,1181,1194,1198,1202,1211,1239,1243,1247,1256,1263,1267,1277,1286,1297,1328,1350],{"__ignoreMap":83},[98,1063,1064],{"class":100,"line":101},[98,1065,1066],{"class":104},"# tests\u002Ftest_registration.py\n",[98,1068,1069,1071,1074,1076],{"class":100,"line":108},[98,1070,112],{"class":111},[98,1072,1073],{"class":122}," typer.testing ",[98,1075,136],{"class":111},[98,1077,1078],{"class":122}," CliRunner\n",[98,1080,1081],{"class":100,"line":126},[98,1082,130],{"emptyLinePlaceholder":129},[98,1084,1085,1087,1089,1091],{"class":100,"line":133},[98,1086,112],{"class":111},[98,1088,977],{"class":122},[98,1090,136],{"class":111},[98,1092,1093],{"class":122}," build_app, discover_command_modules\n",[98,1095,1096],{"class":100,"line":142},[98,1097,130],{"emptyLinePlaceholder":129},[98,1099,1100],{"class":100,"line":150},[98,1101,130],{"emptyLinePlaceholder":129},[98,1103,1104,1106,1109],{"class":100,"line":155},[98,1105,194],{"class":111},[98,1107,1108],{"class":197}," test_private_modules_are_skipped",[98,1110,969],{"class":122},[98,1112,1113,1115,1118,1120,1123],{"class":100,"line":163},[98,1114,990],{"class":111},[98,1116,1117],{"class":252}," \"_helpers\"",[98,1119,246],{"class":111},[98,1121,1122],{"class":111}," in",[98,1124,1005],{"class":122},[98,1126,1127],{"class":100,"line":168},[98,1128,130],{"emptyLinePlaceholder":129},[98,1130,1131],{"class":100,"line":181},[98,1132,130],{"emptyLinePlaceholder":129},[98,1134,1135,1137,1140],{"class":100,"line":186},[98,1136,194],{"class":111},[98,1138,1139],{"class":197}," test_names_come_from_modules_or_command_name",[98,1141,969],{"class":122},[98,1143,1144,1147,1149,1152,1155],{"class":100,"line":191},[98,1145,1146],{"class":122},"    result ",[98,1148,286],{"class":111},[98,1150,1151],{"class":122}," CliRunner().invoke(build_app(), [",[98,1153,1154],{"class":252},"\"--help\"",[98,1156,1157],{"class":122},"])\n",[98,1159,1160,1162,1165,1167,1170,1173,1176,1178],{"class":100,"line":210},[98,1161,990],{"class":111},[98,1163,1164],{"class":252}," \"users\"",[98,1166,1122],{"class":111},[98,1168,1169],{"class":122}," result.output ",[98,1171,1172],{"class":111},"and",[98,1174,1175],{"class":252}," \" db \"",[98,1177,1122],{"class":111},[98,1179,1180],{"class":122}," result.output\n",[98,1182,1183,1185,1188,1190,1192],{"class":100,"line":240},[98,1184,990],{"class":111},[98,1186,1187],{"class":252}," \"db-tools\"",[98,1189,246],{"class":111},[98,1191,1122],{"class":111},[98,1193,1180],{"class":122},[98,1195,1196],{"class":100,"line":259},[98,1197,130],{"emptyLinePlaceholder":129},[98,1199,1200],{"class":100,"line":264},[98,1201,130],{"emptyLinePlaceholder":129},[98,1203,1204,1206,1209],{"class":100,"line":269},[98,1205,194],{"class":111},[98,1207,1208],{"class":197}," test_auto_registered_command_runs",[98,1210,969],{"class":122},[98,1212,1213,1215,1217,1220,1222,1225,1228,1230,1233,1236],{"class":100,"line":280},[98,1214,990],{"class":111},[98,1216,1151],{"class":122},[98,1218,1219],{"class":252},"\"db\"",[98,1221,417],{"class":122},[98,1223,1224],{"class":252},"\"vacuum\"",[98,1226,1227],{"class":122},"]).output ",[98,1229,1002],{"class":111},[98,1231,1232],{"class":252}," \"vacuumed",[98,1234,1235],{"class":115},"\\n",[98,1237,1238],{"class":252},"\"\n",[98,1240,1241],{"class":100,"line":303},[98,1242,130],{"emptyLinePlaceholder":129},[98,1244,1245],{"class":100,"line":308},[98,1246,130],{"emptyLinePlaceholder":129},[98,1248,1249,1251,1254],{"class":100,"line":317},[98,1250,194],{"class":111},[98,1252,1253],{"class":197}," test_no_duplicate_command_names",[98,1255,969],{"class":122},[98,1257,1258,1261],{"class":100,"line":335},[98,1259,1260],{"class":111},"    import",[98,1262,139],{"class":122},[98,1264,1265],{"class":100,"line":341},[98,1266,130],{"emptyLinePlaceholder":129},[98,1268,1269,1271,1273,1275],{"class":100,"line":346},[98,1270,974],{"class":111},[98,1272,173],{"class":122},[98,1274,136],{"class":111},[98,1276,178],{"class":122},[98,1278,1279,1282,1284],{"class":100,"line":360},[98,1280,1281],{"class":122},"    names ",[98,1283,286],{"class":111},[98,1285,728],{"class":122},[98,1287,1288,1290,1293,1295],{"class":100,"line":400},[98,1289,349],{"class":111},[98,1291,1292],{"class":122}," module_name ",[98,1294,228],{"class":111},[98,1296,357],{"class":122},[98,1298,1299,1301,1303,1305,1307,1309,1311,1313,1315,1317,1319,1322,1324,1326],{"class":100,"line":424},[98,1300,363],{"class":122},[98,1302,286],{"class":111},[98,1304,368],{"class":122},[98,1306,371],{"class":111},[98,1308,374],{"class":252},[98,1310,377],{"class":115},[98,1312,380],{"class":122},[98,1314,383],{"class":115},[98,1316,35],{"class":252},[98,1318,377],{"class":115},[98,1320,1321],{"class":122},"module_name",[98,1323,393],{"class":115},[98,1325,374],{"class":252},[98,1327,237],{"class":122},[98,1329,1330,1333,1335,1337,1339,1342,1344,1346,1348],{"class":100,"line":438},[98,1331,1332],{"class":122},"        names.append(",[98,1334,476],{"class":115},[98,1336,411],{"class":122},[98,1338,481],{"class":252},[98,1340,1341],{"class":122},", module_name.replace(",[98,1343,253],{"class":252},[98,1345,417],{"class":122},[98,1347,491],{"class":252},[98,1349,494],{"class":122},[98,1351,1352,1354,1357,1360,1362,1364,1366,1369,1372,1374,1377,1379,1381,1383],{"class":100,"line":466},[98,1353,990],{"class":111},[98,1355,1356],{"class":115}," len",[98,1358,1359],{"class":122},"(names) ",[98,1361,1002],{"class":111},[98,1363,1356],{"class":115},[98,1365,447],{"class":122},[98,1367,1368],{"class":115},"set",[98,1370,1371],{"class":122},"(names)), ",[98,1373,371],{"class":111},[98,1375,1376],{"class":252},"\"duplicate command names: ",[98,1378,377],{"class":115},[98,1380,662],{"class":122},[98,1382,393],{"class":115},[98,1384,1238],{"class":252},[10,1386,1387,1388,1390,1391,1394,1395,1398,1399,1402],{},"The duplicate-name test covers the one conflict the convention allows: two modules that set the same ",[14,1389,74],{},", or a module named ",[14,1392,1393],{},"db.py"," alongside ",[14,1396,1397],{},"db_tools.py"," with ",[14,1400,1401],{},"COMMAND_NAME = \"db\"",". Typer would let the later registration win; the test makes it an error.",[37,1404,1406],{"id":1405},"conclusion","Conclusion",[10,1408,1409,1410,1413,1414,1416,1417,1419,1420,1422],{},"Automatic registration turns \"add a command\" into \"add a file\": discover modules in a ",[14,1411,1412],{},"commands"," package with ",[14,1415,685],{},", skip private ones, require each to define ",[14,1418,697],{},", derive names from module names with an optional ",[14,1421,74],{},", and sort for stable help. Bundle the package explicitly for frozen binaries, keep command modules light or load them lazily, and test for missing conventions and duplicate names. For smaller CLIs, an explicit list plus a guard test gives the same safety with no magic.",[37,1424,1426],{"id":1425},"frequently-asked-questions","Frequently asked questions",[633,1428,1430],{"id":1429},"does-this-work-with-click-instead-of-typer","Does this work with Click instead of Typer?",[10,1432,1433,1434,1437,1438,1441,1442,1445,1446,1449,1450,1452,1453,1456,1457,1460],{},"Yes: require each module to define a ",[14,1435,1436],{},"click.Group"," (or ",[14,1439,1440],{},"click.Command",") named ",[14,1443,1444],{},"cli",", and call ",[14,1447,1448],{},"root.add_command(module.cli, name)"," in the loop. With Typer apps built on vendored Click, check for the Typer object rather than ",[14,1451,1436],{},", since ",[14,1454,1455],{},"isinstance"," checks against the ",[14,1458,1459],{},"click"," package fail for Typer objects.",[633,1462,1464],{"id":1463},"can-command-modules-live-in-several-packages","Can command modules live in several packages?",[10,1466,1467,1469,1470,1474],{},[14,1468,685],{}," accepts several paths, and namespace packages let different distributions contribute modules to the same package. At that point you are building a plugin system, and entry points — as in ",[31,1471,1473],{"href":1472},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points\u002F","discovering plugins with entry points"," — are the more explicit mechanism.",[633,1476,1478],{"id":1477},"how-do-i-keep-shared-options-consistent-across-auto-registered-groups","How do I keep shared options consistent across auto-registered groups?",[10,1480,1481,1482,35],{},"Put shared option definitions in a helper module (with a leading underscore so it is not registered) and import them in each command module, as shown in ",[31,1483,1485],{"href":1484},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands\u002F","sharing common options across commands",[633,1487,1489],{"id":1488},"will-my-ide-still-find-where-a-command-is-defined","Will my IDE still find where a command is defined?",[10,1491,1492,1493,1496],{},"Yes for the command itself — it is an ordinary function in an ordinary module. What becomes less visible is ",[660,1494,1495],{},"registration",", which is why the convention must be documented and short.",[37,1498,1500],{"id":1499},"related","Related",[42,1502,1503,1509,1514,1520,1525],{},[45,1504,1505,1506],{},"Up: ",[31,1507,1508],{"href":33},"Structuring multi-command Python CLIs",[45,1510,1511],{},[31,1512,1513],{"href":50},"How to structure a large Python CLI project",[45,1515,1516],{},[31,1517,1519],{"href":1518},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Foffering-a-python-api-alongside-your-cli\u002F","Offering a Python API alongside your CLI",[45,1521,1522],{},[31,1523,1524],{"href":666},"Lazy-loading subcommands for faster startup",[45,1526,1527],{},[31,1528,1530],{"href":1529},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click\u002F","Building dynamic commands in Click",[1532,1533,1534],"style",{},"html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}html pre.shiki code .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}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":83,"searchDepth":108,"depth":108,"links":1536},[1537,1538,1539,1544,1545,1546,1547,1548,1549,1555],{"id":39,"depth":108,"text":40},{"id":55,"depth":108,"text":56},{"id":88,"depth":108,"text":89,"children":1540},[1541,1542,1543],{"id":635,"depth":126,"text":636},{"id":654,"depth":126,"text":655},{"id":671,"depth":126,"text":672},{"id":852,"depth":108,"text":853},{"id":916,"depth":108,"text":917},{"id":1014,"depth":108,"text":1015},{"id":1055,"depth":108,"text":1056},{"id":1405,"depth":108,"text":1406},{"id":1425,"depth":108,"text":1426,"children":1550},[1551,1552,1553,1554],{"id":1429,"depth":126,"text":1430},{"id":1463,"depth":126,"text":1464},{"id":1477,"depth":126,"text":1478},{"id":1488,"depth":126,"text":1489},{"id":1499,"depth":108,"text":1500},"2026-10-02","Discover command modules in a package with pkgutil and mount them as Typer groups automatically, with naming rules, ordering, frozen-binary caveats and a test that nothing is missed.","intermediate",false,"md",{},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically",{"title":5,"description":1557},"modern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically\u002Findex",[1566,1567,28,1412,1568],"architecture","typer","structure","FTPA4r4yrbaKwIOAZetgJeN5zQvIrUA9T3C0dcRlOUo",[1571,1574,1577,1580,1583,1586,1589,1592,1595,1598,1601,1604,1607,1610,1613,1616,1619,1622,1625,1628,1631,1634,1637,1640,1643,1646,1649,1652,1655,1658,1661,1664,1667,1670,1673,1676,1679,1682,1685,1688,1691,1694,1697,1700,1703,1706,1709,1712,1715,1718,1721,1724,1727,1730,1733,1736,1739,1742,1745,1748,1751,1754,1757,1760,1763,1766,1769,1772,1775,1778,1781,1784,1787,1790,1793,1796,1799,1802,1805,1808,1811,1814,1817,1820,1823,1826,1829,1832,1835,1838,1841,1844,1847,1850,1853,1856,1859,1862,1865,1868,1871,1874,1877,1880,1883,1886,1889,1892,1895,1898,1901,1904,1907,1910,1913,1916,1919,1922,1925,1928,1931,1934,1937,1940,1943,1946,1949,1952,1955,1958,1961,1964,1967,1970,1973,1976,1979,1982,1985,1988,1991,1994,1997,2000,2003,2006,2009,2012,2015,2018,2021,2024,2027,2030,2033,2036,2039,2042,2045,2048,2051,2054,2057,2060,2063,2066,2069,2072,2075,2078,2081,2084,2087,2090,2093,2096,2099,2102,2105,2108,2111,2112,2115,2118,2121,2124,2127,2130,2133,2136,2139,2142,2145,2148,2151,2154,2157,2160,2163,2166,2169,2172,2175,2178,2181,2184,2187,2190,2193,2196,2199,2202,2205,2208,2211,2214,2217,2220,2223,2226,2229,2232,2235,2238,2241,2244,2247,2250,2253,2256,2259,2262,2265,2268,2271,2274,2277,2280,2283,2286,2289,2292,2295,2298,2301,2304,2307,2310,2313,2316,2319,2322,2325,2328,2331,2334,2337,2340,2343,2346,2349,2352,2355,2358,2361,2364,2367,2370,2373,2376,2379,2382,2385,2388,2391,2394,2397,2400,2403,2406,2409,2412],{"path":1572,"title":1573},"\u002Fabout","About Python CLI Toolcraft",{"path":1575,"title":1576},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1578,"title":1579},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1581,"title":1582},"\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":1584,"title":1585},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1587,"title":1588},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1590,"title":1591},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1593,"title":1594},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1596,"title":1597},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1599,"title":1600},"\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":1602,"title":1603},"\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":1605,"title":1606},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1608,"title":1609},"\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":1611,"title":1612},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1614,"title":1615},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1617,"title":1618},"\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":1620,"title":1621},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1623,"title":1624},"\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":1626,"title":1627},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1629,"title":1630},"\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":1632,"title":1633},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1635,"title":1636},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1638,"title":1639},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1641,"title":1642},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1644,"title":1645},"\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":1647,"title":1648},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1650,"title":1651},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1653,"title":1654},"\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":1656,"title":1657},"\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":1659,"title":1660},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1662,"title":1663},"\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":1665,"title":1666},"\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":1668,"title":1669},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1671,"title":1672},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1674,"title":1675},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1677,"title":1678},"\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":1680,"title":1681},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1683,"title":1684},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1686,"title":1687},"\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":1689,"title":1690},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1692,"title":1693},"\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":1695,"title":1696},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1698,"title":1699},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1701,"title":1702},"\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":1704,"title":1705},"\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":1707,"title":1708},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1710,"title":1711},"\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":1713,"title":1714},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1716,"title":1717},"\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":1719,"title":1720},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1722,"title":1723},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1725,"title":1726},"\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":1728,"title":1729},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1731,"title":1732},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1734,"title":1735},"\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":1737,"title":1738},"\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":1740,"title":1741},"\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":1743,"title":1744},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1746,"title":1747},"\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":1749,"title":1750},"\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":1752,"title":1753},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1755,"title":1756},"\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":1758,"title":1759},"\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":1761,"title":1762},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1764,"title":1765},"\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":1767,"title":1768},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1770,"title":1771},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1773,"title":1774},"\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":1776,"title":1777},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1779,"title":1780},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1782,"title":1783},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1785,"title":1786},"\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":1788,"title":1789},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1791,"title":1792},"\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":1794,"title":1795},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1797,"title":1798},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1800,"title":1801},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1803,"title":1804},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1806,"title":1807},"\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":1809,"title":1810},"\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":1812,"title":1813},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1815,"title":1816},"\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":1818,"title":1819},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1821,"title":1822},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1824,"title":1825},"\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":1827,"title":1828},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1830,"title":1831},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1833,"title":1834},"\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":1836,"title":1837},"\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":1839,"title":1840},"\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":1842,"title":1843},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1845,"title":1846},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1848,"title":1849},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1851,"title":1852},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1854,"title":1855},"\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":1857,"title":1858},"\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":1860,"title":1861},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1863,"title":1864},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1866,"title":1867},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1869,"title":1870},"\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":1872,"title":1873},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1875,"title":1876},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1878,"title":1879},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1881,"title":1882},"\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":1884,"title":1885},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1887,"title":1888},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1890,"title":1891},"\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":1893,"title":1894},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":1896,"title":1897},"\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":1899,"title":1900},"\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":1902,"title":1903},"\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":1905,"title":1906},"\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":1908,"title":1909},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1911,"title":1912},"\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":1914,"title":1915},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1917,"title":1918},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":1920,"title":1921},"\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":1923,"title":1924},"\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":1926,"title":1927},"\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":1929,"title":1930},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1932,"title":1933},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1935,"title":1936},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1938,"title":1939},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1941,"title":1942},"\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":1944,"title":1945},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":1947,"title":1948},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":1950,"title":1951},"\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":1953,"title":1954},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":1956,"title":1957},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":1959,"title":1960},"\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":1962,"title":1963},"\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":1965,"title":1966},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":1968,"title":1969},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":1971,"title":1972},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1974,"title":1975},"\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":1977,"title":1978},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":1980,"title":1981},"\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":1983,"title":1984},"\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":1986,"title":1987},"\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":1989,"title":1990},"\u002F","Python CLI Toolcraft",{"path":1992,"title":1993},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":1995,"title":1996},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":1998,"title":1999},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2001,"title":2002},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2004,"title":2005},"\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":2007,"title":2008},"\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":2010,"title":2011},"\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":2013,"title":2014},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2016,"title":2017},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2019,"title":2020},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2022,"title":2023},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2025,"title":2026},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2028,"title":2029},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2031,"title":2032},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2034,"title":2035},"\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":2037,"title":2038},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2040,"title":2041},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2043,"title":2044},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2046,"title":2047},"\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":2049,"title":2050},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":2052,"title":2053},"\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":2055,"title":2056},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":2058,"title":2059},"\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":2061,"title":2062},"\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":2064,"title":2065},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":2067,"title":2068},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":2070,"title":2071},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":2073,"title":2074},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":2076,"title":2077},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":2079,"title":2080},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":2082,"title":2083},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":2085,"title":2086},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":2088,"title":2089},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":2091,"title":2092},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":2094,"title":2095},"\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":2097,"title":2098},"\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":2100,"title":2101},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":2103,"title":2104},"\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":2106,"title":2107},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":2109,"title":2110},"\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":1562,"title":5},{"path":2113,"title":2114},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":2116,"title":2117},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":2119,"title":2120},"\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":2122,"title":2123},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":2125,"title":2126},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":2128,"title":2129},"\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":2131,"title":2132},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":2134,"title":2135},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":2137,"title":2138},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":2140,"title":2141},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":2143,"title":2144},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":2146,"title":2147},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":2149,"title":2150},"\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":2152,"title":2153},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":2155,"title":2156},"\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":2158,"title":2159},"\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":2161,"title":2162},"\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":2164,"title":2165},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":2167,"title":2168},"\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":2170,"title":2171},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":2173,"title":2174},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":2176,"title":2177},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":2179,"title":2180},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":2182,"title":2183},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":2185,"title":2186},"\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":2188,"title":2189},"\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":2191,"title":2192},"\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":2194,"title":2195},"\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":2197,"title":2198},"\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":2200,"title":2201},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":2203,"title":2204},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":2206,"title":2207},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":2209,"title":2210},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":2212,"title":2213},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":2215,"title":2216},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":2218,"title":2219},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":2221,"title":2222},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":2224,"title":2225},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":2227,"title":2228},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":2230,"title":2231},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":2233,"title":2234},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":2236,"title":2237},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":2239,"title":2240},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":2242,"title":2243},"\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":2245,"title":2246},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":2248,"title":2249},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":2251,"title":2252},"\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":2254,"title":2255},"\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":2257,"title":2258},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":2260,"title":2261},"\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":2263,"title":2264},"\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":2266,"title":2267},"\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":2269,"title":2270},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":2272,"title":2273},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":2275,"title":2276},"\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":2278,"title":2279},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":2281,"title":2282},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":2284,"title":2285},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":2287,"title":2288},"\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":2290,"title":2291},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":2293,"title":2294},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":2296,"title":2297},"\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":2299,"title":2300},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":2302,"title":2303},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":2305,"title":2306},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":2308,"title":2309},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":2311,"title":2312},"\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":2314,"title":2315},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":2317,"title":2318},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":2320,"title":2321},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":2323,"title":2324},"\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":2326,"title":2327},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":2329,"title":2330},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":2332,"title":2333},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":2335,"title":2336},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2338,"title":2339},"\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":2341,"title":2342},"\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":2344,"title":2345},"\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":2347,"title":2348},"\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":2350,"title":2351},"\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":2353,"title":2354},"\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":2356,"title":2357},"\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":2359,"title":2360},"\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":2362,"title":2363},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2365,"title":2366},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2368,"title":2369},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2371,"title":2372},"\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":2374,"title":2375},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2377,"title":2378},"\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":2380,"title":2381},"\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":2383,"title":2384},"\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":2386,"title":2387},"\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":2389,"title":2390},"\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":2392,"title":2393},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2395,"title":2396},"\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":2398,"title":2399},"\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":2401,"title":2402},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2404,"title":2405},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2407,"title":2408},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2410,"title":2411},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2413,"title":2414},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967541551]