[{"data":1,"prerenderedAt":2074},["ShallowReactive",2],{"page-\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668\u002F":3,"content-directory":1231},{"id":4,"title":5,"body":6,"date":1216,"description":1217,"difficulty":1218,"draft":1219,"extension":1220,"meta":1221,"navigation":310,"path":1222,"seo":1223,"stem":1224,"tags":1225,"updated":1216,"__hash__":1230},"content\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668\u002Findex.md","PEP 668 and Python CLIs: the externally-managed-environment Error",{"type":7,"value":8,"toc":1191},"minimark",[9,18,28,42,47,61,65,79,119,123,137,152,156,163,210,227,254,257,266,279,283,287,294,328,334,338,345,669,684,688,725,728,732,735,1065,1079,1083,1093,1097,1104,1111,1115,1123,1127,1130,1137,1140,1144,1154,1158,1187],[10,11,12,13,17],"p",{},"Run ",[14,15,16],"code",{},"pip install mytool"," with the system Python on a recent Debian or Ubuntu release, or with Homebrew's Python on macOS, and you meet this:",[19,20,26],"pre",{"className":21,"code":23,"language":24,"meta":25},[22],"language-text","error: externally-managed-environment\n\n× This environment is externally managed\n╰─> To install Python packages system-wide, try apt install\n    python3-xyz, where xyz is the package you are trying to\n    install.\n\n    If you wish to install a non-Debian-packaged Python package,\n    create a virtual environment using python3 -m venv path\u002Fto\u002Fvenv.\n","text","",[14,27,23],{"__ignoreMap":25},[10,29,30,31,35,36,41],{},"It is not a bug and not a permissions problem. It is PEP 668 working as designed: the operating system declares that its Python belongs to the package manager, and pip refuses to install into it. For people installing CLIs, the fix is to use the tools built for that job. For people ",[32,33,34],"em",{},"writing"," CLIs, PEP 668 changes what your installation instructions should say, and it affects any feature that installs packages at runtime, such as plugin installers. This guide explains the mechanism and covers both sides. It belongs to the ",[37,38,40],"a",{"href":39},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002F","virtual environments topic",".",[43,44,46],"h2",{"id":45},"prerequisites","Prerequisites",[48,49,50,58],"ul",{},[51,52,53,54,57],"li",{},"A Linux distribution or macOS Python that ships an ",[14,55,56],{},"EXTERNALLY-MANAGED"," marker (most current ones do).",[51,59,60],{},"pipx or uv for the recommended installation paths.",[43,62,64],{"id":63},"how-the-marker-works","How the marker works",[10,66,67,68,70,71,74,75,78],{},"PEP 668 defines a file named ",[14,69,56],{}," in the interpreter's standard library directory. When pip (version 23 and later) sees it, it refuses to install into that interpreter's site-packages and prints the message the file contains — which is why the advice mentions ",[14,72,73],{},"apt"," on Debian and ",[14,76,77],{},"brew"," on Homebrew.",[19,80,84],{"className":81,"code":82,"language":83,"meta":25,"style":25},"language-bash shiki shiki-themes github-light github-dark","python3 -c \"import sysconfig; print(sysconfig.get_path('stdlib'))\"\n# \u002Fusr\u002Flib\u002Fpython3.14\nls \u002Fusr\u002Flib\u002Fpython3.14\u002FEXTERNALLY-MANAGED\n","bash",[14,85,86,103,110],{"__ignoreMap":25},[87,88,91,95,99],"span",{"class":89,"line":90},"line",1,[87,92,94],{"class":93},"sScJk","python3",[87,96,98],{"class":97},"sj4cs"," -c",[87,100,102],{"class":101},"sZZnC"," \"import sysconfig; print(sysconfig.get_path('stdlib'))\"\n",[87,104,106],{"class":89,"line":105},2,[87,107,109],{"class":108},"sJ8bj","# \u002Fusr\u002Flib\u002Fpython3.14\n",[87,111,113,116],{"class":89,"line":112},3,[87,114,115],{"class":93},"ls",[87,117,118],{"class":101}," \u002Fusr\u002Flib\u002Fpython3.14\u002FEXTERNALLY-MANAGED\n",[120,121],"inline-diagram",{"name":122},"pep668-mechanism",[10,124,125,126,128,129,132,133,136],{},"The reason is practical. On these systems, the package manager installs Python packages that system tools depend on — ",[14,127,73],{}," itself on some distributions, desktop utilities, the distribution's own scripts. A ",[14,130,131],{},"sudo pip install --upgrade"," that replaces one of those packages with an incompatible version can break the operating system in ways that are hard to diagnose. Even ",[14,134,135],{},"pip install --user",", which writes to your home directory, shadows system packages for every program that user runs. The marker turns those silent breakages into an explicit error.",[10,138,139,140,143,144,147,148,151],{},"Crucially, the marker only applies to the ",[32,141,142],{},"system"," interpreter. Inside a virtual environment, ",[14,145,146],{},"sys.prefix"," differs from ",[14,149,150],{},"sys.base_prefix",", and pip installs freely — which is the whole point of the recommended fixes.",[43,153,155],{"id":154},"the-recipe-installing-a-cli","The recipe: installing a CLI",[10,157,158,159,162],{},"For a command-line tool you want on your ",[14,160,161],{},"PATH",", use an installer that creates an isolated environment per tool:",[19,164,166],{"className":81,"code":165,"language":83,"meta":25,"style":25},"pipx install mytool              # one venv per tool, executables linked onto PATH\nuv tool install mytool           # the same idea, faster\nuvx mytool --help                # run without installing, from a cached environment\n",[14,167,168,182,197],{"__ignoreMap":25},[87,169,170,173,176,179],{"class":89,"line":90},[87,171,172],{"class":93},"pipx",[87,174,175],{"class":101}," install",[87,177,178],{"class":101}," mytool",[87,180,181],{"class":108},"              # one venv per tool, executables linked onto PATH\n",[87,183,184,187,190,192,194],{"class":89,"line":105},[87,185,186],{"class":93},"uv",[87,188,189],{"class":101}," tool",[87,191,175],{"class":101},[87,193,178],{"class":101},[87,195,196],{"class":108},"           # the same idea, faster\n",[87,198,199,202,204,207],{"class":89,"line":112},[87,200,201],{"class":93},"uvx",[87,203,178],{"class":101},[87,205,206],{"class":97}," --help",[87,208,209],{"class":108},"                # run without installing, from a cached environment\n",[10,211,212,213,217,218,222,223,226],{},"Both pipx and uv install the tool into its own virtual environment, so the marker does not apply, the tool's dependencies cannot conflict with system packages or with other tools, and uninstalling removes everything. ",[37,214,216],{"href":215},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx\u002F","Installing and distributing CLIs with pipx"," and ",[37,219,221],{"href":220},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-tool-install-vs-pipx-for-clis\u002F","uv tool install vs pipx"," cover the details. On a fresh Debian or Ubuntu system, ",[14,224,225],{},"sudo apt install pipx"," installs pipx itself through the package manager — the one Python tool that legitimately comes from the system.",[10,228,229,230,233,234,237,238,241,242,245,246,249,250,253],{},"For working ",[32,231,232],{},"on"," a project, create a project environment: ",[14,235,236],{},"uv sync",", or ",[14,239,240],{},"python3 -m venv .venv && .venv\u002Fbin\u002Fpip install -e .",". Debian-based systems may need ",[14,243,244],{},"python3-venv"," (or ",[14,247,248],{},"python3-full",") installed for ",[14,251,252],{},"python3 -m venv"," to work.",[120,255],{"name":256},"pep668-choices",[258,259,261,262,265],"h3",{"id":260},"what-about-break-system-packages","What about ",[14,263,264],{},"--break-system-packages","?",[10,267,268,269,245,271,274,275,278],{},"pip offers an override, ",[14,270,264],{},[14,272,273],{},"PIP_BREAK_SYSTEM_PACKAGES=1","). The name is honest. It is appropriate in exactly one kind of place: a disposable environment where the system Python serves no other purpose, such as a single-purpose container built from a distribution image. Official ",[14,276,277],{},"python:"," Docker images do not ship the marker at all, because their Python is not managed by a system package manager. On a workstation or server, the override trades a clear error now for a mysterious failure later.",[43,280,282],{"id":281},"what-cli-authors-should-change","What CLI authors should change",[258,284,286],{"id":285},"installation-instructions","Installation instructions",[10,288,289,290,293],{},"Lead with the isolated installers and drop bare ",[14,291,292],{},"pip install"," from the first line of your README:",[19,295,299],{"className":296,"code":297,"language":298,"meta":25,"style":25},"language-markdown shiki shiki-themes github-light github-dark","## Install\n\n    pipx install mytool        # or: uv tool install mytool\n\nTry it without installing: `uvx mytool --help`.\n","markdown",[14,300,301,306,312,317,322],{"__ignoreMap":25},[87,302,303],{"class":89,"line":90},[87,304,305],{},"## Install\n",[87,307,308],{"class":89,"line":105},[87,309,311],{"emptyLinePlaceholder":310},true,"\n",[87,313,314],{"class":89,"line":112},[87,315,316],{},"    pipx install mytool        # or: uv tool install mytool\n",[87,318,320],{"class":89,"line":319},4,[87,321,311],{"emptyLinePlaceholder":310},[87,323,325],{"class":89,"line":324},5,[87,326,327],{},"Try it without installing: `uvx mytool --help`.\n",[10,329,330,331,333],{},"Mention ",[14,332,16],{}," only in the context of an existing virtual environment (\"to use mytool as a library in your project…\"). Users who copy the first command they see should get a command that works on every modern system.",[258,335,337],{"id":336},"runtime-package-installation","Runtime package installation",[10,339,340,341,344],{},"Some CLIs install packages themselves — a ",[14,342,343],{},"mytool plugin install NAME"," command, an \"install the optional dependency now?\" prompt. Under PEP 668 those features break if the CLI runs from a system interpreter, and they are risky even in a tool environment managed by pipx or uv, where installing behind the manager's back confuses its records. Detect the situation and delegate:",[19,346,350],{"className":347,"code":348,"language":349,"meta":25,"style":25},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fplugins.py\nfrom __future__ import annotations\n\nimport sys\nimport sysconfig\nfrom pathlib import Path\n\n\ndef externally_managed() -> bool:\n    \"\"\"True if pip would refuse to install into this interpreter (PEP 668).\"\"\"\n    in_venv = sys.prefix != sys.base_prefix\n    marker = Path(sysconfig.get_path(\"stdlib\")) \u002F \"EXTERNALLY-MANAGED\"\n    return not in_venv and marker.exists()\n\n\ndef install_hint(package: str) -> str:\n    prefix = Path(sys.prefix)\n    if (prefix \u002F \"pipx_metadata.json\").exists():\n        return f\"pipx inject mytool {package}\"\n    if (prefix \u002F \"uv-receipt.toml\").exists():\n        return f\"uv tool install mytool --with {package} --force\"\n    if externally_managed():\n        return f\"install mytool with pipx or uv tool, then add {package} the same way\"\n    return f\"{sys.executable} -m pip install {package}\"\n","python",[14,351,352,357,373,377,385,392,405,410,415,433,439,457,480,498,503,508,529,540,557,581,595,614,622,641],{"__ignoreMap":25},[87,353,354],{"class":89,"line":90},[87,355,356],{"class":108},"# src\u002Fmytool\u002Fplugins.py\n",[87,358,359,363,366,369],{"class":89,"line":105},[87,360,362],{"class":361},"szBVR","from",[87,364,365],{"class":97}," __future__",[87,367,368],{"class":361}," import",[87,370,372],{"class":371},"sVt8B"," annotations\n",[87,374,375],{"class":89,"line":112},[87,376,311],{"emptyLinePlaceholder":310},[87,378,379,382],{"class":89,"line":319},[87,380,381],{"class":361},"import",[87,383,384],{"class":371}," sys\n",[87,386,387,389],{"class":89,"line":324},[87,388,381],{"class":361},[87,390,391],{"class":371}," sysconfig\n",[87,393,395,397,400,402],{"class":89,"line":394},6,[87,396,362],{"class":361},[87,398,399],{"class":371}," pathlib ",[87,401,381],{"class":361},[87,403,404],{"class":371}," Path\n",[87,406,408],{"class":89,"line":407},7,[87,409,311],{"emptyLinePlaceholder":310},[87,411,413],{"class":89,"line":412},8,[87,414,311],{"emptyLinePlaceholder":310},[87,416,418,421,424,427,430],{"class":89,"line":417},9,[87,419,420],{"class":361},"def",[87,422,423],{"class":93}," externally_managed",[87,425,426],{"class":371},"() -> ",[87,428,429],{"class":97},"bool",[87,431,432],{"class":371},":\n",[87,434,436],{"class":89,"line":435},10,[87,437,438],{"class":101},"    \"\"\"True if pip would refuse to install into this interpreter (PEP 668).\"\"\"\n",[87,440,442,445,448,451,454],{"class":89,"line":441},11,[87,443,444],{"class":371},"    in_venv ",[87,446,447],{"class":361},"=",[87,449,450],{"class":371}," sys.prefix ",[87,452,453],{"class":361},"!=",[87,455,456],{"class":371}," sys.base_prefix\n",[87,458,460,463,465,468,471,474,477],{"class":89,"line":459},12,[87,461,462],{"class":371},"    marker ",[87,464,447],{"class":361},[87,466,467],{"class":371}," Path(sysconfig.get_path(",[87,469,470],{"class":101},"\"stdlib\"",[87,472,473],{"class":371},")) ",[87,475,476],{"class":361},"\u002F",[87,478,479],{"class":101}," \"EXTERNALLY-MANAGED\"\n",[87,481,483,486,489,492,495],{"class":89,"line":482},13,[87,484,485],{"class":361},"    return",[87,487,488],{"class":361}," not",[87,490,491],{"class":371}," in_venv ",[87,493,494],{"class":361},"and",[87,496,497],{"class":371}," marker.exists()\n",[87,499,501],{"class":89,"line":500},14,[87,502,311],{"emptyLinePlaceholder":310},[87,504,506],{"class":89,"line":505},15,[87,507,311],{"emptyLinePlaceholder":310},[87,509,511,513,516,519,522,525,527],{"class":89,"line":510},16,[87,512,420],{"class":361},[87,514,515],{"class":93}," install_hint",[87,517,518],{"class":371},"(package: ",[87,520,521],{"class":97},"str",[87,523,524],{"class":371},") -> ",[87,526,521],{"class":97},[87,528,432],{"class":371},[87,530,532,535,537],{"class":89,"line":531},17,[87,533,534],{"class":371},"    prefix ",[87,536,447],{"class":361},[87,538,539],{"class":371}," Path(sys.prefix)\n",[87,541,543,546,549,551,554],{"class":89,"line":542},18,[87,544,545],{"class":361},"    if",[87,547,548],{"class":371}," (prefix ",[87,550,476],{"class":361},[87,552,553],{"class":101}," \"pipx_metadata.json\"",[87,555,556],{"class":371},").exists():\n",[87,558,560,563,566,569,572,575,578],{"class":89,"line":559},19,[87,561,562],{"class":361},"        return",[87,564,565],{"class":361}," f",[87,567,568],{"class":101},"\"pipx inject mytool ",[87,570,571],{"class":97},"{",[87,573,574],{"class":371},"package",[87,576,577],{"class":97},"}",[87,579,580],{"class":101},"\"\n",[87,582,584,586,588,590,593],{"class":89,"line":583},20,[87,585,545],{"class":361},[87,587,548],{"class":371},[87,589,476],{"class":361},[87,591,592],{"class":101}," \"uv-receipt.toml\"",[87,594,556],{"class":371},[87,596,598,600,602,605,607,609,611],{"class":89,"line":597},21,[87,599,562],{"class":361},[87,601,565],{"class":361},[87,603,604],{"class":101},"\"uv tool install mytool --with ",[87,606,571],{"class":97},[87,608,574],{"class":371},[87,610,577],{"class":97},[87,612,613],{"class":101}," --force\"\n",[87,615,617,619],{"class":89,"line":616},22,[87,618,545],{"class":361},[87,620,621],{"class":371}," externally_managed():\n",[87,623,625,627,629,632,634,636,638],{"class":89,"line":624},23,[87,626,562],{"class":361},[87,628,565],{"class":361},[87,630,631],{"class":101},"\"install mytool with pipx or uv tool, then add ",[87,633,571],{"class":97},[87,635,574],{"class":371},[87,637,577],{"class":97},[87,639,640],{"class":101}," the same way\"\n",[87,642,644,646,648,651,653,656,658,661,663,665,667],{"class":89,"line":643},24,[87,645,485],{"class":361},[87,647,565],{"class":361},[87,649,650],{"class":101},"\"",[87,652,571],{"class":97},[87,654,655],{"class":371},"sys.executable",[87,657,577],{"class":97},[87,659,660],{"class":101}," -m pip install ",[87,662,571],{"class":97},[87,664,574],{"class":371},[87,666,577],{"class":97},[87,668,580],{"class":101},[10,670,671,672,217,675,678,679,683],{},"The installer fingerprints — ",[14,673,674],{},"pipx_metadata.json",[14,676,677],{},"uv-receipt.toml"," — are the same ones used in ",[37,680,682],{"href":681},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fself-upgrading-a-cli-installed-with-pipx-or-uv\u002F","self-upgrading a CLI installed with pipx or uv",". Printing the right command is almost always better than running pip yourself.",[43,685,687],{"id":686},"ux-considerations","UX considerations",[48,689,690,700,706,716],{},[51,691,692,699],{},[693,694,695,696,41],"strong",{},"Never suggest ",[14,697,698],{},"sudo pip"," It is the command PEP 668 exists to stop, and it still appears in old READMEs and Stack Overflow answers users will find.",[51,701,702,705],{},[693,703,704],{},"Explain the error in your docs."," A short \"Seeing externally-managed-environment?\" entry in your troubleshooting section saves many issue reports.",[51,707,708,711,712,715],{},[693,709,710],{},"Test the install path you document."," A CI job that runs ",[14,713,714],{},"pipx install"," of the built wheel on a distribution image with the marker catches instructions that only work on your laptop.",[51,717,718,721,722,724],{},[693,719,720],{},"Do not detect and bypass."," Silently adding ",[14,723,264],{}," in a plugin installer turns your tool into the cause of someone's broken system.",[120,726],{"name":727},"pep668-terminal",[43,729,731],{"id":730},"testing-the-behaviour","Testing the behaviour",[10,733,734],{},"The detection logic is easy to test by faking the interpreter layout:",[19,736,738],{"className":347,"code":737,"language":349,"meta":25,"style":25},"# tests\u002Ftest_plugins.py\nimport sys\n\nfrom mytool import plugins\n\n\ndef test_venv_is_never_externally_managed(monkeypatch, tmp_path):\n    monkeypatch.setattr(sys, \"prefix\", str(tmp_path \u002F \"venv\"))\n    monkeypatch.setattr(sys, \"base_prefix\", str(tmp_path \u002F \"base\"))\n    assert plugins.externally_managed() is False\n\n\ndef test_marker_on_system_python(monkeypatch, tmp_path):\n    stdlib = tmp_path \u002F \"lib\" \u002F \"python3.13\"\n    stdlib.mkdir(parents=True)\n    (stdlib \u002F \"EXTERNALLY-MANAGED\").write_text(\"[externally-managed]\\n\")\n    monkeypatch.setattr(sys, \"prefix\", str(tmp_path))\n    monkeypatch.setattr(sys, \"base_prefix\", str(tmp_path))\n    monkeypatch.setattr(plugins.sysconfig, \"get_path\", lambda name: str(stdlib))\n    assert plugins.externally_managed() is True\n    assert \"pipx or uv tool\" in plugins.install_hint(\"mytool-aws\")\n\n\ndef test_pipx_environment_gets_inject_hint(monkeypatch, tmp_path):\n    (tmp_path \u002F \"pipx_metadata.json\").write_text(\"{}\")\n    monkeypatch.setattr(sys, \"prefix\", str(tmp_path))\n    assert plugins.install_hint(\"mytool-aws\") == \"pipx inject mytool mytool-aws\"\n",[14,739,740,745,751,755,767,771,775,785,809,829,843,847,851,860,881,898,921,934,946,967,978,996,1000,1004,1013,1034,1047],{"__ignoreMap":25},[87,741,742],{"class":89,"line":90},[87,743,744],{"class":108},"# tests\u002Ftest_plugins.py\n",[87,746,747,749],{"class":89,"line":105},[87,748,381],{"class":361},[87,750,384],{"class":371},[87,752,753],{"class":89,"line":112},[87,754,311],{"emptyLinePlaceholder":310},[87,756,757,759,762,764],{"class":89,"line":319},[87,758,362],{"class":361},[87,760,761],{"class":371}," mytool ",[87,763,381],{"class":361},[87,765,766],{"class":371}," plugins\n",[87,768,769],{"class":89,"line":324},[87,770,311],{"emptyLinePlaceholder":310},[87,772,773],{"class":89,"line":394},[87,774,311],{"emptyLinePlaceholder":310},[87,776,777,779,782],{"class":89,"line":407},[87,778,420],{"class":361},[87,780,781],{"class":93}," test_venv_is_never_externally_managed",[87,783,784],{"class":371},"(monkeypatch, tmp_path):\n",[87,786,787,790,793,796,798,801,803,806],{"class":89,"line":412},[87,788,789],{"class":371},"    monkeypatch.setattr(sys, ",[87,791,792],{"class":101},"\"prefix\"",[87,794,795],{"class":371},", ",[87,797,521],{"class":97},[87,799,800],{"class":371},"(tmp_path ",[87,802,476],{"class":361},[87,804,805],{"class":101}," \"venv\"",[87,807,808],{"class":371},"))\n",[87,810,811,813,816,818,820,822,824,827],{"class":89,"line":417},[87,812,789],{"class":371},[87,814,815],{"class":101},"\"base_prefix\"",[87,817,795],{"class":371},[87,819,521],{"class":97},[87,821,800],{"class":371},[87,823,476],{"class":361},[87,825,826],{"class":101}," \"base\"",[87,828,808],{"class":371},[87,830,831,834,837,840],{"class":89,"line":435},[87,832,833],{"class":361},"    assert",[87,835,836],{"class":371}," plugins.externally_managed() ",[87,838,839],{"class":361},"is",[87,841,842],{"class":97}," False\n",[87,844,845],{"class":89,"line":441},[87,846,311],{"emptyLinePlaceholder":310},[87,848,849],{"class":89,"line":459},[87,850,311],{"emptyLinePlaceholder":310},[87,852,853,855,858],{"class":89,"line":482},[87,854,420],{"class":361},[87,856,857],{"class":93}," test_marker_on_system_python",[87,859,784],{"class":371},[87,861,862,865,867,870,872,875,878],{"class":89,"line":500},[87,863,864],{"class":371},"    stdlib ",[87,866,447],{"class":361},[87,868,869],{"class":371}," tmp_path ",[87,871,476],{"class":361},[87,873,874],{"class":101}," \"lib\"",[87,876,877],{"class":361}," \u002F",[87,879,880],{"class":101}," \"python3.13\"\n",[87,882,883,886,890,892,895],{"class":89,"line":505},[87,884,885],{"class":371},"    stdlib.mkdir(",[87,887,889],{"class":888},"s4XuR","parents",[87,891,447],{"class":361},[87,893,894],{"class":97},"True",[87,896,897],{"class":371},")\n",[87,899,900,903,905,908,911,914,917,919],{"class":89,"line":510},[87,901,902],{"class":371},"    (stdlib ",[87,904,476],{"class":361},[87,906,907],{"class":101}," \"EXTERNALLY-MANAGED\"",[87,909,910],{"class":371},").write_text(",[87,912,913],{"class":101},"\"[externally-managed]",[87,915,916],{"class":97},"\\n",[87,918,650],{"class":101},[87,920,897],{"class":371},[87,922,923,925,927,929,931],{"class":89,"line":531},[87,924,789],{"class":371},[87,926,792],{"class":101},[87,928,795],{"class":371},[87,930,521],{"class":97},[87,932,933],{"class":371},"(tmp_path))\n",[87,935,936,938,940,942,944],{"class":89,"line":542},[87,937,789],{"class":371},[87,939,815],{"class":101},[87,941,795],{"class":371},[87,943,521],{"class":97},[87,945,933],{"class":371},[87,947,948,951,954,956,959,962,964],{"class":89,"line":559},[87,949,950],{"class":371},"    monkeypatch.setattr(plugins.sysconfig, ",[87,952,953],{"class":101},"\"get_path\"",[87,955,795],{"class":371},[87,957,958],{"class":361},"lambda",[87,960,961],{"class":371}," name: ",[87,963,521],{"class":97},[87,965,966],{"class":371},"(stdlib))\n",[87,968,969,971,973,975],{"class":89,"line":583},[87,970,833],{"class":361},[87,972,836],{"class":371},[87,974,839],{"class":361},[87,976,977],{"class":97}," True\n",[87,979,980,982,985,988,991,994],{"class":89,"line":597},[87,981,833],{"class":361},[87,983,984],{"class":101}," \"pipx or uv tool\"",[87,986,987],{"class":361}," in",[87,989,990],{"class":371}," plugins.install_hint(",[87,992,993],{"class":101},"\"mytool-aws\"",[87,995,897],{"class":371},[87,997,998],{"class":89,"line":616},[87,999,311],{"emptyLinePlaceholder":310},[87,1001,1002],{"class":89,"line":624},[87,1003,311],{"emptyLinePlaceholder":310},[87,1005,1006,1008,1011],{"class":89,"line":643},[87,1007,420],{"class":361},[87,1009,1010],{"class":93}," test_pipx_environment_gets_inject_hint",[87,1012,784],{"class":371},[87,1014,1016,1019,1021,1023,1025,1027,1030,1032],{"class":89,"line":1015},25,[87,1017,1018],{"class":371},"    (tmp_path ",[87,1020,476],{"class":361},[87,1022,553],{"class":101},[87,1024,910],{"class":371},[87,1026,650],{"class":101},[87,1028,1029],{"class":97},"{}",[87,1031,650],{"class":101},[87,1033,897],{"class":371},[87,1035,1037,1039,1041,1043,1045],{"class":89,"line":1036},26,[87,1038,789],{"class":371},[87,1040,792],{"class":101},[87,1042,795],{"class":371},[87,1044,521],{"class":97},[87,1046,933],{"class":371},[87,1048,1050,1052,1054,1056,1059,1062],{"class":89,"line":1049},27,[87,1051,833],{"class":361},[87,1053,990],{"class":371},[87,1055,993],{"class":101},[87,1057,1058],{"class":371},") ",[87,1060,1061],{"class":361},"==",[87,1063,1064],{"class":101}," \"pipx inject mytool mytool-aws\"\n",[10,1066,1067,1068,1071,1072,1075,1076,1078],{},"For the end-to-end view, run your documented install commands in a ",[14,1069,1070],{},"debian:stable"," or ",[14,1073,1074],{},"ubuntu:latest"," container in CI — the system Python there carries the marker, so a README that still says ",[14,1077,16],{}," fails exactly as it would for users.",[43,1080,1082],{"id":1081},"conclusion","Conclusion",[10,1084,1085,1086,1089,1090,1092],{},"The externally-managed-environment error is the operating system protecting its own Python. Install CLIs with pipx or ",[14,1087,1088],{},"uv tool install",", develop in project virtual environments, and reserve ",[14,1091,264],{}," for disposable containers. As a CLI author, put the isolated installers first in your instructions, test them on a system that has the marker, and make any runtime installation feature detect its environment and print the right command instead of fighting PEP 668.",[43,1094,1096],{"id":1095},"frequently-asked-questions","Frequently asked questions",[258,1098,1100,1101,1103],{"id":1099},"does-pip-install-user-avoid-the-error","Does ",[14,1102,135],{}," avoid the error?",[10,1105,1106,1107,1110],{},"No — the marker blocks ",[14,1108,1109],{},"--user"," installs too, because user site-packages are imported by system tools running as that user and can still shadow system packages.",[258,1112,1114],{"id":1113},"why-does-pip-inside-my-virtual-environment-work","Why does pip inside my virtual environment work?",[10,1116,1117,1118,147,1120,1122],{},"Because a virtual environment is not externally managed: its ",[14,1119,146],{},[14,1121,150],{},", and the marker check only applies to the base interpreter. That is exactly the isolation PEP 668 asks for.",[258,1124,1126],{"id":1125},"is-conda-affected","Is conda affected?",[10,1128,1129],{},"conda environments are managed by conda and generally do not carry the marker; installing with pip inside a conda environment works but mixes two package managers. Prefer conda packages there, or keep CLIs in pipx or uv tool environments.",[258,1131,1133,1134,1136],{"id":1132},"can-i-remove-the-externally-managed-file","Can I remove the ",[14,1135,56],{}," file?",[10,1138,1139],{},"You can, and the next system upgrade will put it back — after which your environment is in an unknown state. Use an isolated environment instead.",[258,1141,1143],{"id":1142},"which-systems-ship-the-marker","Which systems ship the marker?",[10,1145,1146,1147,1149,1150,1153],{},"Debian from version 12 and Ubuntu from 23.04 mark their system Python as externally managed, as does Homebrew's Python; other distributions have adopted it as well. Interpreters installed by uv carry the marker too, so that packages go into virtual environments rather than into the shared interpreter. The official ",[14,1148,277],{}," container images and pyenv builds do not. Rather than relying on a list, check the interpreter you are using with the ",[14,1151,1152],{},"sysconfig"," command above.",[43,1155,1157],{"id":1156},"related","Related",[48,1159,1160,1166,1172,1178,1182],{},[51,1161,1162,1163],{},"Up: ",[37,1164,1165],{"href":39},"Virtual environments and isolation best practices",[51,1167,1168],{},[37,1169,1171],{"href":1170},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies\u002F","Isolating CLI tools from project dependencies",[51,1173,1174],{},[37,1175,1177],{"href":1176},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fdebugging-wrong-python-and-wrong-venv-problems\u002F","Debugging wrong-Python and wrong-venv problems",[51,1179,1180],{},[37,1181,216],{"href":215},[51,1183,1184],{},[37,1185,1186],{"href":220},"uv tool install vs pipx for CLIs",[1188,1189,1190],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sJ8bj, html code.shiki .sJ8bj{--shiki-default:#6A737D;--shiki-dark:#6A737D}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 .szBVR, html code.shiki .szBVR{--shiki-default:#D73A49;--shiki-dark:#F97583}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}",{"title":25,"searchDepth":105,"depth":105,"links":1192},[1193,1194,1195,1199,1203,1204,1205,1206,1215],{"id":45,"depth":105,"text":46},{"id":63,"depth":105,"text":64},{"id":154,"depth":105,"text":155,"children":1196},[1197],{"id":260,"depth":112,"text":1198},"What about --break-system-packages?",{"id":281,"depth":105,"text":282,"children":1200},[1201,1202],{"id":285,"depth":112,"text":286},{"id":336,"depth":112,"text":337},{"id":686,"depth":105,"text":687},{"id":730,"depth":105,"text":731},{"id":1081,"depth":105,"text":1082},{"id":1095,"depth":105,"text":1096,"children":1207},[1208,1210,1211,1212,1214],{"id":1099,"depth":112,"text":1209},"Does pip install --user avoid the error?",{"id":1113,"depth":112,"text":1114},{"id":1125,"depth":112,"text":1126},{"id":1132,"depth":112,"text":1213},"Can I remove the EXTERNALLY-MANAGED file?",{"id":1142,"depth":112,"text":1143},{"id":1156,"depth":105,"text":1157},"2026-10-02","Why pip install fails with externally-managed-environment on Debian, Ubuntu and Homebrew Python, how to install CLIs instead, and what CLI authors should change.","beginner",false,"md",{},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668",{"title":5,"description":1217},"project-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fexternally-managed-environments-and-pep-668\u002Findex",[1226,1227,1228,172,1229],"pep-668","pip","virtual-environments","installation","r57Yp6sIXQGY6B4_gr0AC8upPh-g0ykKEhh997_NBgk",[1232,1235,1238,1241,1244,1247,1250,1253,1256,1259,1262,1265,1268,1271,1274,1277,1280,1283,1286,1289,1292,1295,1298,1301,1304,1307,1310,1313,1316,1319,1322,1325,1328,1331,1334,1337,1340,1343,1346,1349,1352,1355,1358,1361,1364,1367,1370,1373,1376,1379,1382,1385,1388,1391,1394,1397,1400,1403,1406,1409,1412,1415,1418,1421,1424,1427,1430,1433,1436,1439,1442,1445,1448,1451,1454,1457,1460,1463,1466,1469,1472,1475,1478,1481,1484,1487,1490,1493,1496,1499,1502,1505,1508,1511,1514,1517,1520,1523,1526,1529,1532,1535,1538,1541,1544,1547,1550,1553,1556,1559,1562,1565,1568,1571,1574,1577,1580,1583,1586,1589,1592,1595,1598,1601,1604,1607,1610,1613,1616,1619,1622,1625,1628,1631,1634,1637,1640,1643,1646,1649,1651,1654,1657,1660,1663,1666,1669,1672,1675,1678,1681,1684,1687,1690,1693,1696,1699,1702,1705,1708,1711,1714,1717,1720,1723,1726,1729,1732,1735,1738,1741,1744,1747,1750,1753,1756,1759,1762,1765,1768,1771,1774,1777,1780,1783,1786,1789,1792,1795,1798,1801,1804,1807,1810,1813,1816,1819,1822,1825,1828,1831,1834,1837,1840,1843,1846,1849,1852,1855,1858,1861,1864,1867,1870,1873,1876,1879,1882,1885,1888,1891,1894,1897,1900,1903,1906,1909,1912,1915,1918,1921,1924,1927,1930,1933,1936,1939,1942,1945,1948,1951,1954,1957,1960,1963,1966,1969,1972,1975,1978,1981,1984,1987,1990,1993,1996,1999,2002,2005,2008,2011,2014,2017,2020,2023,2026,2029,2032,2035,2038,2041,2044,2047,2050,2052,2055,2058,2059,2062,2065,2068,2071],{"path":1233,"title":1234},"\u002Fabout","About Python CLI Toolcraft",{"path":1236,"title":1237},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":1239,"title":1240},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":1242,"title":1243},"\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":1245,"title":1246},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":1248,"title":1249},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":1251,"title":1252},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":1254,"title":1255},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":1257,"title":1258},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":1260,"title":1261},"\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":1263,"title":1264},"\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":1266,"title":1267},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":1269,"title":1270},"\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":1272,"title":1273},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":1275,"title":1276},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":1278,"title":1279},"\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":1281,"title":1282},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":1284,"title":1285},"\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":1287,"title":1288},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":1290,"title":1291},"\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":1293,"title":1294},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":1296,"title":1297},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":1299,"title":1300},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":1302,"title":1303},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":1305,"title":1306},"\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":1308,"title":1309},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":1311,"title":1312},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":1314,"title":1315},"\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":1317,"title":1318},"\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":1320,"title":1321},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":1323,"title":1324},"\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":1326,"title":1327},"\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":1329,"title":1330},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":1332,"title":1333},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":1335,"title":1336},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":1338,"title":1339},"\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":1341,"title":1342},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":1344,"title":1345},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":1347,"title":1348},"\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":1350,"title":1351},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":1353,"title":1354},"\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":1356,"title":1357},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":1359,"title":1360},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":1362,"title":1363},"\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":1365,"title":1366},"\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":1368,"title":1369},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":1371,"title":1372},"\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":1374,"title":1375},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":1377,"title":1378},"\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":1380,"title":1381},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":1383,"title":1384},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":1386,"title":1387},"\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":1389,"title":1390},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":1392,"title":1393},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":1395,"title":1396},"\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":1398,"title":1399},"\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":1401,"title":1402},"\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":1404,"title":1405},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":1407,"title":1408},"\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":1410,"title":1411},"\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":1413,"title":1414},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":1416,"title":1417},"\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":1419,"title":1420},"\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":1422,"title":1423},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":1425,"title":1426},"\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":1428,"title":1429},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":1431,"title":1432},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":1434,"title":1435},"\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":1437,"title":1438},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":1440,"title":1441},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":1443,"title":1444},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":1446,"title":1447},"\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":1449,"title":1450},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":1452,"title":1453},"\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":1455,"title":1456},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":1458,"title":1459},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":1461,"title":1462},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":1464,"title":1465},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":1467,"title":1468},"\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":1470,"title":1471},"\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":1473,"title":1474},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":1476,"title":1477},"\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":1479,"title":1480},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":1482,"title":1483},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":1485,"title":1486},"\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":1488,"title":1489},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":1491,"title":1492},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":1494,"title":1495},"\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":1497,"title":1498},"\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":1500,"title":1501},"\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":1503,"title":1504},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":1506,"title":1507},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":1509,"title":1510},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":1512,"title":1513},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":1515,"title":1516},"\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":1518,"title":1519},"\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":1521,"title":1522},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":1524,"title":1525},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":1527,"title":1528},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":1530,"title":1531},"\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":1533,"title":1534},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":1536,"title":1537},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":1539,"title":1540},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":1542,"title":1543},"\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":1545,"title":1546},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":1548,"title":1549},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":1551,"title":1552},"\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":1554,"title":1555},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":1557,"title":1558},"\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":1560,"title":1561},"\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":1563,"title":1564},"\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":1566,"title":1567},"\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":1569,"title":1570},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":1572,"title":1573},"\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":1575,"title":1576},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":1578,"title":1579},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":1581,"title":1582},"\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":1584,"title":1585},"\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":1587,"title":1588},"\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":1590,"title":1591},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":1593,"title":1594},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":1596,"title":1597},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":1599,"title":1600},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":1602,"title":1603},"\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":1605,"title":1606},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":1608,"title":1609},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":1611,"title":1612},"\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":1614,"title":1615},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":1617,"title":1618},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":1620,"title":1621},"\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":1623,"title":1624},"\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":1626,"title":1627},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":1629,"title":1630},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":1632,"title":1633},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":1635,"title":1636},"\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":1638,"title":1639},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":1641,"title":1642},"\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":1644,"title":1645},"\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":1647,"title":1648},"\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":476,"title":1650},"Python CLI Toolcraft",{"path":1652,"title":1653},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":1655,"title":1656},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":1658,"title":1659},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":1661,"title":1662},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":1664,"title":1665},"\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":1667,"title":1668},"\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":1670,"title":1671},"\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":1673,"title":1674},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":1676,"title":1677},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":1679,"title":1680},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":1682,"title":1683},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":1685,"title":1686},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":1688,"title":1689},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":1691,"title":1692},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":1694,"title":1695},"\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":1697,"title":1698},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":1700,"title":1701},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":1703,"title":1704},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":1706,"title":1707},"\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":1709,"title":1710},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":1712,"title":1713},"\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":1715,"title":1716},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":1718,"title":1719},"\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":1721,"title":1722},"\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":1724,"title":1725},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":1727,"title":1728},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":1730,"title":1731},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":1733,"title":1734},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":1736,"title":1737},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":1739,"title":1740},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":1742,"title":1743},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":1745,"title":1746},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":1748,"title":1749},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":1751,"title":1752},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":1754,"title":1755},"\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":1757,"title":1758},"\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":1760,"title":1761},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":1763,"title":1764},"\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":1766,"title":1767},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":1769,"title":1770},"\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":1772,"title":1773},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":1775,"title":1776},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":1778,"title":1779},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":1781,"title":1782},"\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":1784,"title":1785},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":1787,"title":1788},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":1790,"title":1791},"\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":1793,"title":1794},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":1796,"title":1797},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":1799,"title":1800},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":1802,"title":1803},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":1805,"title":1806},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":1808,"title":1809},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":1811,"title":1812},"\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":1814,"title":1815},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":1817,"title":1818},"\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":1820,"title":1821},"\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":1823,"title":1824},"\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":1826,"title":1827},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":1829,"title":1830},"\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":1832,"title":1833},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":1835,"title":1836},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":1838,"title":1839},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":1841,"title":1842},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":1844,"title":1845},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":1847,"title":1848},"\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":1850,"title":1851},"\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":1853,"title":1854},"\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":1856,"title":1857},"\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":1859,"title":1860},"\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":1862,"title":1863},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":1865,"title":1866},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":1868,"title":1869},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":1871,"title":1872},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":1874,"title":1875},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":1877,"title":1878},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":1880,"title":1881},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":1883,"title":1884},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":1886,"title":1887},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":1889,"title":1890},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":1892,"title":1893},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":1895,"title":1896},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":1898,"title":1899},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":1901,"title":1902},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":1904,"title":1905},"\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":1907,"title":1908},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":1910,"title":1911},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":1913,"title":1914},"\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":1916,"title":1917},"\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":1919,"title":1920},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":1922,"title":1923},"\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":1925,"title":1926},"\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":1928,"title":1929},"\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":1931,"title":1932},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":1934,"title":1935},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":1937,"title":1938},"\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":1940,"title":1941},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":1943,"title":1944},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":1946,"title":1947},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":1949,"title":1950},"\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":1952,"title":1953},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":1955,"title":1956},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":1958,"title":1959},"\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":1961,"title":1962},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":1964,"title":1965},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":1967,"title":1968},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":1970,"title":1971},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":1973,"title":1974},"\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":1976,"title":1977},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":1979,"title":1980},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":1982,"title":1983},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":1985,"title":1986},"\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":1988,"title":1989},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":1991,"title":1992},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":1994,"title":1995},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":1997,"title":1998},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":2000,"title":2001},"\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":2003,"title":2004},"\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":2006,"title":2007},"\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":2009,"title":2010},"\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":2012,"title":2013},"\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":2015,"title":2016},"\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":2018,"title":2019},"\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":2021,"title":2022},"\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":2024,"title":2025},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":2027,"title":2028},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":2030,"title":2031},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":2033,"title":2034},"\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":2036,"title":2037},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":2039,"title":2040},"\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":2042,"title":2043},"\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":2045,"title":2046},"\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":2048,"title":2049},"\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":2051,"title":1186},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-tool-install-vs-pipx-for-clis",{"path":2053,"title":2054},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":2056,"title":2057},"\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":1222,"title":5},{"path":2060,"title":2061},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":2063,"title":2064},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":2066,"title":2067},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":2069,"title":2070},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":2072,"title":2073},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967543680]