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.0.tar.gz
(77.9 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 557d4b44f62a69ef20ba18fd5d85a367277a91d815233a1d5ef00ac004512a72 |
|
MD5 | 21721e73fe209cf8a775e559ecf1a1f4 |
|
BLAKE2b-256 | 786f73ded517a82d6c74727a25464bdd5f7c23d573e1dd23742efd2ed67f7704 |
Close
Hashes for robotframework_tidy-4.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb4aa540a556690b3f6acc45a161e8c0fdfc3b5aa4579c3b06a888c3581e847b |
|
MD5 | e88694e983b862a3b7103d024f6ab24f |
|
BLAKE2b-256 | 19811241fc1600e9b506a603c55bbefbd13b49bb70598803dce10cc018db789e |