Robotframework-Excel

Version License Status PyVersion

build Coverage Quality Status

Introduction

Robotframework-excel is a Robot Framework Library that provides keywords to allow opening, reading, writing and saving Excel files.

Requirements

  • Python >= 2.7 | Python >= 3.3

  • Robot Framework >= 3.0

  • xlutils 2.0.0. Access the downloads here, or use pip install xlutils.

  • xlrd that reads data from an Excel file

  • xlwt that can write to an Excel file.

  • openpyxl 1.0.2

  • natsort 5.2.0. Access the downloads here, or use pip install natsort.

  • enum34 1.1.6

Installation

The recommended installation tool is pip.

Install pip. Enter the following (Append --upgrade to update both the library and all its dependencies to the latest version):

pip install robotframework-excel --upgrade

To install a specific version enter:

pip install robotframework-excel==(version)

Uninstall

To uninstall Robotframework-excel use the following pip command:

pip uninstall robotframework-excel

Project structure

  • ExcelRobot/base.py: The Robot Python Library defines excel operation keyword.

  • tests/unit/*.py: Unit test

  • tests/acceptance/ExcelRobotTest.robot: Example robot test file to display what various keywords from Robotframework-excel accomplish

  • docs/ExcelRobot.html: Keyword documentation for the Robotframework-excel.

Usage

To write tests with Robot Framework and Robotframework-excel, ExcelRobot must be imported into your Robot test suite. See Robot Framework User Guide for more information.

Running the Demo

The test file ExcelRobotTest.robot, is an easily executable test for Robot Framework using Robotframework-excel.

For in depth detail on how the keywords function, read the Keyword documentation found here : Keyword Documentation

Open a command prompt within the tests/acceptance folder and run:

pybot ExcelRobotTest.robot -d "./out"

Limitation

  • Lack DataType is CURRENCY and PERCENTAGE

  • Not yet optimize performance when saving Excel file after modifying itself

Contribution

The user group for Robot Framework is the best place to get help. Include in the post:

  • Contact the Python-Excel google group

  • Full description of what you are trying to do and expected outcome

  • Version number of Robotframework-excel and Robot Framework

  • Traceback or other debug output containing error information