From fb7fa11a78a8e1b6cb1c3f1edeb41a53deb267e0 Mon Sep 17 00:00:00 2001 From: Alexandre Lavigne Date: Mon, 19 Aug 2024 21:45:09 +0200 Subject: [PATCH 1/3] doc: moved community based link to dedicated page Created a new page dedicated to community projects. Add a new community project based on gspread in this section. Signed-off-by: Alexandre Lavigne --- docs/community.rst | 23 +++++++++++++++++++++++ docs/index.rst | 8 ++++++++ docs/user-guide.rst | 7 ++----- 3 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 docs/community.rst diff --git a/docs/community.rst b/docs/community.rst new file mode 100644 index 000000000..07e687b66 --- /dev/null +++ b/docs/community.rst @@ -0,0 +1,23 @@ +Community Extensions +==================== + +.. _gspread-formating-label: + +gspread-formating +~~~~~~~~~~~~~~~~~ + +`gspread-formatting `_ offers extensive functionality to help you when you go beyond basic format +provided by ``gspread``. + + +.. _gspread-pandas-label: + +Using gspread with pandas +~~~~~~~~~~~~~~~~~~~~~~~~~ + +You can find the bellow libraries to use gsrpead with pandas: + + * `gspread-pandas `_ + * `gspread-dataframe `_ + +.. _gspread-orm-label: diff --git a/docs/index.rst b/docs/index.rst index 9485e31cf..809d41e64 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -70,6 +70,14 @@ Advanced advanced +Community extensions +-------------------- + +.. toctree:: + :maxdepth: 2 + + community + API Documentation --------------------------- diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 97879e84e..8a00e1fb0 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -390,7 +390,7 @@ Color the background of **A2:B2** cell range in black, change horizontal alignme The second argument to :meth:`~gspread.models.Worksheet.format` is a dictionary containing the fields to update. A full specification of format options is available at `CellFormat `_ in Sheet API Reference. .. Tip:: - `gspread-formatting `_ offers extensive functionality to help you when you go beyond basics. + for more complex formating see :ref:`gspread-formating-label`. Using gspread with pandas @@ -412,10 +412,7 @@ Here's a basic example for writing a dataframe to a sheet. With :meth:`~gspread. worksheet.update([dataframe.columns.values.tolist()] + dataframe.values.tolist()) -For advanced pandas use cases check out these libraries: - - * `gspread-pandas `_ - * `gspread-dataframe `_ +For advanced pandas use cases check out community section :ref:`gspread-pandas-label` Using gspread with NumPy ~~~~~~~~~~~~~~~~~~~~~~~~ From f2a5b27d1b67b0a1b006c5aa7cff55e83f52d4cc Mon Sep 17 00:00:00 2001 From: MJ Rossetti Date: Mon, 20 May 2024 18:11:43 -0400 Subject: [PATCH 2/3] Add link to ORM package --- docs/advanced.rst | 11 +++++++++++ docs/community.rst | 2 +- docs/user-guide.rst | 2 +- 3 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index 414a0b6ee..1a815b7bd 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -69,3 +69,14 @@ Using ``Authlib`` instead of ``google-auth``. Similar to `google.auth.transport. # Fetch a cell range cell_list = wks.range('A1:B7') + + + + +Object Relational Mappers (ORMs) +--------------------- + +gspread-models +~~~~~~~~~~~~~~~~~~~ + +The `gspread-models ` package provides a straightforward and intuitive model-based query interface, making it easy to interact with Google Sheets as if it were more like a database. diff --git a/docs/community.rst b/docs/community.rst index 07e687b66..2214dc4a8 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -15,7 +15,7 @@ provided by ``gspread``. Using gspread with pandas ~~~~~~~~~~~~~~~~~~~~~~~~~ -You can find the bellow libraries to use gsrpead with pandas: +You can find the below libraries to use gsrpead with pandas: * `gspread-pandas `_ * `gspread-dataframe `_ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 8a00e1fb0..cc4599656 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -390,7 +390,7 @@ Color the background of **A2:B2** cell range in black, change horizontal alignme The second argument to :meth:`~gspread.models.Worksheet.format` is a dictionary containing the fields to update. A full specification of format options is available at `CellFormat `_ in Sheet API Reference. .. Tip:: - for more complex formating see :ref:`gspread-formating-label`. + for more complex formatting see :ref:`gspread-formating-label`. Using gspread with pandas From 944418adf7c681bf6b1e86aec8503a598d684480 Mon Sep 17 00:00:00 2001 From: Alexandre Lavigne Date: Mon, 19 Aug 2024 21:48:28 +0200 Subject: [PATCH 3/3] doc: Add gspread-models community based package Add short description + link to gspread-model package. Signed-off-by: Alexandre Lavigne --- docs/advanced.rst | 11 ----------- docs/community.rst | 7 +++++++ 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/advanced.rst b/docs/advanced.rst index 1a815b7bd..414a0b6ee 100644 --- a/docs/advanced.rst +++ b/docs/advanced.rst @@ -69,14 +69,3 @@ Using ``Authlib`` instead of ``google-auth``. Similar to `google.auth.transport. # Fetch a cell range cell_list = wks.range('A1:B7') - - - - -Object Relational Mappers (ORMs) ---------------------- - -gspread-models -~~~~~~~~~~~~~~~~~~~ - -The `gspread-models ` package provides a straightforward and intuitive model-based query interface, making it easy to interact with Google Sheets as if it were more like a database. diff --git a/docs/community.rst b/docs/community.rst index 2214dc4a8..fb06af910 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -21,3 +21,10 @@ You can find the below libraries to use gsrpead with pandas: * `gspread-dataframe `_ .. _gspread-orm-label: + +Object Relational Mappers (ORMs) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The `gspread-models `_ package provides a straightforward and intuitive model-based +query interface, making it easy to interact with Google Sheets as if it were more like a database. +