Skip to main content

Code autoformatter for Robot Framework

Project description

Unit-tests Codecov PyPI Python versions Licence


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


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

Uploaded Source

Built Distribution

robotframework_tidy-2.3-py3-none-any.whl (64.2 kB view details)

Uploaded Python 3

File details

Details for the file robotframework-tidy-2.3.tar.gz.

File metadata

  • Download URL: robotframework-tidy-2.3.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for robotframework-tidy-2.3.tar.gz
Algorithm Hash digest
SHA256 5e9ed04f6f8ea957056b584481ceb58b10f79c258a1a3519970ad914515ba7ba
MD5 5cd764bef3bb166f09819158ea0db4e7
BLAKE2b-256 7076c04eb1269cc2d15e5d70c27295400055ebced59e102e8d3bc73be3142cf2

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for robotframework_tidy-2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 df4a50b91336a0332b58a395270dfcaeaac24883e68fa5962d712140497f7cdd
MD5 0027f85721cad0407ac1362d998daf0b
BLAKE2b-256 1116b27155306ea7a649d8ad07d8e6efda893958e28302b72f2e7852452f63e6

See more details on using hashes here.

Provenance

Supported by

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