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.7+ :snake: and Robot Framework 4.0.0+ :robot:.
Installation
You can install Robotidy simply by running:
pip install 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
Example
Ugly 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-1.3.0.tar.gz
(29.9 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 056ccc5c8bf7e7acffe56b9c7cc3e7866ae15126ec6e41254bb80b3cf1a33d65 |
|
MD5 | c79024bf6942f4a6113a43d2996fe112 |
|
BLAKE2b-256 | 04246edab446fdacd1b4bd4095ac1c6e5e6be80d53943f796d4721b93fac06f5 |
Close
Hashes for robotframework_tidy-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 978670abac934e68dedb57913ad538ed27d65c0166f2e78dc5f991eebb683176 |
|
MD5 | d506400bc7b1f404c52731ce8217c57b |
|
BLAKE2b-256 | cf32fe45362f373b4d86c8df5eed0be4570efe4b849c7ae0a698886f075137ab |