[{"data":1,"prerenderedAt":3369},["ShallowReactive",2],{"page-\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version\u002F":3,"content-directory":2525},{"id":4,"title":5,"body":6,"date":2512,"description":2513,"difficulty":2514,"draft":2515,"extension":2516,"meta":2517,"navigation":337,"path":2518,"seo":2519,"stem":2520,"tags":2521,"updated":2512,"__hash__":2524},"content\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version\u002Findex.md","Checking PyPI for a Newer Version of Your Python CLI",{"type":7,"value":8,"toc":2492},"minimark",[9,34,39,79,83,89,93,281,301,305,1358,1373,1376,1379,1454,1459,1490,1494,1558,1561,1565,1573,2359,2366,2370,2377,2381,2389,2392,2396,2399,2407,2417,2421,2424,2428,2453,2457,2488],[10,11,12,13,17,18,22,23,28,29,33],"p",{},"The core of any update notifier is one question: is there a release newer than the one running right now? For a CLI published on PyPI, the answer is a single HTTPS request to the package index's JSON API — but getting it ",[14,15,16],"em",{},"right"," takes more care than ",[19,20,21],"code",{},"requests.get(...).json()[\"info\"][\"version\"]",". That field ignores pre-release policy, can point at a release the maintainer has since yanked, and the request itself can hang, fail or return a proxy's HTML error page. This guide builds a small, dependency-light function that answers the question correctly and never raises, and tests every failure mode. It is the first building block of the ",[24,25,27],"a",{"href":26},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002F","update checks topic","; the caching and display layer comes in ",[24,30,32],{"href":31},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fshowing-non-blocking-update-notices\u002F","showing non-blocking update notices",".",[35,36,38],"h2",{"id":37},"prerequisites","Prerequisites",[40,41,42,65,68],"ul",{},[43,44,45,46,49,50,53,54,57,58,49,61,64],"li",{},"Python 3.10+ with ",[19,47,48],{},"httpx"," and ",[19,51,52],{},"packaging"," (",[19,55,56],{},"uv add httpx packaging","); ",[19,59,60],{},"respx",[19,62,63],{},"pytest"," for the tests.",[43,66,67],{},"A package published on PyPI (or a private index that serves the same JSON API).",[43,69,70,71,74,75,33],{},"The installed version available through ",[19,72,73],{},"importlib.metadata",", as described in ",[24,76,78],{"href":77},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata\u002F","exposing version info and build metadata",[35,80,82],{"id":81},"what-the-json-api-returns","What the JSON API returns",[10,84,85,88],{},[19,86,87],{},"GET https:\u002F\u002Fpypi.org\u002Fpypi\u002F\u003Cproject>\u002Fjson"," returns metadata for the latest release plus a map of every release to its files. Only a few fields matter here:",[90,91],"inline-diagram",{"name":92},"upd-pypi-json",[94,95,100],"pre",{"className":96,"code":97,"language":98,"meta":99,"style":99},"language-json shiki shiki-themes github-light github-dark","{\n  \"info\": {\"name\": \"mytool\", \"version\": \"1.6.0\", \"yanked\": false},\n  \"releases\": {\n    \"1.5.0\": [{\"filename\": \"mytool-1.5.0-py3-none-any.whl\", \"yanked\": false}],\n    \"1.6.0\": [{\"filename\": \"mytool-1.6.0-py3-none-any.whl\", \"yanked\": false}],\n    \"1.7.0b1\": [{\"filename\": \"mytool-1.7.0b1-py3-none-any.whl\", \"yanked\": false}],\n    \"1.6.1\": [{\"filename\": \"mytool-1.6.1-py3-none-any.whl\", \"yanked\": true}]\n  }\n}\n","json","",[19,101,102,111,155,164,192,217,242,269,275],{"__ignoreMap":99},[103,104,107],"span",{"class":105,"line":106},"line",1,[103,108,110],{"class":109},"sVt8B","{\n",[103,112,114,118,121,124,127,131,134,137,139,142,144,147,149,152],{"class":105,"line":113},2,[103,115,117],{"class":116},"sj4cs","  \"info\"",[103,119,120],{"class":109},": {",[103,122,123],{"class":116},"\"name\"",[103,125,126],{"class":109},": ",[103,128,130],{"class":129},"sZZnC","\"mytool\"",[103,132,133],{"class":109},", ",[103,135,136],{"class":116},"\"version\"",[103,138,126],{"class":109},[103,140,141],{"class":129},"\"1.6.0\"",[103,143,133],{"class":109},[103,145,146],{"class":116},"\"yanked\"",[103,148,126],{"class":109},[103,150,151],{"class":116},"false",[103,153,154],{"class":109},"},\n",[103,156,158,161],{"class":105,"line":157},3,[103,159,160],{"class":116},"  \"releases\"",[103,162,163],{"class":109},": {\n",[103,165,167,170,173,176,178,181,183,185,187,189],{"class":105,"line":166},4,[103,168,169],{"class":116},"    \"1.5.0\"",[103,171,172],{"class":109},": [{",[103,174,175],{"class":116},"\"filename\"",[103,177,126],{"class":109},[103,179,180],{"class":129},"\"mytool-1.5.0-py3-none-any.whl\"",[103,182,133],{"class":109},[103,184,146],{"class":116},[103,186,126],{"class":109},[103,188,151],{"class":116},[103,190,191],{"class":109},"}],\n",[103,193,195,198,200,202,204,207,209,211,213,215],{"class":105,"line":194},5,[103,196,197],{"class":116},"    \"1.6.0\"",[103,199,172],{"class":109},[103,201,175],{"class":116},[103,203,126],{"class":109},[103,205,206],{"class":129},"\"mytool-1.6.0-py3-none-any.whl\"",[103,208,133],{"class":109},[103,210,146],{"class":116},[103,212,126],{"class":109},[103,214,151],{"class":116},[103,216,191],{"class":109},[103,218,220,223,225,227,229,232,234,236,238,240],{"class":105,"line":219},6,[103,221,222],{"class":116},"    \"1.7.0b1\"",[103,224,172],{"class":109},[103,226,175],{"class":116},[103,228,126],{"class":109},[103,230,231],{"class":129},"\"mytool-1.7.0b1-py3-none-any.whl\"",[103,233,133],{"class":109},[103,235,146],{"class":116},[103,237,126],{"class":109},[103,239,151],{"class":116},[103,241,191],{"class":109},[103,243,245,248,250,252,254,257,259,261,263,266],{"class":105,"line":244},7,[103,246,247],{"class":116},"    \"1.6.1\"",[103,249,172],{"class":109},[103,251,175],{"class":116},[103,253,126],{"class":109},[103,255,256],{"class":129},"\"mytool-1.6.1-py3-none-any.whl\"",[103,258,133],{"class":109},[103,260,146],{"class":116},[103,262,126],{"class":109},[103,264,265],{"class":116},"true",[103,267,268],{"class":109},"}]\n",[103,270,272],{"class":105,"line":271},8,[103,273,274],{"class":109},"  }\n",[103,276,278],{"class":105,"line":277},9,[103,279,280],{"class":109},"}\n",[10,282,283,286,287,290,291,294,295,297,298,300],{},[19,284,285],{},"info.version"," is PyPI's idea of the latest ",[14,288,289],{},"stable"," release, which is usually what you want — but computing the answer from ",[19,292,293],{},"releases"," lets you apply your own policy: include pre-releases for users already on one, skip versions whose files are all yanked, and ignore releases with no files at all (a version number can be registered without uploads). The ",[19,296,293],{}," key is the legacy part of the API and may be trimmed for very large projects someday, so fall back to ",[19,299,285],{}," if it is missing.",[35,302,304],{"id":303},"the-recipe","The recipe",[94,306,310],{"className":307,"code":308,"language":309,"meta":99,"style":99},"language-python shiki shiki-themes github-light github-dark","# src\u002Fmytool\u002Fupdates.py\nfrom __future__ import annotations\n\nfrom dataclasses import dataclass\nfrom importlib.metadata import PackageNotFoundError, version\n\nimport httpx\nfrom packaging.version import InvalidVersion, Version\n\nPYPI_URL = \"https:\u002F\u002Fpypi.org\u002Fpypi\u002F{name}\u002Fjson\"\n\n\n@dataclass(frozen=True)\nclass UpdateInfo:\n    current: str\n    latest: str\n\n    @property\n    def is_major(self) -> bool:\n        return Version(self.latest).major > Version(self.current).major\n\n\ndef installed_version(dist: str) -> str | None:\n    try:\n        return version(dist)\n    except PackageNotFoundError:          # running from a source checkout\n        return None\n\n\ndef _usable_versions(payload: dict, *, allow_prerelease: bool) -> list[Version]:\n    found = []\n    for raw, files in (payload.get(\"releases\") or {}).items():\n        if not files or all(f.get(\"yanked\") for f in files):\n            continue                       # no uploads, or every file yanked\n        try:\n            v = Version(raw)\n        except InvalidVersion:\n            continue\n        if v.is_prerelease and not allow_prerelease:\n            continue\n        found.append(v)\n    return found\n\n\ndef latest_version(payload: dict, *, allow_prerelease: bool = False) -> Version | None:\n    candidates = _usable_versions(payload, allow_prerelease=allow_prerelease)\n    if candidates:\n        return max(candidates)\n    try:                                   # releases missing: trust info.version\n        return Version(payload[\"info\"][\"version\"])\n    except (KeyError, TypeError, InvalidVersion):\n        return None\n\n\ndef check_pypi(dist: str, *, current: str | None = None, timeout: float = 1.5,\n               client: httpx.Client | None = None, index_url: str = PYPI_URL) -> UpdateInfo | None:\n    \"\"\"Return UpdateInfo if a newer release exists; None on 'no update' or any failure.\"\"\"\n    current = current or installed_version(dist)\n    if current is None:\n        return None\n    try:\n        cur = Version(current)\n    except InvalidVersion:\n        return None\n    own_client = client is None\n    client = client or httpx.Client(timeout=timeout, headers={\"User-Agent\": f\"{dist}\u002F{current}\"})\n    try:\n        response = client.get(index_url.format(name=dist))\n        response.raise_for_status()\n        payload = response.json()\n    except (httpx.HTTPError, ValueError):\n        return None                        # offline, timeout, 404, HTML error page...\n    finally:\n        if own_client:\n            client.close()\n    if not isinstance(payload, dict):\n        return None\n    latest = latest_version(payload, allow_prerelease=cur.is_prerelease)\n    if latest is None or latest \u003C= cur:\n        return None\n    return UpdateInfo(current=str(cur), latest=str(latest))\n","python",[19,311,312,318,333,339,352,364,368,375,387,391,409,414,419,442,454,463,471,476,485,502,527,532,537,565,573,581,593,601,606,611,638,649,676,711,720,728,739,748,754,770,775,781,790,795,800,835,854,863,874,885,904,922,929,934,939,982,1015,1021,1037,1051,1058,1065,1076,1083,1090,1105,1170,1177,1196,1202,1213,1227,1237,1245,1253,1259,1276,1283,1301,1324,1331],{"__ignoreMap":99},[103,313,314],{"class":105,"line":106},[103,315,317],{"class":316},"sJ8bj","# src\u002Fmytool\u002Fupdates.py\n",[103,319,320,324,327,330],{"class":105,"line":113},[103,321,323],{"class":322},"szBVR","from",[103,325,326],{"class":116}," __future__",[103,328,329],{"class":322}," import",[103,331,332],{"class":109}," annotations\n",[103,334,335],{"class":105,"line":157},[103,336,338],{"emptyLinePlaceholder":337},true,"\n",[103,340,341,343,346,349],{"class":105,"line":166},[103,342,323],{"class":322},[103,344,345],{"class":109}," dataclasses ",[103,347,348],{"class":322},"import",[103,350,351],{"class":109}," dataclass\n",[103,353,354,356,359,361],{"class":105,"line":194},[103,355,323],{"class":322},[103,357,358],{"class":109}," importlib.metadata ",[103,360,348],{"class":322},[103,362,363],{"class":109}," PackageNotFoundError, version\n",[103,365,366],{"class":105,"line":219},[103,367,338],{"emptyLinePlaceholder":337},[103,369,370,372],{"class":105,"line":244},[103,371,348],{"class":322},[103,373,374],{"class":109}," httpx\n",[103,376,377,379,382,384],{"class":105,"line":271},[103,378,323],{"class":322},[103,380,381],{"class":109}," packaging.version ",[103,383,348],{"class":322},[103,385,386],{"class":109}," InvalidVersion, Version\n",[103,388,389],{"class":105,"line":277},[103,390,338],{"emptyLinePlaceholder":337},[103,392,394,397,400,403,406],{"class":105,"line":393},10,[103,395,396],{"class":116},"PYPI_URL",[103,398,399],{"class":322}," =",[103,401,402],{"class":129}," \"https:\u002F\u002Fpypi.org\u002Fpypi\u002F",[103,404,405],{"class":116},"{name}",[103,407,408],{"class":129},"\u002Fjson\"\n",[103,410,412],{"class":105,"line":411},11,[103,413,338],{"emptyLinePlaceholder":337},[103,415,417],{"class":105,"line":416},12,[103,418,338],{"emptyLinePlaceholder":337},[103,420,422,426,429,433,436,439],{"class":105,"line":421},13,[103,423,425],{"class":424},"sScJk","@dataclass",[103,427,428],{"class":109},"(",[103,430,432],{"class":431},"s4XuR","frozen",[103,434,435],{"class":322},"=",[103,437,438],{"class":116},"True",[103,440,441],{"class":109},")\n",[103,443,445,448,451],{"class":105,"line":444},14,[103,446,447],{"class":322},"class",[103,449,450],{"class":424}," UpdateInfo",[103,452,453],{"class":109},":\n",[103,455,457,460],{"class":105,"line":456},15,[103,458,459],{"class":109},"    current: ",[103,461,462],{"class":116},"str\n",[103,464,466,469],{"class":105,"line":465},16,[103,467,468],{"class":109},"    latest: ",[103,470,462],{"class":116},[103,472,474],{"class":105,"line":473},17,[103,475,338],{"emptyLinePlaceholder":337},[103,477,479,482],{"class":105,"line":478},18,[103,480,481],{"class":424},"    @",[103,483,484],{"class":116},"property\n",[103,486,488,491,494,497,500],{"class":105,"line":487},19,[103,489,490],{"class":322},"    def",[103,492,493],{"class":424}," is_major",[103,495,496],{"class":109},"(self) -> ",[103,498,499],{"class":116},"bool",[103,501,453],{"class":109},[103,503,505,508,511,514,517,520,522,524],{"class":105,"line":504},20,[103,506,507],{"class":322},"        return",[103,509,510],{"class":109}," Version(",[103,512,513],{"class":116},"self",[103,515,516],{"class":109},".latest).major ",[103,518,519],{"class":322},">",[103,521,510],{"class":109},[103,523,513],{"class":116},[103,525,526],{"class":109},".current).major\n",[103,528,530],{"class":105,"line":529},21,[103,531,338],{"emptyLinePlaceholder":337},[103,533,535],{"class":105,"line":534},22,[103,536,338],{"emptyLinePlaceholder":337},[103,538,540,543,546,549,552,555,557,560,563],{"class":105,"line":539},23,[103,541,542],{"class":322},"def",[103,544,545],{"class":424}," installed_version",[103,547,548],{"class":109},"(dist: ",[103,550,551],{"class":116},"str",[103,553,554],{"class":109},") -> ",[103,556,551],{"class":116},[103,558,559],{"class":322}," |",[103,561,562],{"class":116}," None",[103,564,453],{"class":109},[103,566,568,571],{"class":105,"line":567},24,[103,569,570],{"class":322},"    try",[103,572,453],{"class":109},[103,574,576,578],{"class":105,"line":575},25,[103,577,507],{"class":322},[103,579,580],{"class":109}," version(dist)\n",[103,582,584,587,590],{"class":105,"line":583},26,[103,585,586],{"class":322},"    except",[103,588,589],{"class":109}," PackageNotFoundError:          ",[103,591,592],{"class":316},"# running from a source checkout\n",[103,594,596,598],{"class":105,"line":595},27,[103,597,507],{"class":322},[103,599,600],{"class":116}," None\n",[103,602,604],{"class":105,"line":603},28,[103,605,338],{"emptyLinePlaceholder":337},[103,607,609],{"class":105,"line":608},29,[103,610,338],{"emptyLinePlaceholder":337},[103,612,614,616,619,622,625,627,630,633,635],{"class":105,"line":613},30,[103,615,542],{"class":322},[103,617,618],{"class":424}," _usable_versions",[103,620,621],{"class":109},"(payload: ",[103,623,624],{"class":116},"dict",[103,626,133],{"class":109},[103,628,629],{"class":322},"*",[103,631,632],{"class":109},", allow_prerelease: ",[103,634,499],{"class":116},[103,636,637],{"class":109},") -> list[Version]:\n",[103,639,641,644,646],{"class":105,"line":640},31,[103,642,643],{"class":109},"    found ",[103,645,435],{"class":322},[103,647,648],{"class":109}," []\n",[103,650,652,655,658,661,664,667,670,673],{"class":105,"line":651},32,[103,653,654],{"class":322},"    for",[103,656,657],{"class":109}," raw, files ",[103,659,660],{"class":322},"in",[103,662,663],{"class":109}," (payload.get(",[103,665,666],{"class":129},"\"releases\"",[103,668,669],{"class":109},") ",[103,671,672],{"class":322},"or",[103,674,675],{"class":109}," {}).items():\n",[103,677,679,682,685,688,690,693,696,698,700,703,706,708],{"class":105,"line":678},33,[103,680,681],{"class":322},"        if",[103,683,684],{"class":322}," not",[103,686,687],{"class":109}," files ",[103,689,672],{"class":322},[103,691,692],{"class":116}," all",[103,694,695],{"class":109},"(f.get(",[103,697,146],{"class":129},[103,699,669],{"class":109},[103,701,702],{"class":322},"for",[103,704,705],{"class":109}," f ",[103,707,660],{"class":322},[103,709,710],{"class":109}," files):\n",[103,712,714,717],{"class":105,"line":713},34,[103,715,716],{"class":322},"            continue",[103,718,719],{"class":316},"                       # no uploads, or every file yanked\n",[103,721,723,726],{"class":105,"line":722},35,[103,724,725],{"class":322},"        try",[103,727,453],{"class":109},[103,729,731,734,736],{"class":105,"line":730},36,[103,732,733],{"class":109},"            v ",[103,735,435],{"class":322},[103,737,738],{"class":109}," Version(raw)\n",[103,740,742,745],{"class":105,"line":741},37,[103,743,744],{"class":322},"        except",[103,746,747],{"class":109}," InvalidVersion:\n",[103,749,751],{"class":105,"line":750},38,[103,752,753],{"class":322},"            continue\n",[103,755,757,759,762,765,767],{"class":105,"line":756},39,[103,758,681],{"class":322},[103,760,761],{"class":109}," v.is_prerelease ",[103,763,764],{"class":322},"and",[103,766,684],{"class":322},[103,768,769],{"class":109}," allow_prerelease:\n",[103,771,773],{"class":105,"line":772},40,[103,774,753],{"class":322},[103,776,778],{"class":105,"line":777},41,[103,779,780],{"class":109},"        found.append(v)\n",[103,782,784,787],{"class":105,"line":783},42,[103,785,786],{"class":322},"    return",[103,788,789],{"class":109}," found\n",[103,791,793],{"class":105,"line":792},43,[103,794,338],{"emptyLinePlaceholder":337},[103,796,798],{"class":105,"line":797},44,[103,799,338],{"emptyLinePlaceholder":337},[103,801,803,805,808,810,812,814,816,818,820,822,825,828,831,833],{"class":105,"line":802},45,[103,804,542],{"class":322},[103,806,807],{"class":424}," latest_version",[103,809,621],{"class":109},[103,811,624],{"class":116},[103,813,133],{"class":109},[103,815,629],{"class":322},[103,817,632],{"class":109},[103,819,499],{"class":116},[103,821,399],{"class":322},[103,823,824],{"class":116}," False",[103,826,827],{"class":109},") -> Version ",[103,829,830],{"class":322},"|",[103,832,562],{"class":116},[103,834,453],{"class":109},[103,836,838,841,843,846,849,851],{"class":105,"line":837},46,[103,839,840],{"class":109},"    candidates ",[103,842,435],{"class":322},[103,844,845],{"class":109}," _usable_versions(payload, ",[103,847,848],{"class":431},"allow_prerelease",[103,850,435],{"class":322},[103,852,853],{"class":109},"allow_prerelease)\n",[103,855,857,860],{"class":105,"line":856},47,[103,858,859],{"class":322},"    if",[103,861,862],{"class":109}," candidates:\n",[103,864,866,868,871],{"class":105,"line":865},48,[103,867,507],{"class":322},[103,869,870],{"class":116}," max",[103,872,873],{"class":109},"(candidates)\n",[103,875,877,879,882],{"class":105,"line":876},49,[103,878,570],{"class":322},[103,880,881],{"class":109},":                                   ",[103,883,884],{"class":316},"# releases missing: trust info.version\n",[103,886,888,890,893,896,899,901],{"class":105,"line":887},50,[103,889,507],{"class":322},[103,891,892],{"class":109}," Version(payload[",[103,894,895],{"class":129},"\"info\"",[103,897,898],{"class":109},"][",[103,900,136],{"class":129},[103,902,903],{"class":109},"])\n",[103,905,907,909,911,914,916,919],{"class":105,"line":906},51,[103,908,586],{"class":322},[103,910,53],{"class":109},[103,912,913],{"class":116},"KeyError",[103,915,133],{"class":109},[103,917,918],{"class":116},"TypeError",[103,920,921],{"class":109},", InvalidVersion):\n",[103,923,925,927],{"class":105,"line":924},52,[103,926,507],{"class":322},[103,928,600],{"class":116},[103,930,932],{"class":105,"line":931},53,[103,933,338],{"emptyLinePlaceholder":337},[103,935,937],{"class":105,"line":936},54,[103,938,338],{"emptyLinePlaceholder":337},[103,940,942,944,947,949,951,953,955,958,960,962,964,966,968,971,974,976,979],{"class":105,"line":941},55,[103,943,542],{"class":322},[103,945,946],{"class":424}," check_pypi",[103,948,548],{"class":109},[103,950,551],{"class":116},[103,952,133],{"class":109},[103,954,629],{"class":322},[103,956,957],{"class":109},", current: ",[103,959,551],{"class":116},[103,961,559],{"class":322},[103,963,562],{"class":116},[103,965,399],{"class":322},[103,967,562],{"class":116},[103,969,970],{"class":109},", timeout: ",[103,972,973],{"class":116},"float",[103,975,399],{"class":322},[103,977,978],{"class":116}," 1.5",[103,980,981],{"class":109},",\n",[103,983,985,988,990,992,994,996,999,1001,1003,1006,1009,1011,1013],{"class":105,"line":984},56,[103,986,987],{"class":109},"               client: httpx.Client ",[103,989,830],{"class":322},[103,991,562],{"class":116},[103,993,399],{"class":322},[103,995,562],{"class":116},[103,997,998],{"class":109},", index_url: ",[103,1000,551],{"class":116},[103,1002,399],{"class":322},[103,1004,1005],{"class":116}," PYPI_URL",[103,1007,1008],{"class":109},") -> UpdateInfo ",[103,1010,830],{"class":322},[103,1012,562],{"class":116},[103,1014,453],{"class":109},[103,1016,1018],{"class":105,"line":1017},57,[103,1019,1020],{"class":129},"    \"\"\"Return UpdateInfo if a newer release exists; None on 'no update' or any failure.\"\"\"\n",[103,1022,1024,1027,1029,1032,1034],{"class":105,"line":1023},58,[103,1025,1026],{"class":109},"    current ",[103,1028,435],{"class":322},[103,1030,1031],{"class":109}," current ",[103,1033,672],{"class":322},[103,1035,1036],{"class":109}," installed_version(dist)\n",[103,1038,1040,1042,1044,1047,1049],{"class":105,"line":1039},59,[103,1041,859],{"class":322},[103,1043,1031],{"class":109},[103,1045,1046],{"class":322},"is",[103,1048,562],{"class":116},[103,1050,453],{"class":109},[103,1052,1054,1056],{"class":105,"line":1053},60,[103,1055,507],{"class":322},[103,1057,600],{"class":116},[103,1059,1061,1063],{"class":105,"line":1060},61,[103,1062,570],{"class":322},[103,1064,453],{"class":109},[103,1066,1068,1071,1073],{"class":105,"line":1067},62,[103,1069,1070],{"class":109},"        cur ",[103,1072,435],{"class":322},[103,1074,1075],{"class":109}," Version(current)\n",[103,1077,1079,1081],{"class":105,"line":1078},63,[103,1080,586],{"class":322},[103,1082,747],{"class":109},[103,1084,1086,1088],{"class":105,"line":1085},64,[103,1087,507],{"class":322},[103,1089,600],{"class":116},[103,1091,1093,1096,1098,1101,1103],{"class":105,"line":1092},65,[103,1094,1095],{"class":109},"    own_client ",[103,1097,435],{"class":322},[103,1099,1100],{"class":109}," client ",[103,1102,1046],{"class":322},[103,1104,600],{"class":116},[103,1106,1108,1111,1113,1115,1117,1120,1123,1125,1128,1131,1133,1136,1139,1141,1144,1147,1149,1152,1155,1158,1160,1163,1165,1167],{"class":105,"line":1107},66,[103,1109,1110],{"class":109},"    client ",[103,1112,435],{"class":322},[103,1114,1100],{"class":109},[103,1116,672],{"class":322},[103,1118,1119],{"class":109}," httpx.Client(",[103,1121,1122],{"class":431},"timeout",[103,1124,435],{"class":322},[103,1126,1127],{"class":109},"timeout, ",[103,1129,1130],{"class":431},"headers",[103,1132,435],{"class":322},[103,1134,1135],{"class":109},"{",[103,1137,1138],{"class":129},"\"User-Agent\"",[103,1140,126],{"class":109},[103,1142,1143],{"class":322},"f",[103,1145,1146],{"class":129},"\"",[103,1148,1135],{"class":116},[103,1150,1151],{"class":109},"dist",[103,1153,1154],{"class":116},"}",[103,1156,1157],{"class":129},"\u002F",[103,1159,1135],{"class":116},[103,1161,1162],{"class":109},"current",[103,1164,1154],{"class":116},[103,1166,1146],{"class":129},[103,1168,1169],{"class":109},"})\n",[103,1171,1173,1175],{"class":105,"line":1172},67,[103,1174,570],{"class":322},[103,1176,453],{"class":109},[103,1178,1180,1183,1185,1188,1191,1193],{"class":105,"line":1179},68,[103,1181,1182],{"class":109},"        response ",[103,1184,435],{"class":322},[103,1186,1187],{"class":109}," client.get(index_url.format(",[103,1189,1190],{"class":431},"name",[103,1192,435],{"class":322},[103,1194,1195],{"class":109},"dist))\n",[103,1197,1199],{"class":105,"line":1198},69,[103,1200,1201],{"class":109},"        response.raise_for_status()\n",[103,1203,1205,1208,1210],{"class":105,"line":1204},70,[103,1206,1207],{"class":109},"        payload ",[103,1209,435],{"class":322},[103,1211,1212],{"class":109}," response.json()\n",[103,1214,1216,1218,1221,1224],{"class":105,"line":1215},71,[103,1217,586],{"class":322},[103,1219,1220],{"class":109}," (httpx.HTTPError, ",[103,1222,1223],{"class":116},"ValueError",[103,1225,1226],{"class":109},"):\n",[103,1228,1230,1232,1234],{"class":105,"line":1229},72,[103,1231,507],{"class":322},[103,1233,562],{"class":116},[103,1235,1236],{"class":316},"                        # offline, timeout, 404, HTML error page...\n",[103,1238,1240,1243],{"class":105,"line":1239},73,[103,1241,1242],{"class":322},"    finally",[103,1244,453],{"class":109},[103,1246,1248,1250],{"class":105,"line":1247},74,[103,1249,681],{"class":322},[103,1251,1252],{"class":109}," own_client:\n",[103,1254,1256],{"class":105,"line":1255},75,[103,1257,1258],{"class":109},"            client.close()\n",[103,1260,1262,1264,1266,1269,1272,1274],{"class":105,"line":1261},76,[103,1263,859],{"class":322},[103,1265,684],{"class":322},[103,1267,1268],{"class":116}," isinstance",[103,1270,1271],{"class":109},"(payload, ",[103,1273,624],{"class":116},[103,1275,1226],{"class":109},[103,1277,1279,1281],{"class":105,"line":1278},77,[103,1280,507],{"class":322},[103,1282,600],{"class":116},[103,1284,1286,1289,1291,1294,1296,1298],{"class":105,"line":1285},78,[103,1287,1288],{"class":109},"    latest ",[103,1290,435],{"class":322},[103,1292,1293],{"class":109}," latest_version(payload, ",[103,1295,848],{"class":431},[103,1297,435],{"class":322},[103,1299,1300],{"class":109},"cur.is_prerelease)\n",[103,1302,1304,1306,1309,1311,1313,1316,1318,1321],{"class":105,"line":1303},79,[103,1305,859],{"class":322},[103,1307,1308],{"class":109}," latest ",[103,1310,1046],{"class":322},[103,1312,562],{"class":116},[103,1314,1315],{"class":322}," or",[103,1317,1308],{"class":109},[103,1319,1320],{"class":322},"\u003C=",[103,1322,1323],{"class":109}," cur:\n",[103,1325,1327,1329],{"class":105,"line":1326},80,[103,1328,507],{"class":322},[103,1330,600],{"class":116},[103,1332,1334,1336,1339,1341,1343,1345,1348,1351,1353,1355],{"class":105,"line":1333},81,[103,1335,786],{"class":322},[103,1337,1338],{"class":109}," UpdateInfo(",[103,1340,1162],{"class":431},[103,1342,435],{"class":322},[103,1344,551],{"class":116},[103,1346,1347],{"class":109},"(cur), ",[103,1349,1350],{"class":431},"latest",[103,1352,435],{"class":322},[103,1354,551],{"class":116},[103,1356,1357],{"class":109},"(latest))\n",[10,1359,1360,1361,1364,1365,1368,1369,1372],{},"The function's contract is deliberately narrow: it returns an ",[19,1362,1363],{},"UpdateInfo"," only when there is something to say, and ",[19,1366,1367],{},"None"," in every other case — including every kind of failure. Callers never need a ",[19,1370,1371],{},"try"," block, which is what you want for a feature that runs on every invocation and must never be the reason a command fails.",[90,1374],{"name":1375},"upd-pypi-decision",[10,1377,1378],{},"A few details deserve explanation:",[40,1380,1381,1405,1425,1435,1446],{},[43,1382,1383,1389,1390,1393,1394,49,1397,1400,1401,1404],{},[1384,1385,1386],"strong",{},[19,1387,1388],{},"allow_prerelease=cur.is_prerelease"," implements the usual policy: someone on ",[19,1391,1392],{},"2.0.0rc1"," hears about ",[19,1395,1396],{},"2.0.0rc2",[19,1398,1399],{},"2.0.0","; someone on ",[19,1402,1403],{},"1.6.0"," never hears about a beta.",[43,1406,1407,1417,1418,49,1421,1424],{},[1384,1408,1409,1412,1413,1416],{},[19,1410,1411],{},"max()"," over ",[19,1414,1415],{},"Version"," objects"," uses PEP 440 ordering, so ",[19,1419,1420],{},"1.10.0 > 1.9.0",[19,1422,1423],{},"1.6.0.post1 > 1.6.0"," behave as pip does.",[43,1426,1427,1434],{},[1384,1428,1429,1430,1433],{},"A ",[19,1431,1432],{},"User-Agent"," header"," identifies your tool politely in the index's logs. It contains only the tool name and version — nothing about the user.",[43,1436,1437,1445],{},[1384,1438,1439,1442,1443],{},[19,1440,1441],{},"response.json()"," can raise ",[19,1444,1223],{}," when a captive portal or proxy returns HTML with status 200. That is caught along with network errors.",[43,1447,1448,1453],{},[1384,1449,1450],{},[19,1451,1452],{},"timeout=1.5"," covers connect, read and write in httpx. Keep it short; this function will run in a background thread, but a short timeout limits how long that thread can keep the process alive.",[1455,1456,1458],"h3",{"id":1457},"private-indexes-and-other-sources","Private indexes and other sources",[10,1460,1461,1462,1465,1466,1469,1470,1473,1474,1477,1478,1481,1482,1485,1486,1489],{},"Indexes such as devpi, Artifactory, Nexus and GitLab's package registry often serve the same ",[19,1463,1464],{},"\u002Fpypi\u002F\u003Cname>\u002Fjson"," endpoint; pass ",[19,1467,1468],{},"index_url="," with their base. If an index only implements the Simple API (PEP 691 JSON), request ",[19,1471,1472],{},"https:\u002F\u002F\u003Cindex>\u002Fsimple\u002F\u003Cname>\u002F"," with ",[19,1475,1476],{},"Accept: application\u002Fvnd.pypi.simple.v1+json"," and read versions from the ",[19,1479,1480],{},"versions"," list — the comparison logic stays identical. For binaries published on GitHub, the latest release tag comes from ",[19,1483,1484],{},"https:\u002F\u002Fapi.github.com\u002Frepos\u002F\u003Cowner>\u002F\u003Crepo>\u002Freleases\u002Flatest","; strip a leading ",[19,1487,1488],{},"v"," before parsing.",[35,1491,1493],{"id":1492},"ux-considerations","UX considerations",[40,1495,1496,1517,1523,1532,1545],{},[43,1497,1498,1501,1502,1505,1506,53,1509,1512,1513,1516],{},[1384,1499,1500],{},"Use the distribution name, not the import name."," ",[19,1503,1504],{},"importlib.metadata.version()"," and PyPI both want the name from ",[19,1507,1508],{},"pyproject.toml",[19,1510,1511],{},"my-tool","), which may differ from the package you import (",[19,1514,1515],{},"my_tool",").",[43,1518,1519,1522],{},[1384,1520,1521],{},"Return early for source checkouts."," When the package is not installed, there is no meaningful \"current version\"; staying silent avoids nagging contributors running from a clone.",[43,1524,1525,1501,1528,1531],{},[1384,1526,1527],{},"Flag major releases.",[19,1529,1530],{},"UpdateInfo.is_major"," lets the notice say \"2.0 is available — see what changed\" instead of implying a routine upgrade.",[43,1533,1534,1501,1537,1540,1541,1544],{},[1384,1535,1536],{},"Expose a manual command.",[19,1538,1539],{},"mytool version --check"," that calls ",[19,1542,1543],{},"check_pypi()"," synchronously and prints the result is useful for support (\"which version are you on, and is there a newer one?\") and costs nothing to add.",[43,1546,1547,1550,1551,49,1554,1557],{},[1384,1548,1549],{},"Respect proxies."," httpx honours ",[19,1552,1553],{},"HTTPS_PROXY",[19,1555,1556],{},"NO_PROXY"," by default; keep that behaviour so corporate users are not left with a check that always times out.",[90,1559],{"name":1560},"upd-pypi-terminal",[35,1562,1564],{"id":1563},"testing-the-behaviour","Testing the behaviour",[10,1566,1567,1569,1570,1572],{},[19,1568,60],{}," mocks httpx at the transport layer, so the real ",[19,1571,1543],{}," runs against canned responses. Cover the happy path, each policy decision and each failure:",[94,1574,1576],{"className":307,"code":1575,"language":309,"meta":99,"style":99},"# tests\u002Ftest_updates.py\nimport httpx\nimport pytest\nimport respx\n\nfrom mytool.updates import check_pypi\n\nURL = \"https:\u002F\u002Fpypi.org\u002Fpypi\u002Fmytool\u002Fjson\"\n\n\ndef payload(*versions, yanked=(), info=\"1.6.0\"):\n    return {\n        \"info\": {\"version\": info},\n        \"releases\": {v: [{\"yanked\": v in yanked}] for v in versions},\n    }\n\n\n@respx.mock\ndef test_reports_newer_stable_release():\n    respx.get(URL).respond(json=payload(\"1.5.0\", \"1.6.0\", \"1.7.0b1\"))\n    info = check_pypi(\"mytool\", current=\"1.5.0\")\n    assert (info.current, info.latest) == (\"1.5.0\", \"1.6.0\")\n\n\n@respx.mock\ndef test_skips_yanked_release():\n    respx.get(URL).respond(json=payload(\"1.6.0\", \"1.6.1\", yanked={\"1.6.1\"}))\n    assert check_pypi(\"mytool\", current=\"1.6.0\") is None\n\n\n@respx.mock\ndef test_prerelease_users_hear_about_prereleases():\n    respx.get(URL).respond(json=payload(\"1.6.0\", \"2.0.0rc1\", \"2.0.0rc2\"))\n    assert check_pypi(\"mytool\", current=\"2.0.0rc1\").latest == \"2.0.0rc2\"\n\n\n@respx.mock\ndef test_versions_compare_numerically():\n    respx.get(URL).respond(json=payload(\"1.9.0\", \"1.10.0\"))\n    assert check_pypi(\"mytool\", current=\"1.9.0\").latest == \"1.10.0\"\n\n\n@respx.mock\ndef test_falls_back_to_info_version():\n    respx.get(URL).respond(json={\"info\": {\"version\": \"3.0.0\"}})\n    info = check_pypi(\"mytool\", current=\"2.9.0\")\n    assert info.latest == \"3.0.0\" and info.is_major\n\n\n@respx.mock\n@pytest.mark.parametrize(\"response\", [\n    httpx.Response(404),\n    httpx.Response(200, text=\"\u003Chtml>Proxy login\u003C\u002Fhtml>\"),\n    httpx.Response(200, json=[\"not\", \"a\", \"dict\"]),\n])\ndef test_bad_responses_are_silent(response):\n    respx.get(URL).mock(return_value=response)\n    assert check_pypi(\"mytool\", current=\"1.0.0\") is None\n\n\n@respx.mock\ndef test_timeouts_are_silent():\n    respx.get(URL).mock(side_effect=httpx.ConnectTimeout(\"slow\"))\n    assert check_pypi(\"mytool\", current=\"1.0.0\") is None\n\n\ndef test_not_installed_is_silent():\n    assert check_pypi(\"definitely-not-installed-xyz\") is None\n",[19,1577,1578,1583,1589,1596,1603,1607,1619,1623,1633,1637,1641,1666,1673,1685,1713,1718,1722,1726,1731,1741,1773,1795,1816,1820,1824,1828,1837,1872,1894,1898,1902,1906,1915,1943,1967,1971,1975,1979,1988,2012,2035,2039,2043,2047,2056,2084,2105,2123,2127,2131,2135,2148,2159,2178,2209,2213,2223,2240,2263,2267,2271,2275,2284,2305,2327,2331,2335,2344],{"__ignoreMap":99},[103,1579,1580],{"class":105,"line":106},[103,1581,1582],{"class":316},"# tests\u002Ftest_updates.py\n",[103,1584,1585,1587],{"class":105,"line":113},[103,1586,348],{"class":322},[103,1588,374],{"class":109},[103,1590,1591,1593],{"class":105,"line":157},[103,1592,348],{"class":322},[103,1594,1595],{"class":109}," pytest\n",[103,1597,1598,1600],{"class":105,"line":166},[103,1599,348],{"class":322},[103,1601,1602],{"class":109}," respx\n",[103,1604,1605],{"class":105,"line":194},[103,1606,338],{"emptyLinePlaceholder":337},[103,1608,1609,1611,1614,1616],{"class":105,"line":219},[103,1610,323],{"class":322},[103,1612,1613],{"class":109}," mytool.updates ",[103,1615,348],{"class":322},[103,1617,1618],{"class":109}," check_pypi\n",[103,1620,1621],{"class":105,"line":244},[103,1622,338],{"emptyLinePlaceholder":337},[103,1624,1625,1628,1630],{"class":105,"line":271},[103,1626,1627],{"class":116},"URL",[103,1629,399],{"class":322},[103,1631,1632],{"class":129}," \"https:\u002F\u002Fpypi.org\u002Fpypi\u002Fmytool\u002Fjson\"\n",[103,1634,1635],{"class":105,"line":277},[103,1636,338],{"emptyLinePlaceholder":337},[103,1638,1639],{"class":105,"line":393},[103,1640,338],{"emptyLinePlaceholder":337},[103,1642,1643,1645,1648,1650,1652,1655,1657,1660,1662,1664],{"class":105,"line":411},[103,1644,542],{"class":322},[103,1646,1647],{"class":424}," payload",[103,1649,428],{"class":109},[103,1651,629],{"class":322},[103,1653,1654],{"class":109},"versions, yanked",[103,1656,435],{"class":322},[103,1658,1659],{"class":109},"(), info",[103,1661,435],{"class":322},[103,1663,141],{"class":129},[103,1665,1226],{"class":109},[103,1667,1668,1670],{"class":105,"line":416},[103,1669,786],{"class":322},[103,1671,1672],{"class":109}," {\n",[103,1674,1675,1678,1680,1682],{"class":105,"line":421},[103,1676,1677],{"class":129},"        \"info\"",[103,1679,120],{"class":109},[103,1681,136],{"class":129},[103,1683,1684],{"class":109},": info},\n",[103,1686,1687,1690,1693,1695,1698,1700,1703,1705,1708,1710],{"class":105,"line":444},[103,1688,1689],{"class":129},"        \"releases\"",[103,1691,1692],{"class":109},": {v: [{",[103,1694,146],{"class":129},[103,1696,1697],{"class":109},": v ",[103,1699,660],{"class":322},[103,1701,1702],{"class":109}," yanked}] ",[103,1704,702],{"class":322},[103,1706,1707],{"class":109}," v ",[103,1709,660],{"class":322},[103,1711,1712],{"class":109}," versions},\n",[103,1714,1715],{"class":105,"line":456},[103,1716,1717],{"class":109},"    }\n",[103,1719,1720],{"class":105,"line":465},[103,1721,338],{"emptyLinePlaceholder":337},[103,1723,1724],{"class":105,"line":473},[103,1725,338],{"emptyLinePlaceholder":337},[103,1727,1728],{"class":105,"line":478},[103,1729,1730],{"class":424},"@respx.mock\n",[103,1732,1733,1735,1738],{"class":105,"line":487},[103,1734,542],{"class":322},[103,1736,1737],{"class":424}," test_reports_newer_stable_release",[103,1739,1740],{"class":109},"():\n",[103,1742,1743,1746,1748,1751,1753,1755,1758,1761,1763,1765,1767,1770],{"class":105,"line":504},[103,1744,1745],{"class":109},"    respx.get(",[103,1747,1627],{"class":116},[103,1749,1750],{"class":109},").respond(",[103,1752,98],{"class":431},[103,1754,435],{"class":322},[103,1756,1757],{"class":109},"payload(",[103,1759,1760],{"class":129},"\"1.5.0\"",[103,1762,133],{"class":109},[103,1764,141],{"class":129},[103,1766,133],{"class":109},[103,1768,1769],{"class":129},"\"1.7.0b1\"",[103,1771,1772],{"class":109},"))\n",[103,1774,1775,1778,1780,1783,1785,1787,1789,1791,1793],{"class":105,"line":529},[103,1776,1777],{"class":109},"    info ",[103,1779,435],{"class":322},[103,1781,1782],{"class":109}," check_pypi(",[103,1784,130],{"class":129},[103,1786,133],{"class":109},[103,1788,1162],{"class":431},[103,1790,435],{"class":322},[103,1792,1760],{"class":129},[103,1794,441],{"class":109},[103,1796,1797,1800,1803,1806,1808,1810,1812,1814],{"class":105,"line":534},[103,1798,1799],{"class":322},"    assert",[103,1801,1802],{"class":109}," (info.current, info.latest) ",[103,1804,1805],{"class":322},"==",[103,1807,53],{"class":109},[103,1809,1760],{"class":129},[103,1811,133],{"class":109},[103,1813,141],{"class":129},[103,1815,441],{"class":109},[103,1817,1818],{"class":105,"line":539},[103,1819,338],{"emptyLinePlaceholder":337},[103,1821,1822],{"class":105,"line":567},[103,1823,338],{"emptyLinePlaceholder":337},[103,1825,1826],{"class":105,"line":575},[103,1827,1730],{"class":424},[103,1829,1830,1832,1835],{"class":105,"line":583},[103,1831,542],{"class":322},[103,1833,1834],{"class":424}," test_skips_yanked_release",[103,1836,1740],{"class":109},[103,1838,1839,1841,1843,1845,1847,1849,1851,1853,1855,1858,1860,1863,1865,1867,1869],{"class":105,"line":595},[103,1840,1745],{"class":109},[103,1842,1627],{"class":116},[103,1844,1750],{"class":109},[103,1846,98],{"class":431},[103,1848,435],{"class":322},[103,1850,1757],{"class":109},[103,1852,141],{"class":129},[103,1854,133],{"class":109},[103,1856,1857],{"class":129},"\"1.6.1\"",[103,1859,133],{"class":109},[103,1861,1862],{"class":431},"yanked",[103,1864,435],{"class":322},[103,1866,1135],{"class":109},[103,1868,1857],{"class":129},[103,1870,1871],{"class":109},"}))\n",[103,1873,1874,1876,1878,1880,1882,1884,1886,1888,1890,1892],{"class":105,"line":603},[103,1875,1799],{"class":322},[103,1877,1782],{"class":109},[103,1879,130],{"class":129},[103,1881,133],{"class":109},[103,1883,1162],{"class":431},[103,1885,435],{"class":322},[103,1887,141],{"class":129},[103,1889,669],{"class":109},[103,1891,1046],{"class":322},[103,1893,600],{"class":116},[103,1895,1896],{"class":105,"line":608},[103,1897,338],{"emptyLinePlaceholder":337},[103,1899,1900],{"class":105,"line":613},[103,1901,338],{"emptyLinePlaceholder":337},[103,1903,1904],{"class":105,"line":640},[103,1905,1730],{"class":424},[103,1907,1908,1910,1913],{"class":105,"line":651},[103,1909,542],{"class":322},[103,1911,1912],{"class":424}," test_prerelease_users_hear_about_prereleases",[103,1914,1740],{"class":109},[103,1916,1917,1919,1921,1923,1925,1927,1929,1931,1933,1936,1938,1941],{"class":105,"line":678},[103,1918,1745],{"class":109},[103,1920,1627],{"class":116},[103,1922,1750],{"class":109},[103,1924,98],{"class":431},[103,1926,435],{"class":322},[103,1928,1757],{"class":109},[103,1930,141],{"class":129},[103,1932,133],{"class":109},[103,1934,1935],{"class":129},"\"2.0.0rc1\"",[103,1937,133],{"class":109},[103,1939,1940],{"class":129},"\"2.0.0rc2\"",[103,1942,1772],{"class":109},[103,1944,1945,1947,1949,1951,1953,1955,1957,1959,1962,1964],{"class":105,"line":713},[103,1946,1799],{"class":322},[103,1948,1782],{"class":109},[103,1950,130],{"class":129},[103,1952,133],{"class":109},[103,1954,1162],{"class":431},[103,1956,435],{"class":322},[103,1958,1935],{"class":129},[103,1960,1961],{"class":109},").latest ",[103,1963,1805],{"class":322},[103,1965,1966],{"class":129}," \"2.0.0rc2\"\n",[103,1968,1969],{"class":105,"line":722},[103,1970,338],{"emptyLinePlaceholder":337},[103,1972,1973],{"class":105,"line":730},[103,1974,338],{"emptyLinePlaceholder":337},[103,1976,1977],{"class":105,"line":741},[103,1978,1730],{"class":424},[103,1980,1981,1983,1986],{"class":105,"line":750},[103,1982,542],{"class":322},[103,1984,1985],{"class":424}," test_versions_compare_numerically",[103,1987,1740],{"class":109},[103,1989,1990,1992,1994,1996,1998,2000,2002,2005,2007,2010],{"class":105,"line":756},[103,1991,1745],{"class":109},[103,1993,1627],{"class":116},[103,1995,1750],{"class":109},[103,1997,98],{"class":431},[103,1999,435],{"class":322},[103,2001,1757],{"class":109},[103,2003,2004],{"class":129},"\"1.9.0\"",[103,2006,133],{"class":109},[103,2008,2009],{"class":129},"\"1.10.0\"",[103,2011,1772],{"class":109},[103,2013,2014,2016,2018,2020,2022,2024,2026,2028,2030,2032],{"class":105,"line":772},[103,2015,1799],{"class":322},[103,2017,1782],{"class":109},[103,2019,130],{"class":129},[103,2021,133],{"class":109},[103,2023,1162],{"class":431},[103,2025,435],{"class":322},[103,2027,2004],{"class":129},[103,2029,1961],{"class":109},[103,2031,1805],{"class":322},[103,2033,2034],{"class":129}," \"1.10.0\"\n",[103,2036,2037],{"class":105,"line":777},[103,2038,338],{"emptyLinePlaceholder":337},[103,2040,2041],{"class":105,"line":783},[103,2042,338],{"emptyLinePlaceholder":337},[103,2044,2045],{"class":105,"line":792},[103,2046,1730],{"class":424},[103,2048,2049,2051,2054],{"class":105,"line":797},[103,2050,542],{"class":322},[103,2052,2053],{"class":424}," test_falls_back_to_info_version",[103,2055,1740],{"class":109},[103,2057,2058,2060,2062,2064,2066,2068,2070,2072,2074,2076,2078,2081],{"class":105,"line":802},[103,2059,1745],{"class":109},[103,2061,1627],{"class":116},[103,2063,1750],{"class":109},[103,2065,98],{"class":431},[103,2067,435],{"class":322},[103,2069,1135],{"class":109},[103,2071,895],{"class":129},[103,2073,120],{"class":109},[103,2075,136],{"class":129},[103,2077,126],{"class":109},[103,2079,2080],{"class":129},"\"3.0.0\"",[103,2082,2083],{"class":109},"}})\n",[103,2085,2086,2088,2090,2092,2094,2096,2098,2100,2103],{"class":105,"line":837},[103,2087,1777],{"class":109},[103,2089,435],{"class":322},[103,2091,1782],{"class":109},[103,2093,130],{"class":129},[103,2095,133],{"class":109},[103,2097,1162],{"class":431},[103,2099,435],{"class":322},[103,2101,2102],{"class":129},"\"2.9.0\"",[103,2104,441],{"class":109},[103,2106,2107,2109,2112,2114,2117,2120],{"class":105,"line":856},[103,2108,1799],{"class":322},[103,2110,2111],{"class":109}," info.latest ",[103,2113,1805],{"class":322},[103,2115,2116],{"class":129}," \"3.0.0\"",[103,2118,2119],{"class":322}," and",[103,2121,2122],{"class":109}," info.is_major\n",[103,2124,2125],{"class":105,"line":865},[103,2126,338],{"emptyLinePlaceholder":337},[103,2128,2129],{"class":105,"line":876},[103,2130,338],{"emptyLinePlaceholder":337},[103,2132,2133],{"class":105,"line":887},[103,2134,1730],{"class":424},[103,2136,2137,2140,2142,2145],{"class":105,"line":906},[103,2138,2139],{"class":424},"@pytest.mark.parametrize",[103,2141,428],{"class":109},[103,2143,2144],{"class":129},"\"response\"",[103,2146,2147],{"class":109},", [\n",[103,2149,2150,2153,2156],{"class":105,"line":924},[103,2151,2152],{"class":109},"    httpx.Response(",[103,2154,2155],{"class":116},"404",[103,2157,2158],{"class":109},"),\n",[103,2160,2161,2163,2166,2168,2171,2173,2176],{"class":105,"line":931},[103,2162,2152],{"class":109},[103,2164,2165],{"class":116},"200",[103,2167,133],{"class":109},[103,2169,2170],{"class":431},"text",[103,2172,435],{"class":322},[103,2174,2175],{"class":129},"\"\u003Chtml>Proxy login\u003C\u002Fhtml>\"",[103,2177,2158],{"class":109},[103,2179,2180,2182,2184,2186,2188,2190,2193,2196,2198,2201,2203,2206],{"class":105,"line":936},[103,2181,2152],{"class":109},[103,2183,2165],{"class":116},[103,2185,133],{"class":109},[103,2187,98],{"class":431},[103,2189,435],{"class":322},[103,2191,2192],{"class":109},"[",[103,2194,2195],{"class":129},"\"not\"",[103,2197,133],{"class":109},[103,2199,2200],{"class":129},"\"a\"",[103,2202,133],{"class":109},[103,2204,2205],{"class":129},"\"dict\"",[103,2207,2208],{"class":109},"]),\n",[103,2210,2211],{"class":105,"line":941},[103,2212,903],{"class":109},[103,2214,2215,2217,2220],{"class":105,"line":984},[103,2216,542],{"class":322},[103,2218,2219],{"class":424}," test_bad_responses_are_silent",[103,2221,2222],{"class":109},"(response):\n",[103,2224,2225,2227,2229,2232,2235,2237],{"class":105,"line":1017},[103,2226,1745],{"class":109},[103,2228,1627],{"class":116},[103,2230,2231],{"class":109},").mock(",[103,2233,2234],{"class":431},"return_value",[103,2236,435],{"class":322},[103,2238,2239],{"class":109},"response)\n",[103,2241,2242,2244,2246,2248,2250,2252,2254,2257,2259,2261],{"class":105,"line":1023},[103,2243,1799],{"class":322},[103,2245,1782],{"class":109},[103,2247,130],{"class":129},[103,2249,133],{"class":109},[103,2251,1162],{"class":431},[103,2253,435],{"class":322},[103,2255,2256],{"class":129},"\"1.0.0\"",[103,2258,669],{"class":109},[103,2260,1046],{"class":322},[103,2262,600],{"class":116},[103,2264,2265],{"class":105,"line":1039},[103,2266,338],{"emptyLinePlaceholder":337},[103,2268,2269],{"class":105,"line":1053},[103,2270,338],{"emptyLinePlaceholder":337},[103,2272,2273],{"class":105,"line":1060},[103,2274,1730],{"class":424},[103,2276,2277,2279,2282],{"class":105,"line":1067},[103,2278,542],{"class":322},[103,2280,2281],{"class":424}," test_timeouts_are_silent",[103,2283,1740],{"class":109},[103,2285,2286,2288,2290,2292,2295,2297,2300,2303],{"class":105,"line":1078},[103,2287,1745],{"class":109},[103,2289,1627],{"class":116},[103,2291,2231],{"class":109},[103,2293,2294],{"class":431},"side_effect",[103,2296,435],{"class":322},[103,2298,2299],{"class":109},"httpx.ConnectTimeout(",[103,2301,2302],{"class":129},"\"slow\"",[103,2304,1772],{"class":109},[103,2306,2307,2309,2311,2313,2315,2317,2319,2321,2323,2325],{"class":105,"line":1085},[103,2308,1799],{"class":322},[103,2310,1782],{"class":109},[103,2312,130],{"class":129},[103,2314,133],{"class":109},[103,2316,1162],{"class":431},[103,2318,435],{"class":322},[103,2320,2256],{"class":129},[103,2322,669],{"class":109},[103,2324,1046],{"class":322},[103,2326,600],{"class":116},[103,2328,2329],{"class":105,"line":1092},[103,2330,338],{"emptyLinePlaceholder":337},[103,2332,2333],{"class":105,"line":1107},[103,2334,338],{"emptyLinePlaceholder":337},[103,2336,2337,2339,2342],{"class":105,"line":1172},[103,2338,542],{"class":322},[103,2340,2341],{"class":424}," test_not_installed_is_silent",[103,2343,1740],{"class":109},[103,2345,2346,2348,2350,2353,2355,2357],{"class":105,"line":1179},[103,2347,1799],{"class":322},[103,2349,1782],{"class":109},[103,2351,2352],{"class":129},"\"definitely-not-installed-xyz\"",[103,2354,669],{"class":109},[103,2356,1046],{"class":322},[103,2358,600],{"class":116},[10,2360,2361,2362,33],{},"The parametrised test is the important one: proxies and captive portals return all sorts of things, and each must end in silence rather than a traceback. For broader HTTP testing patterns, see ",[24,2363,2365],{"href":2364},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fmocking-http-in-cli-tests-with-respx\u002F","mocking HTTP in CLI tests with respx",[35,2367,2369],{"id":2368},"conclusion","Conclusion",[10,2371,2372,2373,2376],{},"Checking PyPI for a newer version is one request, but a correct check filters yanked and file-less releases, applies a deliberate pre-release policy, compares with ",[19,2374,2375],{},"packaging.version",", and turns every failure into \"nothing to report\". Wrapped in a function that never raises, it is safe to call from anywhere — and ready for the caching and background-thread layer that keeps it from ever slowing a command down.",[35,2378,2380],{"id":2379},"frequently-asked-questions","Frequently asked questions",[1455,2382,2384,2385,2388],{"id":2383},"can-i-use-pip-index-versions-instead-of-the-json-api","Can I use ",[19,2386,2387],{},"pip index versions"," instead of the JSON API?",[10,2390,2391],{},"It works interactively but is marked experimental, spawns a whole pip process and its output format is not a stable interface. The JSON API is faster, structured and designed for programs.",[1455,2393,2395],{"id":2394},"is-it-acceptable-to-hit-pypi-from-every-installation","Is it acceptable to hit PyPI from every installation?",[10,2397,2398],{},"Yes, at a sensible rate. PyPI's JSON API is served from a CDN and used by many tools for exactly this. Cache the result for a day, send a descriptive User-Agent, and do not retry aggressively; that keeps the load trivial.",[1455,2400,2402,2403,2406],{"id":2401},"should-i-use-urllibrequest-to-avoid-the-httpx-dependency","Should I use ",[19,2404,2405],{},"urllib.request"," to avoid the httpx dependency?",[10,2408,2409,2410,1473,2413,2416],{},"If your CLI does not already depend on an HTTP client, ",[19,2411,2412],{},"urllib.request.urlopen(url, timeout=1.5)",[19,2414,2415],{},"json.load()"," works fine and keeps the install lighter; the parsing and comparison code does not change. Most CLIs that talk to APIs already have httpx, in which case reuse it.",[1455,2418,2420],{"id":2419},"how-do-i-handle-a-package-that-was-renamed","How do I handle a package that was renamed?",[10,2422,2423],{},"Check the new name, and for a transition period have the old package's final release print a one-time message pointing at the new one. The update check itself cannot follow renames, because PyPI has no redirect metadata for projects.",[1455,2425,2427],{"id":2426},"what-if-the-user-installed-from-a-git-url-or-a-local-wheel","What if the user installed from a Git URL or a local wheel?",[10,2429,2430,2431,2434,2435,2438,2439,2441,2442,2445,2446,2448,2449,2452],{},"Then the installed version may not exist on PyPI at all — a development build such as ",[19,2432,2433],{},"1.7.0.dev3+g1a2b3c"," or a fork with its own numbering. Local version labels (the part after ",[19,2436,2437],{},"+",") compare as newer than the plain release, so ",[19,2440,2433],{}," is correctly treated as older than ",[19,2443,2444],{},"1.7.0"," but newer than ",[19,2447,1403],{},". If your build process produces versions like that, consider skipping the check entirely when ",[19,2450,2451],{},"Version(current).local"," is set: someone running a custom build rarely wants to be told to install the public release.",[35,2454,2456],{"id":2455},"related","Related",[40,2458,2459,2465,2470,2476,2482],{},[43,2460,2461,2462],{},"Up: ",[24,2463,2464],{"href":26},"Update checks, upgrade commands and telemetry",[43,2466,2467],{},[24,2468,2469],{"href":31},"Showing non-blocking update notices",[43,2471,2472],{},[24,2473,2475],{"href":2474},"\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",[43,2477,2478],{},[24,2479,2481],{"href":2480},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fretries-and-backoff-for-cli-http-calls\u002F","Retries and backoff for CLI HTTP calls",[43,2483,2484],{},[24,2485,2487],{"href":2486},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools\u002F","Semantic versioning policy for CLI tools",[2489,2490,2491],"style",{},"html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}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 .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 .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 .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .s4XuR, html code.shiki .s4XuR{--shiki-default:#E36209;--shiki-dark:#FFAB70}",{"title":99,"searchDepth":113,"depth":113,"links":2493},[2494,2495,2496,2499,2500,2501,2502,2511],{"id":37,"depth":113,"text":38},{"id":81,"depth":113,"text":82},{"id":303,"depth":113,"text":304,"children":2497},[2498],{"id":1457,"depth":157,"text":1458},{"id":1492,"depth":113,"text":1493},{"id":1563,"depth":113,"text":1564},{"id":2368,"depth":113,"text":2369},{"id":2379,"depth":113,"text":2380,"children":2503},[2504,2506,2507,2509,2510],{"id":2383,"depth":157,"text":2505},"Can I use pip index versions instead of the JSON API?",{"id":2394,"depth":157,"text":2395},{"id":2401,"depth":157,"text":2508},"Should I use urllib.request to avoid the httpx dependency?",{"id":2419,"depth":157,"text":2420},{"id":2426,"depth":157,"text":2427},{"id":2455,"depth":113,"text":2456},"2026-10-02","Query the PyPI JSON API for the latest release of a CLI, skip yanked and pre-release versions, compare with packaging.version, and test it with respx.","intermediate",false,"md",{},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version",{"title":5,"description":2513},"cli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis\u002Fchecking-pypi-for-a-newer-version\u002Findex",[2522,2523,48,52,1480],"pypi","updates","EbmDFevZ7KHp84O3B3W97zBcK_i2iQc6JLyJPPAveBU",[2526,2529,2532,2535,2538,2541,2544,2547,2550,2553,2556,2559,2562,2565,2568,2571,2574,2577,2580,2583,2586,2589,2592,2595,2598,2601,2604,2607,2610,2613,2616,2619,2622,2625,2628,2631,2634,2637,2640,2643,2646,2649,2652,2655,2658,2661,2664,2667,2670,2673,2676,2679,2682,2685,2688,2691,2694,2697,2700,2703,2706,2709,2712,2715,2718,2721,2724,2727,2730,2733,2736,2739,2742,2745,2748,2751,2754,2757,2760,2763,2766,2769,2772,2775,2778,2781,2784,2787,2790,2793,2796,2799,2802,2805,2808,2811,2814,2817,2820,2823,2826,2829,2832,2835,2838,2841,2844,2847,2850,2853,2856,2859,2862,2865,2868,2871,2874,2877,2880,2883,2886,2889,2892,2895,2898,2901,2904,2907,2910,2913,2916,2919,2922,2925,2928,2929,2932,2935,2938,2941,2943,2946,2949,2952,2955,2958,2961,2964,2967,2970,2973,2976,2979,2982,2985,2988,2991,2994,2997,3000,3003,3006,3009,3012,3015,3018,3021,3024,3027,3030,3033,3036,3039,3042,3045,3048,3051,3054,3057,3060,3063,3066,3069,3072,3075,3078,3081,3084,3087,3090,3093,3096,3099,3102,3105,3108,3111,3114,3117,3120,3123,3126,3129,3132,3135,3138,3141,3144,3147,3150,3153,3156,3159,3162,3165,3168,3171,3174,3177,3180,3183,3186,3189,3192,3195,3198,3201,3204,3207,3210,3213,3216,3219,3222,3225,3228,3231,3234,3237,3240,3243,3246,3249,3252,3255,3258,3261,3264,3267,3270,3273,3276,3279,3282,3285,3288,3291,3294,3297,3300,3303,3306,3309,3312,3315,3318,3321,3324,3327,3330,3333,3336,3339,3342,3345,3348,3351,3354,3357,3360,3363,3366],{"path":2527,"title":2528},"\u002Fabout","About Python CLI Toolcraft",{"path":2530,"title":2531},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies","Advanced Argument Validation Strategies",{"path":2533,"title":2534},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fparsing-nested-json-arguments-in-python-clis","Parsing Nested JSON Args in Python CLIs",{"path":2536,"title":2537},"\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":2539,"title":2540},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-dependent-and-conflicting-options","Validating Dependent and Conflicting CLI Options",{"path":2542,"title":2543},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-file-and-directory-paths-in-clis","Validating File and Directory Paths in CLIs",{"path":2545,"title":2546},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fvalidating-urls-hosts-and-ports","Validating URLs, Hosts and Ports in Python CLI Arguments",{"path":2548,"title":2549},"\u002Fadvanced-input-parsing-user-experience\u002Fadvanced-argument-validation-strategies\u002Fwriting-custom-click-parameter-types","Writing Custom Click Parameter Types",{"path":2551,"title":2552},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fbrowsing-records-with-a-textual-datatable","Browsing Records with a Textual DataTable Picker",{"path":2554,"title":2555},"\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":2557,"title":2558},"\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":2560,"title":2561},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual","Building Terminal UIs with Textual for Python CLIs",{"path":2563,"title":2564},"\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":2566,"title":2567},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Fstyling-textual-apps-with-tcss","Styling Textual Apps with TCSS",{"path":2569,"title":2570},"\u002Fadvanced-input-parsing-user-experience\u002Fbuilding-terminal-uis-with-textual\u002Ftesting-textual-apps-with-pilot","Testing Textual Apps with Pilot",{"path":2572,"title":2573},"\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":2575,"title":2576},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fdocumenting-environment-variables-in-help","Documenting Environment Variables in CLI Help",{"path":2578,"title":2579},"\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":2581,"title":2582},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation","CLI Help Output and Documentation",{"path":2584,"title":2585},"\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":2587,"title":2588},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fversioning-and-deprecating-cli-flags","Versioning and Deprecating CLI Flags",{"path":2590,"title":2591},"\u002Fadvanced-input-parsing-user-experience\u002Fcli-help-output-and-documentation\u002Fwriting-help-text-users-actually-read","Writing Help Text Users Actually Read",{"path":2593,"title":2594},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fadapting-output-to-terminal-width","Adapting Python CLI Output to Terminal Width",{"path":2596,"title":2597},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fdetecting-ci-environments-and-non-interactive-shells","Detecting CI Environments and Non-Interactive Shells",{"path":2599,"title":2600},"\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":2602,"title":2603},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility\u002Fhandling-ansi-escape-codes-on-windows-consoles","Handling ANSI Escape Codes on Windows Consoles",{"path":2605,"title":2606},"\u002Fadvanced-input-parsing-user-experience\u002Fcross-platform-terminal-compatibility","Cross-Platform Terminal Compatibility for Python CLIs",{"path":2608,"title":2609},"\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":2611,"title":2612},"\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":2614,"title":2615},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fchoosing-exit-codes-for-cli-tools","Choosing Exit Codes for CLI Tools",{"path":2617,"title":2618},"\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":2620,"title":2621},"\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":2623,"title":2624},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Ffriendly-error-messages-and-tracebacks","Friendly Error Messages and Tracebacks",{"path":2626,"title":2627},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fhandling-keyboard-interrupt-cleanly","Handling Keyboard Interrupt Cleanly",{"path":2629,"title":2630},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes","Error Handling and Exit Codes for CLIs",{"path":2632,"title":2633},"\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":2635,"title":2636},"\u002Fadvanced-input-parsing-user-experience\u002Ferror-handling-and-exit-codes\u002Fwriting-crash-reports-users-can-send","Writing Crash Reports Users Can Send",{"path":2638,"title":2639},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Fconfig-precedence-flags-env-files-defaults","Config Precedence: Flags, Env, Files, Defaults",{"path":2641,"title":2642},"\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":2644,"title":2645},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars","Handling Config Files and Env Vars in CLIs",{"path":2647,"title":2648},"\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":2650,"title":2651},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Freading-toml-config-with-tomllib","Reading TOML Config with tomllib in Python CLIs",{"path":2653,"title":2654},"\u002Fadvanced-input-parsing-user-experience\u002Fhandling-configuration-files-env-vars\u002Ftyped-settings-with-pydantic-settings","Typed Settings with pydantic-settings in Python CLIs",{"path":2656,"title":2657},"\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":2659,"title":2660},"\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":2662,"title":2663},"\u002Fadvanced-input-parsing-user-experience","Advanced Input Parsing for Python CLIs",{"path":2665,"title":2666},"\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":2668,"title":2669},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Fbuilding-interactive-prompts-and-menus","Building Interactive Prompts and Menus in Python CLIs",{"path":2671,"title":2672},"\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":2674,"title":2675},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich","Interactive Terminal UI with Rich",{"path":2677,"title":2678},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Flive-dashboards-with-rich-live","Live Dashboards with Rich Live in Python CLIs",{"path":2680,"title":2681},"\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":2683,"title":2684},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Frendering-tables-and-json-with-rich","Rendering Tables and JSON with Rich",{"path":2686,"title":2687},"\u002Fadvanced-input-parsing-user-experience\u002Finteractive-terminal-ui-with-rich\u002Ftheming-rich-output-consistently","Theming Rich Output Consistently in Python CLIs",{"path":2689,"title":2690},"\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":2692,"title":2693},"\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":2695,"title":2696},"\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":2698,"title":2699},"\u002Fadvanced-input-parsing-user-experience\u002Foutput-formats-for-data-clis","Output Formats for Data-Heavy Python CLIs",{"path":2701,"title":2702},"\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":2704,"title":2705},"\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":2707,"title":2708},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fargcomplete-for-argparse-clis","Tab Completion for argparse CLIs with argcomplete",{"path":2710,"title":2711},"\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":2713,"title":2714},"\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":2716,"title":2717},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis","Shell Completion for Python CLIs",{"path":2719,"title":2720},"\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":2722,"title":2723},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Fshipping-completion-scripts-with-packages","Shipping Shell Completion Scripts with a Python CLI",{"path":2725,"title":2726},"\u002Fadvanced-input-parsing-user-experience\u002Fshell-completion-for-python-clis\u002Ftesting-shell-completion-in-python-clis","Testing Shell Completion in Python CLIs",{"path":2728,"title":2729},"\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":2731,"title":2732},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fadding-verbose-and-quiet-logging-flags","Adding Verbose and Quiet Logging Flags",{"path":2734,"title":2735},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps","Structured Logging for CLI Apps",{"path":2737,"title":2738},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Flogging-with-structlog-in-a-cli","Logging with structlog in a Python CLI",{"path":2740,"title":2741},"\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":2743,"title":2744},"\u002Fadvanced-input-parsing-user-experience\u002Fstructured-logging-for-cli-apps\u002Fstructured-json-logging-in-python-clis","Structured JSON Logging in Python CLIs",{"path":2746,"title":2747},"\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":2749,"title":2750},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fdetecting-tty-and-adapting-output","Detecting a TTY and Adapting Output",{"path":2752,"title":2753},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Femitting-json-output-for-scripting","Emitting JSON Output for Scripting",{"path":2755,"title":2756},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Fhandling-broken-pipe-and-sigpipe","Handling Broken Pipe and SIGPIPE",{"path":2758,"title":2759},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes","Working with stdin, stdout and Pipes",{"path":2761,"title":2762},"\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":2764,"title":2765},"\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":2767,"title":2768},"\u002Fadvanced-input-parsing-user-experience\u002Fworking-with-stdin-stdout-and-pipes\u002Freading-piped-input-in-python-clis","Reading Piped Input in Python CLIs",{"path":2770,"title":2771},"\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":2773,"title":2774},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fdownloading-files-with-progress-in-python","Downloading Files with Progress in Python CLIs",{"path":2776,"title":2777},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis","Calling HTTP APIs from Python CLIs",{"path":2779,"title":2780},"\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":2782,"title":2783},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Foauth-device-flow-login-for-clis","OAuth Device Flow Login for Python CLIs",{"path":2785,"title":2786},"\u002Fcli-runtime-systems-integration\u002Fcalling-http-apis-from-python-clis\u002Fpaginating-api-results-in-a-cli","Paginating API Results in a Python CLI",{"path":2788,"title":2789},"\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":2791,"title":2792},"\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":2794,"title":2795},"\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":2797,"title":2798},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis","Concurrency and Async in Python CLIs",{"path":2800,"title":2801},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fmultiprocessing-for-cpu-bound-cli-tasks","Multiprocessing for CPU-Bound CLI Tasks",{"path":2803,"title":2804},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fparallelising-cli-work-with-thread-pools","Parallelising CLI Work with Thread Pools",{"path":2806,"title":2807},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Frate-limiting-concurrent-requests-in-clis","Rate-Limiting Concurrent Requests in Python CLIs",{"path":2809,"title":2810},"\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":2812,"title":2813},"\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":2815,"title":2816},"\u002Fcli-runtime-systems-integration\u002Fconcurrency-and-async-in-python-clis\u002Fstructured-concurrency-with-taskgroups-in-clis","Structured Concurrency with TaskGroups in Python CLIs",{"path":2818,"title":2819},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fcross-platform-paths-with-pathlib","Cross-Platform Paths with pathlib in CLIs",{"path":2821,"title":2822},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Ffile-locking-for-concurrent-cli-runs","File Locking for Concurrent CLI Runs in Python",{"path":2824,"title":2825},"\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":2827,"title":2828},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes","Filesystem Paths and Atomic Writes for CLIs",{"path":2830,"title":2831},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fsafe-temporary-files-and-directories","Safe Temporary Files and Directories in CLIs",{"path":2833,"title":2834},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fstoring-app-data-with-platformdirs","Storing CLI App Data with platformdirs",{"path":2836,"title":2837},"\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":2839,"title":2840},"\u002Fcli-runtime-systems-integration\u002Ffilesystem-paths-and-atomic-writes\u002Fwriting-files-atomically-in-python-clis","Writing Files Atomically in Python CLIs",{"path":2842,"title":2843},"\u002Fcli-runtime-systems-integration","CLI Runtime & Systems Integration for Python",{"path":2845,"title":2846},"\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":2848,"title":2849},"\u002Fcli-runtime-systems-integration\u002Flocal-state-and-sqlite-in-python-clis","Local State and SQLite in Python CLIs",{"path":2851,"title":2852},"\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":2854,"title":2855},"\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":2857,"title":2858},"\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":2860,"title":2861},"\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":2863,"title":2864},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Fhandling-sigterm-and-graceful-shutdown","Handling SIGTERM and Graceful Shutdown in CLIs",{"path":2866,"title":2867},"\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":2869,"title":2870},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis","Long-Running and Watch-Mode Python CLIs",{"path":2872,"title":2873},"\u002Fcli-runtime-systems-integration\u002Flong-running-and-watch-mode-clis\u002Freloading-config-on-sighup","Reloading Configuration on SIGHUP in a Python CLI",{"path":2875,"title":2876},"\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":2878,"title":2879},"\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":2881,"title":2882},"\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":2884,"title":2885},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Favoiding-shell-injection-in-python-clis","Avoiding Shell Injection in Python CLIs",{"path":2887,"title":2888},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fcalling-external-commands-safely-with-subprocess","Calling External Commands Safely with subprocess",{"path":2890,"title":2891},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fhandling-subprocess-timeouts-and-exit-codes","Handling Subprocess Timeouts and Exit Codes",{"path":2893,"title":2894},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis","Running Subprocesses from Python CLIs",{"path":2896,"title":2897},"\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":2899,"title":2900},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fpiping-between-subprocesses-in-python","Piping Between Subprocesses in Python Without a Shell",{"path":2902,"title":2903},"\u002Fcli-runtime-systems-integration\u002Frunning-subprocesses-from-python-clis\u002Fstreaming-subprocess-output-in-real-time","Streaming Subprocess Output in Real Time",{"path":2905,"title":2906},"\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":2908,"title":2909},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis","Secrets and Credentials in Python CLIs",{"path":2911,"title":2912},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fprompting-for-passwords-securely","Prompting for Passwords Securely in Python CLIs",{"path":2914,"title":2915},"\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":2917,"title":2918},"\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":2920,"title":2921},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Frefreshing-expired-tokens-automatically","Refreshing Expired Tokens Automatically in a Python CLI",{"path":2923,"title":2924},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fstoring-tokens-with-keyring","Storing CLI Tokens Securely with keyring",{"path":2926,"title":2927},"\u002Fcli-runtime-systems-integration\u002Fsecrets-and-credentials-in-python-clis\u002Fsupporting-multiple-profiles-and-accounts","Supporting Multiple Profiles and Accounts in CLIs",{"path":2518,"title":5},{"path":2930,"title":2931},"\u002Fcli-runtime-systems-integration\u002Fupdate-checks-and-self-updating-clis","Update Checks, Upgrade Commands and Telemetry for Python CLIs",{"path":2933,"title":2934},"\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":2936,"title":2937},"\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":2939,"title":2940},"\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":1157,"title":2942},"Python CLI Toolcraft",{"path":2944,"title":2945},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cleo","Building a Python CLI with Cleo Command Classes",{"path":2947,"title":2948},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fbuilding-a-cli-with-cyclopts","Building a Type-Hinted Python CLI with Cyclopts",{"path":2950,"title":2951},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks","Beyond Click and Typer: Alternative Python CLI Frameworks",{"path":2953,"title":2954},"\u002Fmodern-python-cli-frameworks-architecture\u002Falternative-python-cli-frameworks\u002Fquick-clis-from-functions-with-python-fire","Quick CLIs from Functions with Python Fire",{"path":2956,"title":2957},"\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":2959,"title":2960},"\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":2962,"title":2963},"\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":2965,"title":2966},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fguarding-startup-with-import-tests","Guarding CLI Startup with Import Tests",{"path":2968,"title":2969},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading","CLI Startup Performance and Lazy Loading",{"path":2971,"title":2972},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Flazy-loading-subcommands-for-faster-startup","Lazy Loading Subcommands for Faster Startup",{"path":2974,"title":2975},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Fprofiling-python-cli-startup-time","Profiling Python CLI Startup Time",{"path":2977,"title":2978},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcli-startup-performance-and-lazy-loading\u002Freducing-cli-dependency-weight","Reducing CLI Dependency Weight",{"path":2980,"title":2981},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-subparsers-for-subcommands","argparse Subparsers for Subcommands",{"path":2983,"title":2984},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fargparse-vs-click-vs-typer-comparison","argparse vs Click vs Typer Compared",{"path":2986,"title":2987},"\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":2989,"title":2990},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse","Command-Line Parsing with argparse",{"path":2992,"title":2993},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmigrating-from-argparse-to-typer","Migrating from argparse to Typer",{"path":2995,"title":2996},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fmutually-exclusive-options-in-argparse","Mutually Exclusive Options in argparse",{"path":2998,"title":2999},"\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":3001,"title":3002},"\u002Fmodern-python-cli-frameworks-architecture\u002Fcommand-line-parsing-with-argparse\u002Fwriting-custom-argparse-actions","Writing Custom argparse Actions in Python",{"path":3004,"title":3005},"\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":3007,"title":3008},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fdesigning-idempotent-commands","Designing Idempotent Commands in a Python CLI",{"path":3010,"title":3011},"\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":3013,"title":3014},"\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":3016,"title":3017},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions","Designing CLI Interfaces and Conventions in Python",{"path":3019,"title":3020},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fnaming-commands-and-flags-consistently","Naming Commands and Flags Consistently in Python CLIs",{"path":3022,"title":3023},"\u002Fmodern-python-cli-frameworks-architecture\u002Fdesigning-cli-interfaces-and-conventions\u002Fpositional-arguments-vs-options","Positional Arguments vs Options: Designing a CLI Signature",{"path":3025,"title":3026},"\u002Fmodern-python-cli-frameworks-architecture","Python CLI Frameworks and Architecture",{"path":3028,"title":3029},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fdiscovering-plugins-with-entry-points","Discovering Plugins with Entry Points in Python CLIs",{"path":3031,"title":3032},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fhook-based-plugins-with-pluggy","Hook-Based Plugins for Python CLIs with pluggy",{"path":3034,"title":3035},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis","Plugin Architectures for Extensible CLIs",{"path":3037,"title":3038},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fisolating-plugin-failures","Isolating Plugin Failures in an Extensible Python CLI",{"path":3040,"title":3041},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Ftesting-plugins-against-the-host-cli","Testing Plugins Against the Host CLI",{"path":3043,"title":3044},"\u002Fmodern-python-cli-frameworks-architecture\u002Fplugin-architectures-for-extensible-clis\u002Fversioning-a-plugin-api","Versioning a Plugin API for a Python CLI",{"path":3046,"title":3047},"\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":3049,"title":3050},"\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":3052,"title":3053},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fdependency-injection-patterns-for-cli-commands","Dependency Injection Patterns for CLI Commands",{"path":3055,"title":3056},"\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":3058,"title":3059},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis","Structuring Multi-Command Python CLIs",{"path":3061,"title":3062},"\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":3064,"title":3065},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fregistering-commands-from-modules-automatically","Registering CLI Commands from Modules Automatically",{"path":3067,"title":3068},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-common-options-across-commands","Sharing Common Options Across Python CLI Commands",{"path":3070,"title":3071},"\u002Fmodern-python-cli-frameworks-architecture\u002Fstructuring-multi-command-python-clis\u002Fsharing-state-with-click-context-objects","Sharing State with Click Context Objects",{"path":3073,"title":3074},"\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":3076,"title":3077},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications","Testing Python CLI Applications",{"path":3079,"title":3080},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fmeasuring-cli-test-coverage","Measuring CLI Test Coverage",{"path":3082,"title":3083},"\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":3085,"title":3086},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fproperty-based-testing-cli-arguments-with-hypothesis","Property-Based Testing CLI Arguments with Hypothesis",{"path":3088,"title":3089},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Fsnapshot-testing-cli-output","Snapshot Testing CLI Output",{"path":3091,"title":3092},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-click-commands-with-clirunner","Testing Click Commands with CliRunner",{"path":3094,"title":3095},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-commands-that-call-subprocesses","Testing Python CLI Commands That Call Subprocesses",{"path":3097,"title":3098},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftesting-interactive-prompts-and-stdin","Testing Interactive Prompts and stdin",{"path":3100,"title":3101},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftesting-python-cli-applications\u002Ftranscript-tests-for-cli-commands","Transcript Tests for Python CLI Commands",{"path":3103,"title":3104},"\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":3106,"title":3107},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fbuilding-dynamic-commands-in-click","Building Dynamic Commands in Click",{"path":3109,"title":3110},"\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":3112,"title":3113},"\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":3115,"title":3116},"\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":3118,"title":3119},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each","Typer vs Click: When to Use Each",{"path":3121,"title":3122},"\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":3124,"title":3125},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Ftyper-callback-functions-explained","Typer callback functions explained",{"path":3127,"title":3128},"\u002Fmodern-python-cli-frameworks-architecture\u002Ftyper-vs-click-when-to-use-each\u002Fusing-annotated-options-in-typer","Using Annotated Options in Typer",{"path":3130,"title":3131},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fautomating-releases-from-git-tags","Automating Python CLI Releases from Git Tags",{"path":3133,"title":3134},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis\u002Fcaching-uv-dependencies-in-ci","Caching uv Dependencies in CI for Python CLIs",{"path":3136,"title":3137},"\u002Fproject-setup-dependency-management\u002Fci-cd-pipelines-for-python-clis","CI\u002FCD Pipelines for Python CLIs",{"path":3139,"title":3140},"\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":3142,"title":3143},"\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":3145,"title":3146},"\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":3148,"title":3149},"\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":3151,"title":3152},"\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":3154,"title":3155},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fbuilding-a-cookiecutter-template-for-typer-clis","Building a Cookiecutter Template for Typer CLIs",{"path":3157,"title":3158},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fcopier-vs-cookiecutter-for-cli-templates","Copier vs Cookiecutter for CLI Templates",{"path":3160,"title":3161},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter","CLI Project Scaffolding with Cookiecutter",{"path":3163,"title":3164},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fpost-generation-hooks-in-cli-templates","Post-Generation Hooks in Python CLI Templates",{"path":3166,"title":3167},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftemplate-variables-and-conditional-files","Template Variables and Conditional Files in CLI Templates",{"path":3169,"title":3170},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Ftesting-a-project-template-with-pytest","Testing a CLI Project Template with pytest",{"path":3172,"title":3173},"\u002Fproject-setup-dependency-management\u002Fcli-project-scaffolding-with-cookiecutter\u002Fupdating-generated-projects-with-copier-update","Updating Generated CLI Projects with copier update",{"path":3175,"title":3176},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbuilding-cross-platform-release-binaries-in-ci","Building Cross-Platform Release Binaries in CI",{"path":3178,"title":3179},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fbundling-a-python-cli-with-pyinstaller","Bundling a Python CLI with PyInstaller",{"path":3181,"title":3182},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fcode-signing-and-notarizing-cli-binaries","Code Signing and Notarizing Python CLI Binaries",{"path":3184,"title":3185},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fhomebrew-and-scoop-packaging-for-python-clis","Homebrew and Scoop Packaging for Python CLIs",{"path":3187,"title":3188},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries","Distributing CLIs as Standalone Binaries",{"path":3190,"title":3191},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Fnuitka-vs-pyinstaller-for-python-clis","Nuitka vs PyInstaller for Python CLI Binaries",{"path":3193,"title":3194},"\u002Fproject-setup-dependency-management\u002Fdistributing-clis-as-standalone-binaries\u002Freducing-pyinstaller-binary-size","Reducing the Size of a PyInstaller CLI Binary",{"path":3196,"title":3197},"\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":3199,"title":3200},"\u002Fproject-setup-dependency-management","Project Setup & Dependency Management",{"path":3202,"title":3203},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code\u002Fconfiguring-ruff-for-a-cli-project","Configuring Ruff for a Python CLI Project",{"path":3205,"title":3206},"\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":3208,"title":3209},"\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":3211,"title":3212},"\u002Fproject-setup-dependency-management\u002Flinting-and-type-checking-cli-code","Linting and Type-Checking Python CLI Code",{"path":3214,"title":3215},"\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":3217,"title":3218},"\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":3220,"title":3221},"\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":3223,"title":3224},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fautomating-changelogs-with-conventional-commits","Automating Changelogs with Conventional Commits",{"path":3226,"title":3227},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fbumping-versions-consistently-across-a-cli-project","Bumping Versions Consistently Across a Python CLI Project",{"path":3229,"title":3230},"\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":3232,"title":3233},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fexposing-version-info-and-build-metadata","Exposing Version Info and Build Metadata",{"path":3235,"title":3236},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs","Managing CLI Versioning & Changelogs",{"path":3238,"title":3239},"\u002Fproject-setup-dependency-management\u002Fmanaging-cli-versioning-changelogs\u002Fsemantic-versioning-policy-for-cli-tools","A Semantic Versioning Policy for CLI Tools",{"path":3241,"title":3242},"\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":3244,"title":3245},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbuilding-wheels-and-sdists-for-python-clis","Building Wheels and sdists for Python CLIs",{"path":3247,"title":3248},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fbundling-data-files-with-importlib-resources","Bundling Data Files with importlib.resources in CLIs",{"path":3250,"title":3251},"\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":3253,"title":3254},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution","Packaging Python CLIs for Distribution",{"path":3256,"title":3257},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Finstalling-and-distributing-clis-with-pipx","Installing and Distributing CLIs with pipx",{"path":3259,"title":3260},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Foptional-dependencies-and-extras-for-clis","Optional Dependencies and Extras for Python CLIs",{"path":3262,"title":3263},"\u002Fproject-setup-dependency-management\u002Fpackaging-python-clis-for-distribution\u002Fpublishing-a-python-cli-to-pypi","Publishing a Python CLI to PyPI",{"path":3265,"title":3266},"\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":3268,"title":3269},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fdynamic-versioning-with-poetry-plugins","Dynamic Versioning for a Poetry CLI from Git Tags",{"path":3271,"title":3272},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development","Poetry Workflows for CLI Development",{"path":3274,"title":3275},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fmanaging-poetry-lock-files-for-cli-tools","Managing Poetry Lock Files for CLI Tools",{"path":3277,"title":3278},"\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":3280,"title":3281},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-dependency-groups-for-cli-tooling","Poetry Dependency Groups for CLI Tooling",{"path":3283,"title":3284},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpoetry-entry-points-and-scripts-for-clis","Poetry Entry Points and Scripts for CLIs",{"path":3286,"title":3287},"\u002Fproject-setup-dependency-management\u002Fpoetry-workflows-for-cli-development\u002Fpublishing-a-cli-with-poetry","Building and Publishing a Python CLI with Poetry",{"path":3289,"title":3290},"\u002Fproject-setup-dependency-management\u002Fpre-commit-hooks-for-cli-projects","Pre-commit Hooks for CLI Projects",{"path":3292,"title":3293},"\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":3295,"title":3296},"\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":3298,"title":3299},"\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":3301,"title":3302},"\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":3304,"title":3305},"\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":3307,"title":3308},"\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":3310,"title":3311},"\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":3313,"title":3314},"\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":3316,"title":3317},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain","Securing the Supply Chain of a Python CLI",{"path":3319,"title":3320},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpinning-dependencies-with-hashes","Pinning a Python CLI’s Dependencies with Hashes",{"path":3322,"title":3323},"\u002Fproject-setup-dependency-management\u002Fsecuring-a-python-cli-supply-chain\u002Fpublishing-attestations-and-verifying-releases","Publishing Attestations and Verifying Python CLI Releases",{"path":3325,"title":3326},"\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":3328,"title":3329},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management","uv for Python CLI Dependency Management",{"path":3331,"title":3332},"\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":3334,"title":3335},"\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":3337,"title":3338},"\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":3340,"title":3341},"\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":3343,"title":3344},"\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":3346,"title":3347},"\u002Fproject-setup-dependency-management\u002Fuv-for-python-cli-dependency-management\u002Fuv-workspaces-for-multi-package-clis","uv Workspaces for Multi-Package Python CLIs",{"path":3349,"title":3350},"\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":3352,"title":3353},"\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":3355,"title":3356},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices","Python CLI Env Isolation Best Practices",{"path":3358,"title":3359},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fisolating-cli-tools-from-project-dependencies","Isolating CLI Tools from Your Project’s Dependencies",{"path":3361,"title":3362},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fmanaging-virtual-environments-for-cross-platform-clis","Managing Python CLI Virtual Environments",{"path":3364,"title":3365},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fpinning-the-python-version-for-a-cli","Pinning the Python Version for a CLI",{"path":3367,"title":3368},"\u002Fproject-setup-dependency-management\u002Fvirtual-environments-isolation-best-practices\u002Fsupporting-multiple-python-versions-with-nox","Supporting Multiple Python Versions with nox",1790967540134]