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.13.0.tar.gz
(83.1 kB
view hashes)
Built Distribution
Close
Hashes for robotframework_tidy-4.13.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2f2cd9cce0f7fa9ddfed6e52921dae4318447f6ca3cfb38a7b1e904f9d8a9fc |
|
MD5 | 4dd03701e530cf181160e899db995ac4 |
|
BLAKE2b-256 | 1fb29b78b527d137c4fc1929b503853c789e89e310be0f2abfe4f6a33f27947b |
Close
Hashes for robotframework_tidy-4.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 335eb93a9531800965b2d23036559c006ac06ff8d5e17c1877c784d01a186dc4 |
|
MD5 | cef2d4c9f991989bcc4b5a426de67604 |
|
BLAKE2b-256 | c6106184be801ac270d5524d6a34b9a6b970f0929d515ab2b459d6b19bb1f13b |