This documentation describes the public API of Robot Framework. Installation, basic usage and wealth of other topics are covered by the Robot Framework User Guide.
Main API entry points are documented here, but the lower level implementation details are not always that well documented. If the documentation is insufficient, it is possible to view the source code by clicking [source] link in the documentation. In case viewing the source is not helpful either, questions may be sent to the robotframework-users mailing list.
Command line entry points are implemented as Python modules and they also provide programmatic APIs. Following entry points exist:
- :py
robot.runentry point for executing tests.- :py
robot.rebotentry point for post-processing outputs (Rebot).- :py
robot.libdocentry point for Libdoc tool.- :py
robot.testdocentry point for Testdoc tool.
See built-in tool documentation for more details about Rebot, Libdoc, and Testdoc tools.
robot.api
All :pyrobot packages are listed below. Typically you should not need to import anything from them directly, but the above public APIs may return objects implemented in them.
autodoc/robot autodoc/robot.api autodoc/robot.conf autodoc/robot.htmldata autodoc/robot.libdocpkg autodoc/robot.libraries autodoc/robot.model autodoc/robot.output autodoc/robot.parsing autodoc/robot.reporting autodoc/robot.result autodoc/robot.running autodoc/robot.utils autodoc/robot.variables
genindexmodindexsearch