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