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.0.1.tar.gz
(73.9 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-4.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe31a81ddfc6df581a74f2e233add170b9762c7ba24b170e1ff9129b55177c2b |
|
MD5 | 79585c0c30efc1a721ebd49954ee3189 |
|
BLAKE2b-256 | 6f4cef20b25ffc316dc894c2663f5feeaccea060ca15ff5a2b2d2ee4b36d709e |
Close
Hashes for robotframework_tidy-4.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02c1534305357cb1ae09a6dfd322587d010c0325b185702173fef0370faf2678 |
|
MD5 | b75d5656c4756eec9f4202503e35a165 |
|
BLAKE2b-256 | 2962d0ed5e0a4824738043d16d689463075fe80d975848818cc6feb79d09d5d6 |