[](https://github.com/MarketSquare/robotframework-tidy/actions?query=workflow%3A%22Unit+tests%22 "GitHub Workflow Unit Tests Status")
---
<img style="float:right" src="https://raw.githubusercontent.com/MarketSquare/robotframework-tidy/main/docs/source/_static/robotidy_logo_small.png">
Robotidy
===============
- [Introduction](#introduction)
- [Documentation](#documentation)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Example](#example)
Introduction <a name="introduction"></a>
------------
Robotidy is a tool for autoformatting Robot Framework code.
It is spiritual descendant of Robot Framework's internal robot.tidy package.
Documentation <a name="documentation"></a>
-------------
Full documentation available [here](https://robotidy.readthedocs.io). :open_book:
Requirements <a name="requirements"></a>
------------
Python 3.7+ :snake: and Robot Framework 4.0.0+ :robot:.
Installation <a name="installation"></a>
------------
You can install Robotidy simply by running:
```
pip install -U robotframework-tidy
```
Usage <a name="usage"></a>
-----
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](https://robotidy.readthedocs.io/en/latest/configuration/index.html) for information how to configure
robotidy.
Example <a name="example"></a>
-------
Ugly code before transforming with robotidy:
```robotframework
*** 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:
```robotframework
*** 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/MarketSquare/robotframework-tidy",
"name": "robotframework-tidy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "robotframework",
"author": "MarketSquare - Robot Framework community",
"author_email": "bartek.hirsz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ab/24/921f6aeeaeda476df51a3a48b2169811567e03f0d799508efd162c8d23e1/robotframework-tidy-4.11.0.tar.gz",
"platform": "any",
"description": "[](https://github.com/MarketSquare/robotframework-tidy/actions?query=workflow%3A%22Unit+tests%22 \"GitHub Workflow Unit Tests Status\")\n![Codecov](https://img.shields.io/codecov/c/github/MarketSquare/robotframework-tidy/main \"Code coverage on master branch\")\n![PyPI](https://img.shields.io/pypi/v/robotframework-tidy?label=version \"PyPI package version\")\n![Python versions](https://img.shields.io/pypi/pyversions/robotframework-tidy \"Supported Python versions\")\n![Licence](https://img.shields.io/pypi/l/robotframework-tidy \"PyPI - License\")\n\n---\n\n<img style=\"float:right\" src=\"https://raw.githubusercontent.com/MarketSquare/robotframework-tidy/main/docs/source/_static/robotidy_logo_small.png\">\n\nRobotidy\n===============\n- [Introduction](#introduction)\n- [Documentation](#documentation)\n- [Requirements](#requirements)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Example](#example)\n\nIntroduction <a name=\"introduction\"></a>\n------------\nRobotidy is a tool for autoformatting Robot Framework code.\n\nIt is spiritual descendant of Robot Framework's internal robot.tidy package.\n\nDocumentation <a name=\"documentation\"></a>\n-------------\nFull documentation available [here](https://robotidy.readthedocs.io). :open_book:\n\nRequirements <a name=\"requirements\"></a>\n------------\n\nPython 3.7+ :snake: and Robot Framework 4.0.0+ :robot:.\n\nInstallation <a name=\"installation\"></a>\n------------\n\nYou can install Robotidy simply by running:\n```\npip install -U robotframework-tidy\n```\n\nUsage <a name=\"usage\"></a>\n-----\nCall robotidy with path(s) to file/directory with robot files:\n\n```\nrobotidy tests\nrobotidy test.robot\nrobotidy tests/resources test.robot\n```\n \nAll command line options can be displayed in help message by executing:\n\n```\nrobotidy --help\n```\n\nSee [documentation](https://robotidy.readthedocs.io/en/latest/configuration/index.html) for information how to configure \nrobotidy.\n\nExample <a name=\"example\"></a>\n-------\nUgly code before transforming with robotidy:\n```robotframework\n*** Settings ***\nForce Tags tags tag2\nLibrary Collections\nResource important.robot\nLibrary MyCustomLibrary.py\n\nTest Setup Setup Keyword\n\n\n*** test case*\nTest1\n [ teardown] Teardown Keyword\n Keyword\n FOR ${var} IN RANGE 10\n Run Keyword If ${var}>5 Other Keyword\n END\n*** Variables ***\n${var}= 2\n${bit_longer} 10\n${var2} a\n... b\n\n*** Keywords ***\n\n```\nA lot prettier code after:\n```robotframework\n*** Settings ***\nLibrary Collections\nLibrary MyCustomLibrary.py\nResource important.robot\n\nTest Setup Setup Keyword\n\nForce Tags tags tag2\n\n*** Variables ***\n${var} 2\n${bit_longer} 10\n${var2} a\n... b\n\n*** Test Cases ***\nTest1\n Keyword\n FOR ${var} IN RANGE 10\n IF ${var}>5\n Other Keyword\n END\n END\n [Teardown] Teardown Keyword\n\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Code autoformatter for Robot Framework",
"version": "4.11.0",
"project_urls": {
"Homepage": "https://github.com/MarketSquare/robotframework-tidy"
},
"split_keywords": [
"robotframework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6e394dba387c26e5ec0399d314011cbac28f55f09d6416568f8e7a9a162585e8",
"md5": "1ccf6196652f8aed9bc9505031be3436",
"sha256": "41897f5d0c6d1884f8420d6ca4e5dde98f0dd312b02a90e88745f6300c32cf3c"
},
"downloads": -1,
"filename": "robotframework_tidy-4.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1ccf6196652f8aed9bc9505031be3436",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 109012,
"upload_time": "2024-03-18T14:48:24",
"upload_time_iso_8601": "2024-03-18T14:48:24.890206Z",
"url": "https://files.pythonhosted.org/packages/6e/39/4dba387c26e5ec0399d314011cbac28f55f09d6416568f8e7a9a162585e8/robotframework_tidy-4.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ab24921f6aeeaeda476df51a3a48b2169811567e03f0d799508efd162c8d23e1",
"md5": "7ce2f447c2a9d5bf1f85201da3fd38c7",
"sha256": "255cad777a2bd24a5744164aceb57a15d14066b873601860c6504500f549af5e"
},
"downloads": -1,
"filename": "robotframework-tidy-4.11.0.tar.gz",
"has_sig": false,
"md5_digest": "7ce2f447c2a9d5bf1f85201da3fd38c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 81953,
"upload_time": "2024-03-18T14:48:27",
"upload_time_iso_8601": "2024-03-18T14:48:27.250619Z",
"url": "https://files.pythonhosted.org/packages/ab/24/921f6aeeaeda476df51a3a48b2169811567e03f0d799508efd162c8d23e1/robotframework-tidy-4.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 14:48:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarketSquare",
"github_project": "robotframework-tidy",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "robotframework-tidy"
}
JSON
