INSTALL

############
Installation
############

This document covers installation of `odooselenium` for typical usage. If you
want to setup a development environment, see :doc:`/contributing`
documentation.

.. note:: `odooselenium` is free software. See :doc:`/about/license` for
details.


*************
Prerequisites
*************

`odooselenium` requires `Python` version 2.7. Other versions may work, but they
are not part of the test suite at the moment.

`odooselenium` currently requires you have an Odoo server running:

* http://localhost:8069 serves Odoo;
* User "admin" with password "admin" is administrator of database 'test';
* `web_selenium <https://github.com/brain-tec/web_selenium>`_ module is
  enabled.


****************************
Install odooselenium library
****************************

Install `odooselenium` with the Python package installer you like. Here is an
example with pip:

.. code:: python

   pip install odooselenium


*****
Check
*****

Check `odooselenium` has been installed:

.. code:: sh

   python -c "import odooselenium; print(odooselenium.__version__)"

You should get `odooselenium`'s version.


.. rubric:: References

.. target-notes::

.. _`Python`: https://www.python.org/
.. _`pip`: https://pip.pypa.io