Repository files navigation

Robot Framework is a generic open sourceautomation framework for acceptance testing, acceptance test drivendevelopment (ATDD), and robotic process automation (RPA). It has simple plaintext syntax and it can be extended easily with libraries implemented usingPython or Java.

Robot Framework is operating system and application independent. The coreframework is implemented usingPython, supports bothPython 2.7 and Python 3.5+, and runs also onJython (JVM),IronPython (.NET) andPyPy.The framework has a rich ecosystem around it consisting of various genericlibraries and tools that are developed as separate projects. For moreinformation about Robot Framework and the ecosystem, seehttp://robotframework.org.

Robot Framework project is hosted onGitHub where you can find source code,an issue tracker, and some further documentation. SeeCONTRIBUTING.rstif you are interested to contribute. Downloads are hosted onPyPI, exceptfor the standalone JAR distribution that is onMaven central.

Robot Framework development is sponsored byRobot Framework Foundation.

If you already havePython withpip installed,you can simply run:

pip install robotframework

Alternatively you can get Robot Framework source code by downloading the sourcedistribution fromPyPI and extracting it, or by cloning the project repositoryfromGitHub. 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, seeINSTALL.rst.

Below is a simple example test case for testing login to some system.You can find more examples with links to related demo projects fromhttp://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

Tests (or tasks) are executed from the command line using therobotcommand or by executing therobot module directly likepython -m robotorjython -m robot.

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

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

Additionally there is therebot tool for combining results and otherwisepost-processing outputs:

rebot --name Example output1.xml output2.xml

Runrobot --help andrebot --help for more information about the commandline usage. For a complete reference manual seeRobot Framework User Guide.

• Robot Framework User Guide
• Standard libraries
• Built-in tools
• API documentation
• General documentation and demos

• robotframework-users mailing list
• Slack community
• #robotframeworkIRC channel on freenode
• @robotframework on Twitter
• Other forums

Interested to contribute to Robot Framework? Great! In that case it is a goodstart by looking at theContribution guidelines. If youdo not already have an issue you would like to work on, you can checkissues withgood new issue andhelp wanted labels.

Remember also that there are many other tools and libraries in the widerRobot Framework ecosystem that you cancontribute to!

Robot Framework is open source software provided under theApache License2.0. Robot Framework documentation and other similar content use theCreative Commons Attribution 3.0 Unported license. Most libraries and toolsin the ecosystem are also open source, but they may use different licenses.