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