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

This part of the documentation covers the installation of ``selenium_generator``.

The framework needs several external dependencies which are installed along with the framework.

.. toggle-header::
    :header: **Show the dependencies**

        .. include:: ../../requirements.txt
            :literal:


*********************
Installation with PIP
*********************
**TODO - this option doesn't work yet**

.. code-block:: console

    $ pip install selenium_generator


*******************
Manual installation
*******************
Package is also possible to download by cloning the project repository and to install it from source.

.. code-block:: console

    $ git clone https://github.com/jjaros587/selenium_generator.git
    $ cd selenium_generator
    $ python setup.py install


If the framework is being extended you might find useful to install the package in a development mode.

.. code-block:: console

    $ python setup.py develop