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.5.0.tar.gz
(32.0 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-1.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60107a1242fad26303e04716404b806b14ad0b966427f7d072354e26228af5d9 |
|
MD5 | 0572493645f67d2cd27f3345c749c7ce |
|
BLAKE2b-256 | 123c40bd3ca847a6ef4a3bbbc2f07269e796b12bda4f57f253280421fc548ff3 |
Close
Hashes for robotframework_tidy-1.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f062bb4481680d9cef28f5ea6d831bc3060dcb37b86f34d880a51514725031e0 |
|
MD5 | 91ab1e997a1fd441db41cbddabe4ceba |
|
BLAKE2b-256 | e9d02f0cf47976e81b74e0ff1950a28f6d2602dfa8fc2956398ee43fc69df638 |