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-3.0b1.tar.gz
(193.5 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-3.0b1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fae1d6d552cb6e471e3aca683fabc6fa47411cfb79fddd309ad2f2036f97ed7b |
|
MD5 | 73cf917dcc2e0e397106c7483b6928ff |
|
BLAKE2b-256 | 0457e74fee0c1770212f15187b5a05a015b205405662291938b0a6572ef3f81b |
Close
Hashes for robotframework_tidy-3.0b1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4388b930c0b25e0639cb22e5bcc2e298512f97acd6c3803d8e467c4ab5fccde1 |
|
MD5 | 390feb4f7220fef840c0b4e69b4cacfb |
|
BLAKE2b-256 | 5b88aa9dfd95fc72015c6cd80aaecbe03c425efa3875ff045db3a423a6d8b3f4 |