feat:: configure ruff and reformat all files

Author: rgonalo

.codeclimate.yml

@@ -43,9 +43,7 @@ checks:
       threshold: #language-specific defaults. overrides affect all languages.
 
 plugins:
-  eslint:
-    enabled: true
-    channel: "eslint-6"
+  # ESLint disabled - Python project only
 
 exclude_patterns:
 - "dist/"

.github/workflows/ci.yml

@@ -22,9 +22,10 @@ jobs:
         pip install -r requirements.txt
         pip install -r requirements_dev.txt
         python -m spacy download en_core_web_md
-    - name: Lint with flake8
+    - name: Lint and format check with ruff
       run: |
-        flake8 . --count --max-complexity=10 --max-line-length=121 --show-source --statistics
+        ruff check .
+        ruff format --check .
     - name: Test with pytest and coverage
       env:
         AZURE_OPENAI_API_KEY: ${{ secrets.AZURE_OPENAI_API_KEY }}

CHANGELOG.rst

@@ -7,6 +7,7 @@ v3.7.1
 *Release date: In development*
 
 - Add pyproject.toml file for packaging and publishing Toolium
+- Configure ruff for linting and formatting files, replacing flake8 and black
 - Add text analysis tool to get an overall match of a text against a list of expected characteristics
   using AI libraries that come with the `ai` extra dependency
 

README.rst

@@ -69,14 +69,27 @@ Contributing
 If you want to collaborate in Toolium development, feel free of `forking it <https://github.com/Telefonica/toolium>`_
 and asking for a pull request.
 
-Don't forget to run unit tests:
+Installing and setting up the development environment is quite easy, just clone the repository and install the dependencies in your virtualenv:
 
 .. code:: console
 
     $ git clone git@github.com:<your_github_user>/toolium.git
     $ cd toolium
     $ pip install -r requirements.txt
     $ pip install -r requirements_dev.txt
+
+Before submitting your changes, make sure the code follows the project's style by running Ruff:
+
+.. code:: console
+
+    $ ruff check .          # Check for linting issues
+    $ ruff check --fix .    # Fix auto-fixable issues
+    $ ruff format .         # Format code
+
+Then run the unit tests:
+
+.. code:: console
+
     $ python -m pytest
 
 Finally, before accepting your contribution, we need you to sign our

docs/ai_utils.rst

@@ -158,8 +158,8 @@ achieve at least 80% accuracy.
     @accuracy_80_10
     Scenario: Validate AI-generated response accuracy
       Given the AI model generates a response
-      When the user sends a message
-      Then the AI response should be accurate
+       When the user sends a message
+       Then the AI response should be accurate
 
 When a scenario is tagged with an accuracy tag, Toolium will automatically execute the scenario multiple times. If the
 scenario does not meet the specified accuracy after the given number of executions, it will be marked as failed.
@@ -187,8 +187,8 @@ accuracy data set with the suffix "greetings".
     @accuracy_data_greetings
     Scenario: Validate AI-generated greeting responses
       Given the AI model generates a greeting response
-      When the user sends "[CONTEXT:accuracy_execution_data.question]" message
-      Then the AI greeting response should be similar to "[CONTEXT:accuracy_execution_data.answer]"
+       When the user sends "[CONTEXT:accuracy_execution_data.question]" message
+       Then the AI greeting response should be similar to "[CONTEXT:accuracy_execution_data.answer]"
 
 When a scenario is tagged with an accuracy data tag, Toolium will automatically use the specified accuracy data set for
 each execution. This allows you to test different scenarios with varying data inputs. Accuracy data should be stored

docs/bdd_integration.rst

@@ -114,27 +114,27 @@ Example::
 
           Actions Before the Feature:
             Given wait 3 seconds
-            And waitrty 3 seconds
-            And wait 3 seconds
-            And step with a table
-              | parameter     | value       |
-              | sub_fields_1  | sub_value 1 |
-              | sub_fields_2  | sub_value 2 |
+              And waitrty 3 seconds
+              And wait 3 seconds
+              And step with a table
+                  | parameter     | value       |
+                  | sub_fields_1  | sub_value 1 |
+                  | sub_fields_2  | sub_value 2 |
 
           Actions Before each Scenario:
             Given the user navigates to the "www.google.es" url
-            When the user logs in with username and password
-            And wait 1 seconds
-            And wait 1 seconds
+             When the user logs in with username and password
+              And wait 1 seconds
+              And wait 1 seconds
 
           Actions After each Scenario:
-            And wait 2 seconds
-            And wait 2 seconds
+             Then wait 2 seconds
+              And wait 2 seconds
 
           Actions After the Feature:
-            And wait 4 seconds
-            And step with another step executed dynamically
-            And wait 4 seconds
+             Then wait 4 seconds
+              And step with another step executed dynamically
+              And wait 4 seconds
 
 
 All kind of steps are allowed:

docs/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
@@ -72,7 +71,7 @@
 
 # General information about the project.
 project = 'Toolium'
-copyright = '2015-2021, Telefónica I+D'
+copyright = '2015-2026, Telefónica I+D'  # noqa: A001
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -81,9 +80,9 @@
 # The short X.Y version.
 version = open('../VERSION').read().strip()
 # The full version, including alpha/beta/rc tags.
-git_log = subprocess.check_output(["git", "log", "--pretty=oneline"])
+git_log = subprocess.check_output(['git', 'log', '--pretty=oneline'])
 commits = git_log.split(b'\n')
-release = '{}-{}'.format(version, len(commits) - 1)
+release = f'{version}-{len(commits) - 1}'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -129,7 +128,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 # html_theme = 'default'
-html_theme = "sphinx_rtd_theme"
+html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
@@ -214,10 +213,8 @@
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     # 'preamble': '',
 }
@@ -255,7 +252,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'Toolium', 'Toolium Documentation', ['Rubén González Alonso, Telefónica I+D'], 1)
+    ('index', 'Toolium', 'Toolium Documentation', ['Rubén González Alonso, Telefónica I+D'], 1),
 ]
 
 # If true, show URL addresses after external links.
@@ -268,9 +265,15 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'Toolium', 'toolium Documentation', 'Rubén González Alonso, Telefónica I+D', 'toolium',
-     'Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project.',
-     'Miscellaneous'),
+    (
+        'index',
+        'Toolium',
+        'toolium Documentation',
+        'Rubén González Alonso, Telefónica I+D',
+        'toolium',
+        'Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project.',
+        'Miscellaneous',
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -291,9 +294,9 @@
 
 def remove_module_docstring(app, what, name, obj, options, lines):
     """Remove all module docstrings to exclude license header"""
-    if what == "module":
+    if what == 'module':
         del lines[:]
 
 
 def setup(app):
-    app.connect("autodoc-process-docstring", remove_module_docstring)
+    app.connect('autodoc-process-docstring', remove_module_docstring)

pyproject.toml

@@ -105,50 +105,43 @@ exclude_lines = [
     "if __name__ == .__main__.:",
 ]
 
-[tool.black]
-line-length = 120
-target-version = ['py310', 'py311', 'py312', 'py313']
-include = '\.pyi?$'
-extend-exclude = '''
-/(
-  # directories
-  \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | build
-  | dist
-)/
-'''
-
-[tool.isort]
-profile = "black"
-line_length = 120
-multi_line_output = 3
-include_trailing_comma = true
-force_grid_wrap = 0
-use_parentheses = true
-ensure_newline_before_comments = true
-
 [tool.ruff]
 line-length = 120
 target-version = "py310"
+
+[tool.ruff.lint]
+# Rules to enforce
 select = [
-    "E",  # pycodestyle errors
-    "W",  # pycodestyle warnings
-    "F",  # pyflakes
-    "I",  # isort
-    "B",  # flake8-bugbear
-    "C4", # flake8-comprehensions
-    "UP", # pyupgrade
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # Pyflakes
+    "I",   # isort
+    "UP",  # pyupgrade
+    "N",   # pep8-naming
+    "B",   # flake8-bugbear
+    "A",   # flake8-builtins
+    "COM", # flake8-commas
+    "C4",  # flake8-comprehensions
+    "PT",  # flake8-pytest-style
+    "RUF", # Ruff-specific rules
 ]
-ignore = [
-    "E501",  # line too long, handled by black
-    "B008",  # do not perform function calls in argument defaults
-    "C901",  # too complex
+# Rules to ignore
+ignore = []
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+split-on-trailing-comma = true
+known-first-party = ["acceptance"]
+section-order = [
+    "future",
+    "standard-library",
+    "third-party",
+    "first-party",
+    "local-folder"
 ]
 
-[tool.ruff.per-file-ignores]
-"__init__.py" = ["F401"]
+[tool.ruff.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

requirements_dev.txt

@@ -4,7 +4,6 @@ coveralls~=4.0
 mock~=5.0
 requests-mock~=1.10
 Pygments~=2.14
-flake8~=7.3
 build~=1.3
 wheel~=0.40
 twine~=6.2
@@ -13,3 +12,4 @@ importlib_metadata~=8.7
 spacy~=3.8
 sentence-transformers~=5.1
 openai~=2.7
+ruff~=0.15

setup.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 """
 Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
 This file is part of Toolium.
@@ -15,6 +14,7 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 """
+
 from setuptools import setup
 
 setup()