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.8.1.tar.gz
(78.0 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.8.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16b7485a2deda0c39a83e50de4115f213feb75e8a9a6a59086d5928b4db13f8c |
|
MD5 | 6a6fa50f5595f9d0a18f39f45c822654 |
|
BLAKE2b-256 | 85ac0f0bd9573c829747a06a2268b858cb6e024ce2f0f587ab7b8f2343a43395 |
Close
Hashes for robotframework_tidy-4.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2c56305c326393bb3b26ee5a9e1241e8bc75045419a0a6a7bb4234311aec2f0 |
|
MD5 | 04b055fd5a73f6fa1c2d59d49da42258 |
|
BLAKE2b-256 | 641a5d4d01bc135b1d76744b24119d48d92549c6fd707256f86bd8a9fe358cc1 |