Skip to main content

Generic automation framework for acceptance testing and robotic process automation (RPA)

Project description

Introduction

Robot Framework is a generic open source automation framework for acceptance testing, acceptance test driven development (ATDD), and robotic process automation (RPA). It has simple plain text syntax and it can be extended easily with libraries implemented using Python or Java.

Robot Framework is operating system and application independent. The core framework is implemented using Python, supports both Python 2.7 and Python 3.5+, and runs also on Jython (JVM), IronPython (.NET) and PyPy. The framework has a rich ecosystem around it consisting of various generic libraries and tools that are developed as separate projects. For more information about Robot Framework and the ecosystem, see http://robotframework.org.

Robot Framework project is hosted on GitHub where you can find source code, an issue tracker, and some further documentation. See CONTRIBUTING.rst if you are interested to contribute. Downloads are hosted on PyPI, except for the standalone JAR distribution that is on Maven central.

Robot Framework development is sponsored by Robot Framework Foundation.

Latest version License

Installation

If you already have Python with pip installed, you can simply run:

pip install robotframework

Alternatively you can get Robot Framework source code by downloading the source distribution from PyPI and extracting it, or by cloning the project repository from GitHub. After that you can install the framework with:

python setup.py install

For more detailed installation instructions, including installing Python, Jython, IronPython and PyPy or installing from git, see INSTALL.rst.

Example

Below is a simple example test case for testing login to some system. You can find more examples with links to related demo projects from http://robotframework.org.

*** Settings ***
Documentation     A test suite with a single test for valid login.
...
...               This test has a workflow that is created using keywords in
...               the imported resource file.
Resource          resource.robot

*** Test Cases ***
Valid Login
    Open Browser To Login Page
    Input Username    demo
    Input Password    mode
    Submit Credentials
    Welcome Page Should Be Open
    [Teardown]    Close Browser

Usage

Tests (or tasks) are executed from the command line using the robot command or by executing the robot module directly like python -m robot or jython -m robot.

The basic usage is giving a path to a test (or task) file or directory as an argument with possible command line options before the path:

robot tests.robot
robot --variable BROWSER:Firefox --outputdir results path/to/tests/

Additionally there is the rebot tool for combining results and otherwise post-processing outputs:

rebot --name Example output1.xml output2.xml

Run robot --help and rebot --help for more information about the command line usage. For a complete reference manual see Robot Framework User Guide.

Documentation

Support and contact

Contributing

Interested to contribute to Robot Framework? Great! In that case it is a good start by looking at the Contribution guidelines. If you do not already have an issue you would like to work on, you can check issues with good new issue and help wanted labels.

Remember also that there are many other tools and libraries in the wider Robot Framework ecosystem that you can contribute to!

License

Robot Framework is open source software provided under the Apache License 2.0. Robot Framework documentation and other similar content use the Creative Commons Attribution 3.0 Unported license. Most libraries and tools in the ecosystem are also open source, but they may use different licenses.

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 Distribution

robotframework-4.0a1.zip (665.9 kB view details)

Uploaded Source

Built Distribution

robotframework-4.0a1-py2.py3-none-any.whl (630.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file robotframework-4.0a1.zip.

File metadata

  • Download URL: robotframework-4.0a1.zip
  • Upload date:
  • Size: 665.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for robotframework-4.0a1.zip
Algorithm Hash digest
SHA256 eaf299e026265b2466b79fbe28011702fe25f5957199ecd789ff62cf452f3c52
MD5 87fb42eb42d38cf48019c059deff7005
BLAKE2b-256 328386c36569c558a4a352025d7fe4844eeb62e0f85689f7f56edda358865583

See more details on using hashes here.

File details

Details for the file robotframework-4.0a1-py2.py3-none-any.whl.

File metadata

  • Download URL: robotframework-4.0a1-py2.py3-none-any.whl
  • Upload date:
  • Size: 630.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for robotframework-4.0a1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a77816c747c89ecaf64231eb8d5721780e2d7424268146f5ab63e1739b17e20d
MD5 218990610c76b759b25b8010298ba00d
BLAKE2b-256 a356975a2b35045c304e8c494f206aba0bd5e3d5de534144b3feb4d8069aaf16

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page