Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Doc/community addons orm package #1506

Merged
merged 3 commits into from
Aug 21, 2024
Merged

Doc/community addons orm package #1506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fb7fa11
doc: moved community based link to dedicated page
lavigne958 Aug 19, 2024
f2a5b27
Add link to ORM package
s2t2 May 20, 2024
944418a
doc: Add gspread-models community based package
lavigne958 Aug 19, 2024
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
30 changes: 30 additions & 0 deletions docs/community.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Community Extensions
====================

.. _gspread-formating-label:

gspread-formating
~~~~~~~~~~~~~~~~~

`gspread-formatting <https://github.com/robin900/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 below libraries to use gsrpead with pandas:

* `gspread-pandas <https://github.com/aiguofer/gspread-pandas>`_
* `gspread-dataframe <https://github.com/robin900/gspread-dataframe>`_

.. _gspread-orm-label:

Object Relational Mappers (ORMs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The `gspread-models <https://github.com/s2t2/gspread-models-py>`_ 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.

8 changes: 8 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,14 @@ Advanced

advanced

Community extensions
--------------------

.. toctree::
:maxdepth: 2

community


API Documentation
---------------------------
Expand Down
7 changes: 2 additions & 5 deletions docs/user-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/cells#cellformat>`_ in Sheet API Reference.

.. Tip::
`gspread-formatting <https://github.com/robin900/gspread-formatting>`_ offers extensive functionality to help you when you go beyond basics.
for more complex formatting see :ref:`gspread-formating-label`.


Using gspread with pandas
Expand All @@ -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 <https://github.com/aiguofer/gspread-pandas>`_
* `gspread-dataframe <https://github.com/robin900/gspread-dataframe>`_
For advanced pandas use cases check out community section :ref:`gspread-pandas-label`

Using gspread with NumPy
~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down