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