From 5cd130fe633127d198b894821a1bc3ca0248041d Mon Sep 17 00:00:00 2001 From: bensynapse <118375461+bensynapse@users.noreply.github.com> Date: Wed, 11 Nov 2026 17:05:19 +0200 Subject: [PATCH 1/3] Link the export formats guide from the README The docs site gains a page on the three formats and the six datasets. It also shows how to read the files in pandas, DuckDB and R, with tested examples. The README now links it from the file contents section and from the links list. The page is published from livetennisapi/openapi. The link works once that change is merged and the docs are published again. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 31d6845..0de6de4 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,8 @@ CSV and Parquet need flat columns, so nested objects become dotted column names Nothing is written until every page has arrived. A request that fails halfway leaves no half-written file. +The [export formats guide](https://docs.livetennisapi.com/export-formats.html) says when each format fits. It also shows how to read the files back in pandas, DuckDB and R. + ## Python ```python @@ -126,6 +128,7 @@ The tests never call the API. They run the real client against a mock transport - Live Tennis API: https://livetennisapi.com - Documentation: https://docs.livetennisapi.com +- Export formats guide: https://docs.livetennisapi.com/export-formats.html - OpenAPI spec: https://github.com/livetennisapi/openapi - Python client: https://github.com/livetennisapi/livetennisapi-python From 259f9d42335d81c55c53e88cbff8e913cb1d9865 Mon Sep 17 00:00:00 2001 From: bensynapse <118375461+bensynapse@users.noreply.github.com> Date: Wed, 11 Nov 2026 17:49:42 +0200 Subject: [PATCH 2/3] Correct the shell history claim in the README The README said the API key stays out of your shell history. The line above it sets the API key with an export command, which a shell can record. The README now says the API key is never part of the export command. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0de6de4..138aba0 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ You can get a free key at [livetennisapi.com/subscribe/free](https://livetennisa export LIVETENNISAPI_KEY=twjp_... ``` -The command reads the key from that variable only. There is no flag for it, so it stays out of your shell history. +The command reads the key from that variable only. There is no flag for it, so the key is never part of the export command. ## Command line From 1131846f94310e96ab2e8d5419a9bdd7deb758e2 Mon Sep 17 00:00:00 2001 From: bensynapse <118375461+bensynapse@users.noreply.github.com> Date: Wed, 11 Nov 2026 17:51:59 +0200 Subject: [PATCH 3/3] Correct the docstring's claim about shell history The module docstring said the API key stays out of shell history. That depends on how the user sets the variable. What holds is that it is not in the export command or its process arguments. --- src/livetennisapi_export/cli.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/livetennisapi_export/cli.py b/src/livetennisapi_export/cli.py index 712365d..0fe0eb4 100644 --- a/src/livetennisapi_export/cli.py +++ b/src/livetennisapi_export/cli.py @@ -5,7 +5,7 @@ livetennisapi-export player 101 202 -o players.jsonl The key is read from ``LIVETENNISAPI_KEY``. There is deliberately no flag for -it, so it never lands in shell history or a process list. +it, so the key is never part of the export command or its process arguments. """ from __future__ import annotations