singlet.io.googleapi package

Submodules

singlet.io.googleapi.googleapi module

class singlet.io.googleapi.googleapi.GoogleAPI(spreadsheetId, spreadsheetname, client_id_filename, client_secret_filename)

Bases: object

MAX_COLUMN = 'AZ'

add_sheet(sheetname)

application_name = 'Google Sheet API to singlet'

static convert_A24_to_row_col(well)

convert_range_json_to_A1(r)

classmethod convert_row_col_to_A1(row, col)

static convert_row_col_to_A24(row, col)

delete_sheet(sheetname)

get_backgrounds(sheetname)

get_cell_property(sheetname, field_string, ranges=())

get_credentials()

Gets valid user credentials from storage.

If nothing has been stored, or if the stored credentials are invalid, the OAuth2 flow is completed to obtain the new credentials.

Returns:Credentials, the obtained credential.

get_data(sheetname, ranges=())

Get the whole sheet as a pandas dataframe

get_header_columns_indices(colnames, sheetname)

Get the indices of columns in A1 notation

get_last_column(sheetname)

get_named_ranges(sheetname=None, fmt='dict', convert=True)

get_sheet_id(sheetname)

get_sheet_shape(sheetname)

Get the data range of the sheet

get_sheetnames()

get_text_format(sheetname, prop, ranges=())

static hex_to_rgb(value)

Return (red, green, blue) for the color given as #rrggbb.

static rgb_to_hex(rgb)

Return color as #rrggbb for the given color values.

scopes = 'https://www.googleapis.com/auth/spreadsheets.readonly'

set_backgrounds(sheetname, bkgs, start_range=(0, 0))

set_cell_property(sheetname, field_string, data, start_range=(0, 0))

set_dimension_size(sheetname, dimension, pixel_size, dim_range=(None, None))

set_service()

set_sheet(sheetname, values)

set_text_format(sheetname, prop, fmts, start_range=(0, 0))

exception singlet.io.googleapi.googleapi.GoogleIOError

Bases: OSError

singlet.io.googleapi.samplesheet module

class singlet.io.googleapi.samplesheet.SampleSheet(sheet)

Bases: singlet.io.googleapi.googleapi.GoogleAPI

get_number_virus_reads(virus, icols=None)

Get the number of virus reads from the spreadsheet

get_table(fmt='pandas')

update_tsv_table(sheetname, sandbox=True)

Update TSV table from the Google Sheet

Module contents

singlet.io.googleapi.parse_samplesheet(sheet)