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 generic and custom libraries.

Robot Framework is operating system and application independent. It isimplemented usingPython which is also the primarylanguage to extend it. The framework has a rich ecosystem around it consistingof various generic libraries and tools that are developed as separate projects.For more information 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. Downloads are hosted onPyPI.

Robot Framework development is sponsored by non-profitRobot Framework Foundation. If you are using the frameworkand benefiting from it, consider joining the foundation to help maintainingthe framework and developing it further.

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

pip install robotframework

For more detailed installation instructions, including installing Python, seeINSTALL.rst.

Robot Framework requires Python 3.8 or newer and runs also onPyPy.The latest version that supports Python 3.6 and 3.7 isRobot Framework 6.1.1.If you need to use Python 2,Jython orIronPython, you can useRobot Framework 4.1.3.

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          login.resource*** 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 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
• API documentation
• General documentation

• Slack
• Forum
• robotframework-users mailing list

Interested to contribute to Robot Framework? Great! In that case it is a goodstart by looking at theCONTRIBUTING.rst. 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 License 2.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.

Robot Framework trademark is owned byRobot Framework Foundation.