Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/livetennisapi_export/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading