pandasheets 0.3.1

Lightweight wrapper around gspread that simplifies tasks like downloading, uploading, and appending data from Google Sheets using Pandas.

pandasheets

pandasheets is a convenient wrapper around gspread that simplifies common operations such as downloading, uploading, and appending, when working with Google Sheets using pandas.

Getting Started

To use pandasheets, you need to set up a Google Cloud service account credential that grants your code access to manage spreadsheets. Below are the steps to create and configure these credentials:

1. Enable API access for your project

1. Go to the Google Cloud Console.
2. From the left-hand navigation menu, select APIs & Services.
3. Click Enable APIs & Services, then Create project if you don’t already have one.
4. Provide a Project name and Location, then click Create.

2. Create a Service Account Credential

1. Under APIs & Services, click Credentials.
2. Select Create credentials and choose Service account.
3. Fill out the required fields (e.g., name, description).
4. Copy the generated email address (it ends with iam.gserviceaccount.com, e.g., [e-mail]).
5. Click Create and continue.
6. Assign a suitable Role for the service account.
7. Finalize the creation process.

3. Generate the JSON key

1. On the Service Accounts page, locate the service account you just created.
2. Click on it to view the details.
3. In the top menu, select Keys.
4. Click Add key > Create new key > JSON > Create.
5. A JSON file will be downloaded. Store it in a secure location.

4. Enable the Google Sheets API

1. Return to APIs & Services in the Google Cloud Console.
2. Click Enable APIs and services.
3. Search for and select Google Sheets API.
4. Click Enable.

5. Enable the Google Drive API

Repeat the process from Step 4 to enable the Google Drive API.

6. Share your spreadsheet

Finally, open the Google Sheet you want to access and click Share. Enter the service account email you copied in Step 2, and grant appropriate permissions (e.g., Editor). Click Done.

Important: Make sure the service account email has permission to access the spreadsheet and that both the Google Sheets API and the Google Drive API are enabled in your project.

Installation

pip install pandasheets

Usage

Instantiate once with the path to your JSON key

import pandasheets as ps
PS = ps.pandasheets(credential="path/to/credential.json")

Downloading a sheet from Google Sheets into a DataFrame

# Define the sheet name, spreadsheet name

sheet = "mySheet" # sheet to be downloaded and loaded as a DataFrame
spreadsheet = "mySpreadsheet" # Name of the spreadsheet containing the sheet

# Download the sheet and load it as a DataFrame
df = PS.get_sheet_to_dataframe(
    sheet=sheet,
    spreadsheet=spreadsheet,
)

Uploading a DataFrame to a new sheet

# Define your DataFrame, target sheet, spreadsheet name, and credential file

df = myDf # DataFrame to be uploaded
sheet = "mySheet" # Target sheet name for the upload
spreadsheet = "mySpreadsheet" # Name of the spreadsheet where the sheet will be created

PS.upload_dataframe_to_spreadsheet(
    df=df,
    sheet=sheet,
    spreadsheet=spreadsheet,
)

By default, the DataFrame will be uploaded formatted as:

• Bold header
• All cells in columns A to Z are set to clip text wrapping
• The first row is frozen to keep the headers visible during scrolling.

If you wish to avoid the default formatting, call the function with the formatting parameter set to False:

PS.upload_dataframe_to_spreadsheet(
    df=df,
    sheet=sheet,
    spreadsheet=spreadsheet,
    formatting=False
)

By default, if a sheet with the same name already exists in the specified spreadsheet, a ValueError will be raised, as a new sheet will not be created. If you intend to overwrite the content of an existing sheet, set the parameter overwrite to True

PS.upload_dataframe_to_spreadsheet(
    df=df,
    sheet=sheet,
    spreadsheet=spreadsheet,
    formatting=False,
    overwrite=True
)

Important: All the content of the existing sheet will be overwritten if overwrite=True. If you only intend to append new values, use append_dataframe_to_sheet as shown below.

Appending a DataFrame to an existing sheet

# Create a sample DataFrame to be appended
df_to_append = pd.DataFrame({
    "column_A": ["A1", "A2", "A3"],
    "column_B": ["B1", "B2", "B3"],
})

sheet = "mySheet" # Sheet name to which the data will be appended
spreadsheet = "mySpreadsheet" # Spreadsheet name where the sheet exists

PS.append_dataframe_to_sheet(
    df=df_to_append,
    sheet=sheet,
    spreadsheet=spreadsheet,
)

Important: Only values for existing columns in the sheet are appended. Missing values in the DataFrame (present in the sheet) are set as empty strings. Duplicate values are not appended by default.

If duplicate values are acceptable and you would like to append them, set the duplicates parameter to True:

PS.append_dataframe_to_sheet(
    df=df,
    sheet=sheet,
    spreadsheet=spreadsheet,
    duplicates=True
)