Test Library for interfacing tests with Google Sheets API v4
Project description
GoogleSheetsLibrary
Library Scope: GLOBAL
Created: 12/20/2019 14:46 UTC-8
Author: Joshua Kim Rivera | email:joshua.rivera@mnltechnology.com
Company: Spiralworks Technologies Inc.
Contents:
Introduction
GoogleSheetsLibrary is a Robotframework Test Library for interfacing tests with
Google Sheets using Google Sheets API v4.
View the latest keyword Documentation here.
Installation
Option 1
Install using pypi, run:
pip install rf-googlesheetslibrary
Option 2
With recent version of pip
, it is possible to install directly from GitHub repository. To Install latest source
from the master branch, use this command:
pip install git+https://github.com/MainSystemDev/GoogleSheetsLibrary.git
Please note that installation will take some time, because pip
will
clone the GoogleSheetsLibrary project to a temporary directory and then
perform the installation.
Usage
To use GoogleSheetsLibrary in Robot Framework tests, the library needs to
first be imported using the Library
setting as any other library.
*** Settings ***
Documentation Simple example using GoogleSheetsLibrary
Library GoogleSheetsLibrary
... scopes=['https://www.googleapis.com/auth/spreadsheets']
Library Collections
# Initialize the connection to the spreadsheet.
Suite Setup Initialize Spreadsheet
... spreadsheetId=sampleSpreadsheetId
... tokenFile=path/to/token.pickle
*** Variables ***
@{sample_range} Sheet!A1:E Sheet1!A1:E2
@{row_1} sample string
... written using
... googlesheets api v4
@{row_2} hello world
... i am using
... googlesheets api v4
@{values} ${row_1} ${row_2}
&{body} values=${values}
*** Test Cases ***
Sample Fetch Data
[Documentation] Fetch data from the initialized sheet.
${single_range_data} Fetch Single Range range_name=Sheet!A1:E1
Log To Console ${single_range_data}
${multiple_range_data} Fetch Multiple Range ranges=${sample_range}
Log To Console ${multiple_range_data}
Sample Write Data
[Documentation] Writes data to the initialized sheet.
${response} Write To Range range_name=Sheet!A3:E4
... body=${body}
Log To Console ${response}
Sample Data Append
[Documentation] Append Data to the sheet.
${append_response} Append Values range_name=Sheet1
... body=${body}
Log To Console ${append_response}
Generating Documentation
To Generate the keyword Documentation, simple run:
python -m robot.libdoc GoogleSheetsLibrary documentation.html
Note that the library must first be installed before generating a documentation.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for rf_googlesheetslibrary-0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d32e20144329e15781d57467ff5ced805b609542fae6ff287fdbf37b288449ca |
|
MD5 | 6613adc63aba322ea5158f56b1ccfdcc |
|
BLAKE2b-256 | 922a845da63ae3d090dc09606a9dc976e4ab01118323e5c7a84b16de47d81d5e |