Toolium
=======
|Build Status| |Coverage Status| |CodeClimate| |Documentation Status|
Toolium is a Python wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single
project. It provides a way of choosing and configuring the driver through a configuration file, implements a Page Object
pattern and includes a simple visual testing solution.
.. |Build Status| image:: https://github.com/Telefonica/toolium/workflows/build/badge.svg?branch=master
:target: https://github.com/Telefonica/toolium/actions?query=branch%3Amaster
.. |Documentation Status| image:: https://readthedocs.org/projects/toolium/badge/?version=latest
:target: http://toolium.readthedocs.org/en/latest
.. |Coverage Status| image:: https://coveralls.io/repos/Telefonica/toolium/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/Telefonica/toolium?branch=master
.. |CodeClimate| image:: https://api.codeclimate.com/v1/badges/3e5773b2e5272b546f8a/maintainability
:target: https://codeclimate.com/github/Telefonica/toolium/maintainability
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.
The main dependencies are:
- `Selenium <http://docs.seleniumhq.org/>`_: to test web applications in major browsers (Firefox, Chrome, Internet
Explorer, Edge or Safari)
- `Appium-Python-Client <https://github.com/appium/python-client>`_: to test mobile applications (native, hybrid or web)
in Android or iOS devices/emulators.
- `requests <http://docs.python-requests.org>`_: to test APIs
**Using toolium-template**
The easiest way of getting 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
$ git clone git@github.com:Telefonica/toolium-template.git
$ 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.
**Running toolium-examples**
You can also clone `toolium-examples <https://github.com/Telefonica/toolium-examples>`_ to get more examples about how
to use the library to test web, Android or iOS applications, in different scenarios.
.. code:: console
$ git clone git@github.com:Telefonica/toolium-examples.git
$ 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.
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:
.. 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
$ python -m pytest
Finally, before accepting your contribution, we need you to sign our
`Contributor License Agreement <https://raw.githubusercontent.com/telefonicaid/Licensing/master/ContributionPolicy.txt>`_
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>`_
Documentation
-------------
Further information about features and fixes included in each release: `CHANGELOG <http://toolium.readthedocs.org/en/latest/changelog.html>`_.
Complete library reference and documentation available at `ReadTheDocs <http://toolium.readthedocs.org>`_.
Raw data
{
"_id": null,
"home_page": "https://github.com/telefonica/toolium",
"name": "toolium",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "selenium appium webdriver web_automation mobile_automation page_object visual_testing bdd behave pytest",
"author": "Rub\u00e9n Gonz\u00e1lez Alonso, Telef\u00f3nica I+D",
"author_email": "ruben.gonzalezalonso@telefonica.com",
"download_url": "https://files.pythonhosted.org/packages/ba/ef/414937437945129d6525c5e3c545a05f0d421ec802623a6a5c51af3f392d/toolium-3.2.0.tar.gz",
"platform": null,
"description": "Toolium\r\n=======\r\n\r\n|Build Status| |Coverage Status| |CodeClimate| |Documentation Status|\r\n\r\nToolium is a Python wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single\r\nproject. It provides a way of choosing and configuring the driver through a configuration file, implements a Page Object\r\npattern and includes a simple visual testing solution.\r\n\r\n.. |Build Status| image:: https://github.com/Telefonica/toolium/workflows/build/badge.svg?branch=master\r\n :target: https://github.com/Telefonica/toolium/actions?query=branch%3Amaster\r\n.. |Documentation Status| image:: https://readthedocs.org/projects/toolium/badge/?version=latest\r\n :target: http://toolium.readthedocs.org/en/latest\r\n.. |Coverage Status| image:: https://coveralls.io/repos/Telefonica/toolium/badge.svg?branch=master&service=github\r\n :target: https://coveralls.io/github/Telefonica/toolium?branch=master\r\n.. |CodeClimate| image:: https://api.codeclimate.com/v1/badges/3e5773b2e5272b546f8a/maintainability\r\n :target: https://codeclimate.com/github/Telefonica/toolium/maintainability\r\n\r\nGetting Started\r\n---------------\r\n\r\nRun ``pip install toolium`` to install the latest version from `PyPi <https://pypi.org/project/toolium>`_. It's\r\nhighly recommendable to use a virtualenv.\r\n\r\nThe main dependencies are:\r\n\r\n- `Selenium <http://docs.seleniumhq.org/>`_: to test web applications in major browsers (Firefox, Chrome, Internet\r\n Explorer, Edge or Safari)\r\n- `Appium-Python-Client <https://github.com/appium/python-client>`_: to test mobile applications (native, hybrid or web)\r\n in Android or iOS devices/emulators.\r\n- `requests <http://docs.python-requests.org>`_: to test APIs\r\n\r\n**Using toolium-template**\r\n\r\nThe easiest way of getting started is to clone `toolium-template <https://github.com/Telefonica/toolium-template>`_\r\nproject, run the example test and add your own tests and configuration.\r\n\r\n.. code:: console\r\n\r\n $ git clone git@github.com:Telefonica/toolium-template.git\r\n $ cd toolium-template\r\n $ pip install -r requirements.txt\r\n\r\nNow, just follow `toolium-template instructions <https://github.com/Telefonica/toolium-template#running-tests>`_ to know\r\nhow to start your testing project.\r\n\r\n**Running toolium-examples**\r\n\r\nYou can also clone `toolium-examples <https://github.com/Telefonica/toolium-examples>`_ to get more examples about how\r\nto use the library to test web, Android or iOS applications, in different scenarios.\r\n\r\n.. code:: console\r\n\r\n $ git clone git@github.com:Telefonica/toolium-examples.git\r\n $ cd toolium-examples\r\n $ pip install -r requirements.txt\r\n\r\nNow, just follow `toolium-examples instructions <https://github.com/Telefonica/toolium-examples#running-tests>`_ to run\r\nthe examples of the tests.\r\n\r\nContributing\r\n------------\r\n\r\nIf you want to collaborate in Toolium development, feel free of `forking it <https://github.com/Telefonica/toolium>`_\r\nand asking for a pull request.\r\n\r\nDon't forget to run unit tests:\r\n\r\n.. code:: console\r\n\r\n $ git clone git@github.com:<your_github_user>/toolium.git\r\n $ cd toolium\r\n $ pip install -r requirements.txt\r\n $ pip install -r requirements_dev.txt\r\n $ python -m pytest\r\n\r\nFinally, before accepting your contribution, we need you to sign our\r\n`Contributor License Agreement <https://raw.githubusercontent.com/telefonicaid/Licensing/master/ContributionPolicy.txt>`_\r\nand send it to ruben.gonzalezalonso@telefonica.com.\r\n\r\nMain Features\r\n-------------\r\n\r\n- `Choosing driver through a configuration file <http://toolium.readthedocs.org/en/latest/driver_configuration.html>`_\r\n- `Page Object pattern <http://toolium.readthedocs.org/en/latest/page_objects.html>`_\r\n- `BDD integration <http://toolium.readthedocs.org/en/latest/bdd_integration.html>`_\r\n- `Visual testing solution <http://toolium.readthedocs.org/en/latest/visual_testing.html>`_\r\n- `Tests result analysis <http://toolium.readthedocs.org/en/latest/tests_result_analysis.html>`_\r\n\r\nDocumentation\r\n-------------\r\n\r\nFurther information about features and fixes included in each release: `CHANGELOG <http://toolium.readthedocs.org/en/latest/changelog.html>`_.\r\n\r\nComplete library reference and documentation available at `ReadTheDocs <http://toolium.readthedocs.org>`_.\r\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project",
"version": "3.2.0",
"project_urls": {
"Homepage": "https://github.com/telefonica/toolium"
},
"split_keywords": [
"selenium",
"appium",
"webdriver",
"web_automation",
"mobile_automation",
"page_object",
"visual_testing",
"bdd",
"behave",
"pytest"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bbe55ee3943264f68b3ae86d002cc5bea36d4dc364a56d30c3891997b728b48",
"md5": "05d15c98aaf145c188f26e8b051906a2",
"sha256": "8c8f06287d39f4476a0d2fbfe7f7bf78280de6a60963f174fcd86f3adbe5e924"
},
"downloads": -1,
"filename": "toolium-3.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05d15c98aaf145c188f26e8b051906a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 93483,
"upload_time": "2024-09-13T10:22:20",
"upload_time_iso_8601": "2024-09-13T10:22:20.093774Z",
"url": "https://files.pythonhosted.org/packages/6b/be/55ee3943264f68b3ae86d002cc5bea36d4dc364a56d30c3891997b728b48/toolium-3.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "baef414937437945129d6525c5e3c545a05f0d421ec802623a6a5c51af3f392d",
"md5": "09edf4d523d993b8a622005a3f03191c",
"sha256": "5ef3b626572c87356ef2d01159deb0ba5e8c49495ab87aef5a9500e7b53c3f85"
},
"downloads": -1,
"filename": "toolium-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "09edf4d523d993b8a622005a3f03191c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 79058,
"upload_time": "2024-09-13T10:22:21",
"upload_time_iso_8601": "2024-09-13T10:22:21.998480Z",
"url": "https://files.pythonhosted.org/packages/ba/ef/414937437945129d6525c5e3c545a05f0d421ec802623a6a5c51af3f392d/toolium-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-13 10:22:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "telefonica",
"github_project": "toolium",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "toolium"
}
JSON
