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.4.0.tar.gz
(65.4 kB
view hashes)
Built Distribution
Close
Hashes for robotframework-tidy-3.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1f18e41f24d84a0621ecbe74284237ac15bbe56b5d111f4e5e9f316b0429efcc |
|
MD5 | 01827a57ae5954a7a81b9ed6ada49c76 |
|
BLAKE2b-256 | 22750964376c6dd32eb6f019e27451279361c3f476d6772397e4630d42f17a6c |
Close
Hashes for robotframework_tidy-3.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 336fb135ecf377d413347d64f307f6f632312d72df8dd438a9132efcb38863c1 |
|
MD5 | 87a290ef4f4c665ae4c50a65dd848d5d |
|
BLAKE2b-256 | 15c1b6622ff4400ac59267b7fff3d1e2227e68e14bbca56bc59039d839b4af25 |