gspreadsheet 0.4.0

A wrapper around a wrapper to get Google spreadsheets to look like DictReader

A wrapper around a wrapper to get Google spreadsheets to look like csv.DictReader.

If you’re used to working with CSVs or a human, you’ll find that working with Google’s Python API for spreadsheets is so frustrating. With gspreadsheet, you can adapt your existing csv code to work with Google Spreadsheets with just two line changes. As an added bonus, if you alter the dict, those changes get saved back to the original spreadsheet.

Installation

pip install gspreadsheet

Usage

If your old CSV code looked like this:

from csv import DictReader
reader = DictReader(open('myspreadsheet.csv'))
for row in reader:
    process(row)

It would look like this with gspreadsheet:

from gspreadsheet import GSpreadsheet
reader = GSpreadsheet("https://docs.google.com/myspreadsheet")
for row in reader:
    process(row)

So looking at more examples…

Get a spreadsheet if you know the key and worksheet:

sheet = GSpreadsheet(key='tuTazWC8sZ_r0cddKj8qfFg', worksheet="od6")

Get a spreadsheet if you just know the url:

sheet = GSpreadsheet(url="https://docs.google.com/spreadsheet/"
                         "ccc?key=0AqSs84LBQ21-dFZfblMwUlBPOVpFSmpLd3FGVmFtRVE")

Since just knowing the url is the most common use case, specifying it as a kwarg is optional. Just pass whatever url is in your browser as the first argument.:

sheet = GSpreadsheet("https://docs.google.com/spreadsheet/"
                     "ccc?key=0AqSs84LBQ21-dFZfblMwUlBPOVpFSmpLd3FGVmFtRVE")

Get the JSON representation of the spreadsheet:

sheet.to_JSON()

Authenticating

Get a spreadsheet as a certain user:

sheet = GSpreadsheet(email="[e-mail]", password="12345",
                     key='tuTazWC8sZ_r0cddKj8qfFg', worksheet="od6")

You can also specify the email and password using environment variables: GOOGLE_ACCOUNT_EMAIL and GOOGLE_ACCOUNT_PASSWORD.

And as an authenticated user, you can modify the spreadsheet.:

for row in sheet:
    print row
    if row['deleteme']:
        row.delete()  # delete the row from the worksheet
        continue
    row['hash'] = md5(row['name']).hexdigest()  # compute the hash and save it back

data = row.copy()   # get the last row as a plain dict
sheet.add_row(data)  # copy the last row and append it back to the sheet

Advanced Usage: Saving data back to the spreadsheet

If you modify the dict that represents a row, those changes will get pushed back to the spreadsheet:

>>> row['value']
'foo'
>>> row['value'] = 'bar'  # Change this value
>>> row['value']
'bar'

Advanced Usage: Deferring Saves

If you do multiple changes to a row, the script can get very slow because it has to make a syncronous request back to the server with every change. To avoid this, you can turn on deferred saves by setting deferred_save=True when instantiating a GSpreadsheet. Just remember to .save():

sheet = GSpreadsheet(email="[e-mail]", password="12345",
                     key='tuTazWC8sZ_r0cddKj8qfFg', worksheet="od6",
                     deferred_save=True)

row = sheet.next()
for key in row.keys():
    row['key'] = ''
row.save()

Scary Warnings

I really want to say this is alpha software, but we’ve been using bits and pieces of this for over a year now. Everything is subject to change, even the names. This also relies on google’s relatively ancient gdata package, which does not have support for Python 3.

Changelog

• v0.4.0 - Added .to_JSON method. Added tox coverage.

Similar Python packages

• gspread