toolium 3.6.0.dev3__tar.gz → 3.8.0__tar.gz

{toolium-3.6.0.dev3 → toolium-3.8.0}/CHANGELOG.rst

@@ -1,10 +1,33 @@
 Toolium Changelog
 =================
 
+v3.8.0
+------
+
+*Release date: 2026-03-13*
+
+- 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
+- Add langgraph methods to create a ReAct AI agent to test the behavior of other AI agents or LLMs
+- Add llm-as-a-judge methods to use an LLM to evaluate the answer of another LLM and give a similarity score based
+  on the user's question and a reference answer
+
+v3.7.0
+------
+
+*Release date: 2025-12-02*
+
+- Fix accuracy tag to exclude skipped executions from total executions count
+- Add `after_accuracy_scenario` hook to allow custom behavior after accuracy scenario execution
+- Add csv report for accuracy scenario results
+- Add text readability assessment function based on the AI libraries that come with the `ai` extra dependency
+
 v3.6.0
 ------
 
-*Release date: In development*
+*Release date: 2025-11-20*
 
 - Remove Python 3.9 support (Python 3.9 reached the end of its life on October 31st, 2025)
 - Remove xcuitest deprecated `get_window_size` method and replaced it with `get_window_rect` in all mobile actions

{toolium-3.6.0.dev3/toolium.egg-info → toolium-3.8.0}/PKG-INFO

@@ -1,11 +1,14 @@
 Metadata-Version: 2.4
 Name: toolium
-Version: 3.6.0.dev3
+Version: 3.8.0
 Summary: Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project
-Home-page: https://github.com/telefonica/toolium
-Author: Rubén González Alonso, Telefónica I+D
-Author-email: ruben.gonzalezalonso@telefonica.com
+Author-email: Rubén González Alonso <ruben.gonzalezalonso@telefonica.com>
 License: Apache 2.0
+Project-URL: Homepage, https://github.com/telefonica/toolium
+Project-URL: Repository, https://github.com/telefonica/toolium
+Project-URL: Documentation, http://toolium.readthedocs.org/en/latest
+Project-URL: Changelog, http://toolium.readthedocs.org/en/latest/changelog.html
+Project-URL: Bug Tracker, https://github.com/telefonica/toolium/issues
 Keywords: selenium,appium,webdriver,web_automation,mobile_automation,page_object,visual_testing,ai,bdd,behave,pytest
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
@@ -17,9 +20,14 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Testing :: Acceptance
+Classifier: Topic :: Software Development :: Testing :: BDD
+Classifier: Topic :: Text Processing :: Linguistic
+Requires-Python: >=3.10
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: requests~=2.27
@@ -33,22 +41,25 @@ Requires-Dist: phonenumbers<10.0,>=8.13
 Provides-Extra: playwright
 Requires-Dist: playwright~=1.43; extra == "playwright"
 Provides-Extra: ai
+Requires-Dist: langchain-openai~=1.1; extra == "ai"
+Requires-Dist: langgraph~=1.0; extra == "ai"
 Requires-Dist: spacy~=3.8.7; extra == "ai"
 Requires-Dist: sentence-transformers~=5.1; extra == "ai"
-Requires-Dist: transformers==4.56.2; python_version < "3.10" and extra == "ai"
 Requires-Dist: openai~=1.108; extra == "ai"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
+Provides-Extra: dev
+Requires-Dist: pytest~=9.0; extra == "dev"
+Requires-Dist: coverage~=7.11; extra == "dev"
+Requires-Dist: coveralls~=4.0; extra == "dev"
+Requires-Dist: mock~=5.0; extra == "dev"
+Requires-Dist: requests-mock~=1.10; extra == "dev"
+Requires-Dist: Pygments~=2.14; extra == "dev"
+Requires-Dist: build~=1.3; extra == "dev"
+Requires-Dist: wheel>=0.46.2,~=0.46; extra == "dev"
+Requires-Dist: twine~=6.2; extra == "dev"
+Requires-Dist: behave~=1.3; extra == "dev"
+Requires-Dist: importlib_metadata~=8.7; extra == "dev"
+Requires-Dist: ruff~=0.15; extra == "dev"
 Dynamic: license-file
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
 
 Toolium
 =======
@@ -72,7 +83,7 @@ Getting Started
 ---------------
 
 Run ``pip install toolium`` to install the latest version from `PyPi <https://pypi.org/project/toolium>`_. It's
-highly recommendable to use a virtualenv.
+highly recommended to use a virtualenv.
 
 The main dependencies are:
 
@@ -85,11 +96,11 @@ The main dependencies are:
 - `requests <http://docs.python-requests.org>`_: to test APIs
 
 You might need to adjust the Selenium and Appium-Python-Client versions in your project.
-In that case follow the `compatibility matrix <https://github.com/appium/python-client?tab=readme-ov-file#compatibility-matrix>`_
+In that case, follow the `compatibility matrix <https://github.com/appium/python-client?tab=readme-ov-file#compatibility-matrix>`_
 
 **Using toolium-template**
 
-The easiest way of getting started is to clone `toolium-template <https://github.com/Telefonica/toolium-template>`_
+The easiest way to get started is to clone `toolium-template <https://github.com/Telefonica/toolium-template>`_
 project, run the example test and add your own tests and configuration.
 
 .. code:: console
@@ -98,8 +109,8 @@ project, run the example test and add your own tests and configuration.
     $ cd toolium-template
     $ pip install -r requirements.txt
 
-Now, just follow `toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>`_ to know
-how to start your testing project.
+Now, just follow the `toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>`_ to
+know how to start your testing project.
 
 **Running toolium-examples**
 
@@ -112,16 +123,16 @@ to use the library to test web, Android or iOS applications, in different scenar
     $ cd toolium-examples
     $ pip install -r requirements.txt
 
-Now, just follow `toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>`_ to run
-the examples of the tests.
+Now, just follow the `toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>`_ to
+run the test examples.
 
 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.
+If you want to collaborate in Toolium development, feel free to `fork it <https://github.com/Telefonica/toolium>`_
+and create a pull request.
 
-Don't forget to run unit tests:
+Then clone the repository and install the dependencies in your virtualenv:
 
 .. code:: console
 
@@ -129,6 +140,18 @@ Don't forget to run unit tests:
     $ 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 --fix .    # Fix linting 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
@@ -138,15 +161,15 @@ and send it to ruben.gonzalezalonso@telefonica.com.
 Main Features
 -------------
 
-- `Choosing driver through a configuration file <http://toolium.readthedocs.org/en/latest/driver_configuration.html>`_
-- `Page Object pattern <http://toolium.readthedocs.org/en/latest/page_objects.html>`_
-- `BDD integration <http://toolium.readthedocs.org/en/latest/bdd_integration.html>`_
-- `Visual testing solution <http://toolium.readthedocs.org/en/latest/visual_testing.html>`_
-- `Tests result analysis <http://toolium.readthedocs.org/en/latest/tests_result_analysis.html>`_
+- `Choosing a driver through a configuration file </docs/driver_configuration.rst>`_
+- `Page Object pattern </docs/page_objects.rst>`_
+- `BDD integration </docs/bdd_integration.rst>`_
+- `Visual testing solution </docs/visual_testing.rst>`_
+- `Tests result analysis </docs/tests_result_analysis.rst>`_
 
 Documentation
 -------------
 
-Further information about features and fixes included in each release: `CHANGELOG <http://toolium.readthedocs.org/en/latest/changelog.html>`_.
+Further information about features and fixes included in each release: `CHANGELOG </CHANGELOG.rst>`_.
 
-Complete library reference and documentation available at `ReadTheDocs <http://toolium.readthedocs.org>`_.
+Complete library reference and documentation are available at `ReadTheDocs <http://toolium.readthedocs.org>`_.

{toolium-3.6.0.dev3 → toolium-3.8.0}/README.rst

@@ -20,7 +20,7 @@ Getting Started
 ---------------
 
 Run ``pip install toolium`` to install the latest version from `PyPi <https://pypi.org/project/toolium>`_. It's
-highly recommendable to use a virtualenv.
+highly recommended to use a virtualenv.
 
 The main dependencies are:
 
@@ -33,11 +33,11 @@ The main dependencies are:
 - `requests <http://docs.python-requests.org>`_: to test APIs
 
 You might need to adjust the Selenium and Appium-Python-Client versions in your project.
-In that case follow the `compatibility matrix <https://github.com/appium/python-client?tab=readme-ov-file#compatibility-matrix>`_
+In that case, follow the `compatibility matrix <https://github.com/appium/python-client?tab=readme-ov-file#compatibility-matrix>`_
 
 **Using toolium-template**
 
-The easiest way of getting started is to clone `toolium-template <https://github.com/Telefonica/toolium-template>`_
+The easiest way to get started is to clone `toolium-template <https://github.com/Telefonica/toolium-template>`_
 project, run the example test and add your own tests and configuration.
 
 .. code:: console
@@ -46,8 +46,8 @@ project, run the example test and add your own tests and configuration.
     $ cd toolium-template
     $ pip install -r requirements.txt
 
-Now, just follow `toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>`_ to know
-how to start your testing project.
+Now, just follow the `toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>`_ to
+know how to start your testing project.
 
 **Running toolium-examples**
 
@@ -60,16 +60,16 @@ to use the library to test web, Android or iOS applications, in different scenar
     $ cd toolium-examples
     $ pip install -r requirements.txt
 
-Now, just follow `toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>`_ to run
-the examples of the tests.
+Now, just follow the `toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>`_ to
+run the test examples.
 
 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.
+If you want to collaborate in Toolium development, feel free to `fork it <https://github.com/Telefonica/toolium>`_
+and create a pull request.
 
-Don't forget to run unit tests:
+Then clone the repository and install the dependencies in your virtualenv:
 
 .. code:: console
 
@@ -77,6 +77,18 @@ Don't forget to run unit tests:
     $ 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 --fix .    # Fix linting 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
@@ -86,7 +98,7 @@ and send it to ruben.gonzalezalonso@telefonica.com.
 Main Features
 -------------
 
-- `Choosing driver through a configuration file </docs/driver_configuration.rst>`_
+- `Choosing a driver through a configuration file </docs/driver_configuration.rst>`_
 - `Page Object pattern </docs/page_objects.rst>`_
 - `BDD integration </docs/bdd_integration.rst>`_
 - `Visual testing solution </docs/visual_testing.rst>`_
@@ -97,4 +109,4 @@ Documentation
 
 Further information about features and fixes included in each release: `CHANGELOG </CHANGELOG.rst>`_.
 
-Complete library reference and documentation available at `ReadTheDocs <http://toolium.readthedocs.org>`_.
+Complete library reference and documentation are available at `ReadTheDocs <http://toolium.readthedocs.org>`_.

toolium-3.8.0/VERSION

@@ -0,0 +1 @@
+3.8.0

toolium-3.8.0/pyproject.toml

@@ -0,0 +1,152 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "toolium"
+dynamic = ["version", "dependencies", "optional-dependencies"]
+authors = [
+    {name = "Rubén González Alonso", email = "ruben.gonzalezalonso@telefonica.com"},
+]
+description = "Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project"
+readme = "README.rst"
+license = {text = "Apache 2.0"}
+keywords = [
+    "selenium",
+    "appium",
+    "webdriver",
+    "web_automation",
+    "mobile_automation",
+    "page_object",
+    "visual_testing",
+    "ai",
+    "bdd",
+    "behave",
+    "pytest"
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Other Audience",
+    "License :: OSI Approved :: Apache Software License",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Software Development :: Testing :: Acceptance",
+    "Topic :: Software Development :: Testing :: BDD",
+    "Topic :: Text Processing :: Linguistic",
+]
+requires-python = ">=3.10"
+
+[project.urls]
+Homepage = "https://github.com/telefonica/toolium"
+Repository = "https://github.com/telefonica/toolium"
+Documentation = "http://toolium.readthedocs.org/en/latest"
+Changelog = "http://toolium.readthedocs.org/en/latest/changelog.html"
+"Bug Tracker" = "https://github.com/telefonica/toolium/issues"
+
+[tool.setuptools]
+packages = [
+    "toolium",
+    "toolium.pageobjects",
+    "toolium.pageelements",
+    "toolium.pageelements.playwright",
+    "toolium.behave",
+    "toolium.utils",
+    "toolium.utils.ai_utils"
+]
+
+[tool.setuptools.package-data]
+"toolium" = [
+    "resources/VisualTestsTemplate.html",
+    "resources/VisualTests.js",
+    "resources/VisualTests.css"
+]
+
+[tool.setuptools.dynamic]
+version = {file = "VERSION"}
+dependencies = {file = ["requirements.txt"]}
+optional-dependencies.playwright = {file = ["requirements_playwright.txt"]}
+optional-dependencies.ai = {file = ["requirements_ai.txt"]}
+optional-dependencies.dev = {file = ["requirements_dev.txt"]}
+
+[tool.pytest.ini_options]
+testpaths = ["toolium/test"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]
+addopts = "-v --tb=short"
+
+[tool.coverage.run]
+source = ["toolium"]
+omit = [
+    "*/test*",
+    "*/tests/*",
+    "*/venv/*",
+    "*/.venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if self.debug:",
+    "if settings.DEBUG",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == '__main__':",
+]
+
+[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
+    "UP",  # pyupgrade
+    "N",   # pep8-naming
+    "A",   # flake8-builtins
+    "B",   # flake8-bugbear
+    "G",   # flake8-logging-format
+    "ARG", # flake8-unused-arguments
+    "COM", # flake8-commas
+    "C4",  # flake8-comprehensions
+    "PT",  # flake8-pytest-style
+    "T20", # flake8-print
+    "RUF", # Ruff-specific rules
+]
+# Rules to ignore
+ignore = [
+    "COM812",  # flake8-missing-trailing-comas (conflict with ruff format)
+]
+
+[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.format]
+quote-style = "single"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"

toolium-3.8.0/requirements_ai.txt

@@ -0,0 +1,5 @@
+langchain-openai~=1.1       # OpenAI LLMs in AI agents
+langgraph~=1.0              # AI agents
+spacy~=3.8.7
+sentence-transformers~=5.1
+openai~=1.108               # OpenAI LLMs

{toolium-3.6.0.dev3 → toolium-3.8.0}/requirements_dev.txt

@@ -4,12 +4,9 @@ coveralls~=4.0
 mock~=5.0
 requests-mock~=1.10
 Pygments~=2.14
-flake8~=7.3
 build~=1.3
-wheel~=0.40
+wheel~=0.46,>=0.46.2
 twine~=6.2
 behave~=1.3  # behave tests
 importlib_metadata~=8.7
-spacy~=3.8
-sentence-transformers~=5.1
-openai~=2.7
+ruff~=0.15

toolium-3.8.0/requirements_playwright.txt

@@ -0,0 +1 @@
+playwright~=1.43

toolium-3.8.0/setup.py

@@ -0,0 +1,27 @@
+"""
+Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
+This file is part of Toolium.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from setuptools import setup
+
+setup()
+
+"""
+Backward compatibility setup.py
+
+All package configuration has been moved to pyproject.toml
+This file exists only for backward compatibility with older tools.
+"""