Robot Framework ORG

Robot Framework
===============

.. contents::
:local:

Introduction
------------

Robot Framework _ |r| 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 generic and custom libraries.

Robot Framework is operating system and application independent. It is
implemented using Python _ which is also the primary
language to extend it. 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. Downloads are hosted on PyPI_.

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

.. _GitHub: https://github.com/robotframework/robotframework
.. _PyPI: https://pypi.python.org/pypi/robotframework

.. image:: https://img.shields.io/pypi/v/robotframework.svg?label=version
:target: https://pypi.python.org/pypi/robotframework
:alt: Latest version

.. image:: https://img.shields.io/pypi/l/robotframework.svg
:target: http://www.apache.org/licenses/LICENSE-2.0.html
:alt: License

Installation
------------

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

pip install robotframework

For more detailed installation instructions, including installing Python, see
`__.

Robot Framework requires Python 3.8 or newer and runs also on PyPy _.
The latest version that supports Python 3.6 and 3.7 is Robot Framework 6.1.1__.
If you need to use Python 2, Jython _ or
IronPython _, you can use Robot Framework 4.1.3__.

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

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

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

• Robot Framework User Guide

• Standard libraries

• API documentation _
• General documentation _

• Slack _
• Forum _
• robotframework-users

Interested to contribute to Robot Framework? Great! In that case it is a good
start by looking at the __. 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!

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.

Robot Framework trademark is owned by Robot Framework Foundation`_.

__ http://apache.org/licenses/LICENSE-2.0
__ http://creativecommons.org/licenses/by/3.0

.. |r| unicode:: U+00AE

Collapse