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