robotframework-tidy

What it is and what it does

Robotidy is an autoformatter for Robot Framework test code that standardizes formatting across test files, keywords, and variables. It normalizes spacing, aligns columns, reorders sections (Settings, Variables, Test Cases, Keywords), and applies consistent indentation and syntax conventions. The tool runs as a command-line utility and accepts file or directory paths, reformatting Robot Framework files in place according to configurable rules.

The package depends on Robot Framework 4.0.0+, click for CLI handling, colorama for terminal colors, pathspec for file matching, tomli for configuration parsing, rich_click for enhanced help output, and Jinja2 for templating. It is positioned as a spiritual descendant of Robot Framework's internal robot.tidy package. However, the package carries a deprecation notice: starting from Robocop 6.0, Robotidy's functionality has been integrated into Robocop as a formatter, and new users are directed to use Robocop instead.

Use it for:

• Enforce consistent code style across a Robot Framework test suite before committing to version control.
• Automatically reformat legacy or poorly formatted Robot Framework test files to match team standards.
• Integrate into CI/CD pipelines to validate or auto-correct test code formatting on pull requests.
• Standardize Robot Framework code structure when onboarding new team members or consolidating multiple test repositories.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Robotidy autoformats Robot Framework test code, normalizing spacing, alignment, and structure to match a consistent style.

Yes, if you are actively maintaining an existing Robot Framework test suite and need automated code formatting. Install friction is low and the tool is stable. However, be aware of the deprecation notice: if you are starting a new project or can migrate, Robocop 6.0+ is the recommended path forward. For teams already using Robotidy, it remains functional, but plan a transition to Robocop to stay current.

Install

robotframework-tidy on PyPI

pip install robotframework-tidy

uv add robotframework-tidy

poetry add robotframework-tidy

Installing robotframework-tidy

Before you install

Low install friction; pure Python wheel with common dependencies. Maintenance is aging—last release was 407 days ago—but the repo remains active and the package is marked Production/Stable. Note: the description includes a deprecation notice stating that starting from Robocop 6.0, Robotidy is part of Robocop as a formatter; new users are directed to Robocop instead.

License in practice

Apache License 2.0 is permissive, allowing commercial and private use with minimal restrictions. No notable licensing constraints for most use cases.

Quickstart

pip install robotframework-tidy
robotidy tests/
robotidy test.robot

Requires Robot Framework 4.0.0 or later and Python 3.8 or later.

Verify before relying

• Whether Robocop 6.0+ is a drop-in replacement or requires migration effort for existing Robotidy users.
• Performance characteristics when formatting large test suites or deeply nested keyword structures.

Package facts

Evidence: robotframework_tidy-4.18.0-py3-none-any.whl

Keywords: robotframework

Tags

More Utilities packages