Metadata-Version: 2.1
Name: rf-decoderlibrary
Version: 0.1.1a1
Summary: Test Library for Decoding Encoded Data.
Home-page: https://github.com/MainSystemDev
Author: Joshua Kim Rivera
Author-email: joshua.rivera@mnltechnology.com
License: Type license() to see the full license text
Platform: any
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Description-Content-Type: text/markdown
Requires-Dist: certifi (==2019.11.28)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: idna (==2.8)
Requires-Dist: Pillow (==6.2.0)
Requires-Dist: pypng (==0.0.20)
Requires-Dist: PyQRCode (==1.2.1)
Requires-Dist: pyzbar (==0.1.8)
Requires-Dist: requests (==2.22.0)
Requires-Dist: robotframework (==3.1.2)
Requires-Dist: robotlibcore-temp (==1.0.2)
Requires-Dist: urllib3 (==1.25.7)

DecoderLibrary
================

Version = __0.1.1a9__  
Library Scope: __GLOBAL__  
Created: __12/20/2019 14:46 UTC-8__  


Author: __Joshua Kim Rivera | email:joshua.rivera@mnltechnology.com__

Company: [__Spiralworks Technologies Inc.__](http://www.spiralwrks.com/)

##### Contents:
- [DecoderLibrary](#googlesheetslibrary)
    - [Contents](#contents)
    - [Introduction](#introduction)
    - [Installation](#installation)
    - [Usage](#usage)
    - [Generating Documentation](#generating-documentation)
    - [Dependencies](#dependencies)


### Introduction
**DecoderLibrary** is a [Robotframework](https://www.robotframework.org) Test Library for interfacing tests with 
Google Sheets using __Google Sheets API v4__.  
![PyPI](https://img.shields.io/pypi/v/rf-googlesheetslibrary?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dd/rf-googlesheetslibrary?style=for-the-badge)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/rf-googlesheetslibrary?style=for-the-badge)

View the latest keyword [Documentation here.](https://mainsystemdev.github.io/GoogleSheetsLibrary/)

### Installation
**Option 1**  
Install using pypi, run:
```bash
pip install rf-decoderlibrary
```

### Usage
To use DecoderLibrary in Robot Framework tests, the library needs to
first be imported using the `Library` setting as any other library.

```robotframework
*** 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:
```bash
python -m robot.libdoc DecoderLibrary documentation.html
```
Note that the library must first be installed before generating a documentation.


### Dependencies
* [Requests](https://pypi.org/project/requests/)


