GSpreadPlus
GSpreadPlus
Documentation
Introduction

Why GSpreadPlus?

Build on top of gspread, this module provides greater and more powerful functions to your application.

This module also aims to reduce the calls your application makes to Google Spreadsheet API v4 (Sheet API)

Sheet API has a request limit of up to 100 request per 100 seconds or basically 1req/s. If you are talking about larger scale applications, there's no way this will work.

This module obviously doesn't magically reduce calls. Instead it provides the ease to cache updates before regularly actually updating it.

If you have the slightest idea of adding any ne features, please do message me on Discord @Fishball_Noodles#7209


Usage
Getting Started
Installing Module

Install using pip by going to Command Prompt or Terminal and type

pip3 install GSpreadPlus

Importing into Code
from GSpreadPlus import Spreadclient
Setting Up Instance
instance = Spreadclient("creds.json")

The credentials file has to be in the same directory as the running program.


Connecting to Spreadsheet Document
Connecting by Key
instance.connect_document("3CFViFTEGkuhGz8ylhgpo6NoRi-QG35p3X8jmAdguaB8",method="key")

This key can be found in the url of the Google spreadsheet


Connecting by URL
instance.connect_document("https://docs.google.com/spreadsheets/d/3CFViFTEGkuhGz8ylhgpo6NoRi-QG35p3X8jmAdguaB8/",method="url")

Full URLs are also supported


Connecting by Name (Not Recommended)
instance.connect_document("Birthday List",method="name")

Name of the Spreadsheet Document can be ambiguous as the Spreadsheet Client can also see other people's document (if given access) with probably the same name

This is not to be confused with the name of the sheet but rather the name of the Spreadsheet Document

Connecting to Sheet (within Document)

It is worth mentioning that the sheets that can be accessed at this point are the ones inside the document connected in the previous step.

To connect to another sheet in another document, either create another instance or do instance.connect_document with the identifier of the new document again