Skip to main content

Code autoformatter for Robot Framework

Project description

Codecov PyPI Python versions Licence


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

Project details


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.18.0.tar.gz (83.8 kB view details)

Uploaded Source

Built Distribution

robotframework_tidy-4.18.0-py3-none-any.whl (111.1 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_tidy-4.18.0.tar.gz.

File metadata

  • Download URL: robotframework_tidy-4.18.0.tar.gz
  • Upload date:
  • Size: 83.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for robotframework_tidy-4.18.0.tar.gz
Algorithm Hash digest
SHA256 1ddbcf4c429c4e1c30ea9c04f98d43fc2127d5e193d611dbbb7ae85dc8e85872
MD5 79151066bd200fef98cac4775fe7983c
BLAKE2b-256 993f2aa43668cd0044961e0fcd6a44d0e57b197e5d37f4b1a68ff9c1dd71a941

See more details on using hashes here.

File details

Details for the file robotframework_tidy-4.18.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_tidy-4.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98b421fc6782fc7340fbcec7fe1aa0653c4c241f2d687dab11e8160006eabe78
MD5 5d8e9d2dc770a28d71934969611a9548
BLAKE2b-256 ff6b83dfe8bec0868f7859bca465d3e1f91759843c53b8cabb2cbc554e1d5bf7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page