Documentation and packaging

Author: s4int

CSVLibrary/version.py

@@ -0,0 +1 @@
+VERSION = '0.0.1'

Examples/CSVExampleTest.robot

@@ -0,0 +1,19 @@
+*** Settings ***
+Documentation    CSV examples for Robot Framework.
+Library         Collections
+Library         CSVLibrary
+
+*** Variables ***
+# Example data generated with: https://www.mockaroo.com/
+@{template_list}=   1  Douglas  Morris  [email protected]  Male  205.4.212.229
+&{template_dict}=   id=1  first_name=Douglas  last_name=Morris  [email protected]  gender=Male  ip_address=205.4.212.229
+
+
+*** Test Cases ***
+Read csv file to a list example test
+    @{list}=  read csv file to list  ${CURDIR}${/}data.csv
+    lists should be equal  ${template_list}  ${list[1]}
+
+Read csv file to a dict example test
+    @{dict}=    read csv file to associative  ${CURDIR}${/}data.csv
+    dictionaries should be equal  ${template_dict}  ${dict[0]}

Examples/data.csv

@@ -0,0 +1,11 @@
+id,first_name,last_name,email,gender,ip_address
+1,Douglas,Morris,[email protected],Male,205.4.212.229
+2,Stephanie,Oliver,[email protected],Female,18.101.154.106
+3,Russell,Castillo,[email protected],Male,255.52.95.46
+4,Helen,Reed,[email protected],Female,167.55.67.109
+5,Jesse,Wagner,[email protected],Male,252.37.62.215
+6,Ashley,Diaz,[email protected],Female,79.87.105.139
+7,Rachel,Robinson,[email protected],Female,132.66.117.101
+8,Phillip,Johnston,[email protected],Male,70.152.55.21
+9,Craig,Burton,[email protected],Male,73.117.157.82
+10,Patrick,Fisher,[email protected],Male,2.36.191.97

README.md

@@ -0,0 +1,41 @@
+# Robot Framework CSVLibrary
+## Introduction
+CSVLibrary is a [Robot Framework](http://robotframework.org/) library for handling csv files.
+
+More information about this library can be found in the [Keyword Documentation](https://rawgit.com/s4int/robotframework-CSVLibrary/master/doc/CSVLibrary.html).
+
+## Installation
+### Using pip
+```bash
+      pip install -U robotframework-csvlibrary
+```
+
+### Manual installation
+1. Make sure you have [Robot Framework installed](http://code.google.com/p/robotframework/wiki/Installation).
+2. Download source distributions (`*.tar.gz`) for the library and its dependencies:
+      - https://pypi.python.org/pypi/robotframework-csvlibrary
+3. Extract each source distribution to a temporary location.
+4. Go each created directory from the command line and install each project using:
+
+```bash
+      python setup.py install
+```
+
+## Example
+
+Basic example:
+```robotframework
+*** Settings ***
+Library                     Collections
+Library                     CSVLibrary
+    
+*** Test Cases ***
+Read csv file to a list example test
+  @{list}=  read csv file to list  data.csv
+  Log  ${list[0]}
+  Log  ${list[1]}
+
+Read csv file to a dict example test
+  @{dict}=    read csv file to associative  data.csv
+  Log  &{dict[0]}[first_name]  &{dict[0]}[last_name]
+```