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
Built Distribution
Close
Hashes for robotframework-tidy-4.10.0a1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0b889a8169ff26df9aa4ed803b901ccceee03c21e585f1ff6097d00f67c5c6ba |
|
MD5 | 5ea34651e5d03ca9359b958e6acd3fcb |
|
BLAKE2b-256 | 68011b02368c8e8fd24ec68961f9ec1231722f784ec795f28cf5cc8de848903b |
Close
Hashes for robotframework_tidy-4.10.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 019af12358e8bf08fb35966ad96471113a957ae7eb842f61ce06f9961f49fd29 |
|
MD5 | 98de0fb1bc70c87e4927c78de08aa623 |
|
BLAKE2b-256 | d82d53f115cd2194d2452295cbc4a1f2a371d596261b9b41103e917608d464c7 |