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