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 -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.9.0.tar.gz
(78.0 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bffb592ba18f573975457fed43dc51b8d33fa298efffb63ef0a8203f7b2790cf |
|
MD5 | 1be9d02932dc5503c9a5a9bc29aaf5af |
|
BLAKE2b-256 | b7d82a6171697533f2ce9f18489452e56e4f2b4e6688c89b4d2b2b4a3556f468 |
Close
Hashes for robotframework_tidy-4.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eebc6663cc7246059bc2fec501f33ca782e9e19b01a8c1b50a50778d31765d6d |
|
MD5 | bc8cbc0c86261de7c75654c051cc67c3 |
|
BLAKE2b-256 | c928c5ddb123792e9cfc8831a7274476ac9dca77ffd98ce7c69393ca3f68ea69 |