From 7e4feed98c3ffa6253cb482c11b7b60d8d773d65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E2=80=9Cantoineeripret=E2=80=9D?= Date: Fri, 10 Apr 2026 10:59:26 +0200 Subject: [PATCH] update get_all_records / to_records documentation --- docs/user-guide.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/user-guide.rst b/docs/user-guide.rst index bde76a04..8ac97ea7 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -227,10 +227,37 @@ Getting All Values From a Worksheet as a List of Lists Getting All Values From a Worksheet as a List of Dictionaries ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Using ``get_all_records()`` (assumes first row contains headers): + .. code:: python list_of_dicts = worksheet.get_all_records() +Alternatively, use ``gspread.utils.to_records()`` for more control over headers: + +.. code:: python + + # Define custom headers + headers = ["fruit", "alternate name", "tastiness"] + values = worksheet.get() + records = gspread.utils.to_records(headers, values) + + for record in records: + print(record) + # {'fruit': 'apple', 'alternate name': 'red circle', 'tastiness': 'very'} + # {'fruit': 'banana', 'alternate name': 'yellow stick', 'tastiness': 'quite'} + + +Loading Worksheet Data into a DataFrame +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**Using pandas (or polars):** + +.. code:: python + + records = worksheet.get_all_records() + df = pd.DataFrame(records) + Finding a Cell ~~~~~~~~~~~~~~