toolium 1.4.0

Wrapper tool of Selenium and Appium libraries to test web and mobile applications in a single project

Toolium
=======

|Build Status| |Coverage Status| |Code Health| |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://travis-ci.org/Telefonica/toolium.svg?branch=master
:target: https://travis-ci.org/Telefonica/toolium
.. |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
.. |Code Health| image:: https://landscape.io/github/Telefonica/toolium/master/landscape.svg?style=flat
:target: https://landscape.io/github/Telefonica/toolium/master

Getting Started
---------------

The requirements to install Toolium are `Python 2.7 or 3.3+ <http://www.python.org>`_ and
`pip <https://pypi.python.org/pypi/pip>`_. If you use Python 2.7.9+, you don't need to install pip separately.

Run ``pip install toolium`` to install the latest version from `PyPi <https://pypi.python.org/pypi/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, Safari, Opera)
- `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 [e-mail]:Telefonica/toolium-template.git
$ cd toolium-template
$ pip install -r requirements.txt

Now, just follow the instructions `here <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 [e-mail]:Telefonica/toolium-examples.git
$ cd toolium-examples
$ pip install -r requirements.txt

Now, just follow the instructions `here <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 [e-mail]:<your_github_user>/toolium.git
$ cd toolium
$ python setup.py test

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 [e-mail].

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>`_.