Code autoformatter for Robot Framework
Project description
Robotidy
Introduction
Robotidy is a tool for autoformatting Robot Framework code.
It is spiritual descendant of Robot Framework's internal robot.tidy package.
Documentation
Full documentation available here. :open_book:
Requirements
Python 3.8+ :snake: and Robot Framework 4.0.0+ :robot:.
Installation
You can install Robotidy simply by running:
pip install -U robotframework-tidy
Usage
Call robotidy with path(s) to file/directory with robot files:
robotidy tests
robotidy test.robot
robotidy tests/resources test.robot
All command line options can be displayed in help message by executing:
robotidy --help
See documentation for information how to configure robotidy.
Example
Ugly code before transforming with robotidy:
*** Settings ***
Force Tags tags tag2
Library Collections
Resource important.robot
Library MyCustomLibrary.py
Test Setup Setup Keyword
*** test case*
Test1
[ teardown] Teardown Keyword
Keyword
FOR ${var} IN RANGE 10
Run Keyword If ${var}>5 Other Keyword
END
*** Variables ***
${var}= 2
${bit_longer} 10
${var2} a
... b
*** Keywords ***
A lot prettier code after:
*** Settings ***
Library Collections
Library MyCustomLibrary.py
Resource important.robot
Test Setup Setup Keyword
Force Tags tags tag2
*** Variables ***
${var} 2
${bit_longer} 10
${var2} a
... b
*** Test Cases ***
Test1
Keyword
FOR ${var} IN RANGE 10
IF ${var}>5
Other Keyword
END
END
[Teardown] Teardown Keyword
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_tidy-4.14.0.tar.gz
(83.3 kB
view hashes)
Built Distribution
Close
Hashes for robotframework_tidy-4.14.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 70d40544b66579f36c4dfcee40942d28985f1003f2441ff502c997a3d7e2a2b7 |
|
MD5 | 5d6af1e79868da3dc562148cef619d54 |
|
BLAKE2b-256 | c5d1d15a27322558105d3df6c1c41a497fe57f1d75a1b00028e515d84cdc9d88 |
Close
Hashes for robotframework_tidy-4.14.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17fc46c9c77f7abdddf6f172901d94e1ac87b5f66990cc6849920a052331d90b |
|
MD5 | 074ab0dbd45d3ce61ab5831c90305199 |
|
BLAKE2b-256 | cc66d4b6917a947877b1b5ba36f184843832f77bcf816a0da845289897e94adc |