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