Robotidy
DEPRECATION NOTICE
Starting from Robocop 6.0, Robotidy is part of Robocop as formatter.
If you are new users, please use https://github.com/MarketSquare/robotframework-robocop instead.
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.8+ :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
1 maintainer
Release files for robotframework-tidy 4.18.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| robotframework_tidy-4.18.0.tar.gz | 83.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| robotframework_tidy-4.18.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 195.0 kB
Release files / robotframework_tidy-4.18.0.tar.gz
| Download URL | robotframework_tidy-4.18.0.tar.gz |
|---|---|
| Size | 83.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1ddbcf4c429c4e1c30ea9c04f98d43fc2127d5e193d611dbbb7ae85dc8e85872
|
|
BLAKE2b-256 checksum How to use checksums |
993f2aa43668cd0044961e0fcd6a44d0e57b197e5d37f4b1a68ff9c1dd71a941
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
Release files / robotframework_tidy-4.18.0-py3-none-any.whl
| Download URL | robotframework_tidy-4.18.0-py3-none-any.whl |
|---|---|
| Size | 111.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
98b421fc6782fc7340fbcec7fe1aa0653c4c241f2d687dab11e8160006eabe78
|
|
BLAKE2b-256 checksum How to use checksums |
ff6b83dfe8bec0868f7859bca465d3e1f91759843c53b8cabb2cbc554e1d5bf7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.5
|
