.. _installation:

Rougail library installation
======================================

Activate you virtual environment
------------------------------------

- Open a shell session

- install the virtual environment: `python -m'venv' .venv`
- activate it `./.venv/bin/activate` (or `.venv\Scripts\activate.exe` under windows)

Standard installation
---------------------------

You can use the `pip` python installer, here is the install command:

.. code-block:: bash

    pip install rougail

Installation of third-party libraries
-------------------------------------------

First, download the :download:`requirements.txt file: <install/requirements.txt>`

.. literalinclude:: install/requirements.txt
   :caption: The :file:`requirements.txt` requirements file

Then in your virtual environment, recursively install the third-party libraries as follows:

.. code-block:: bash

    pip install -r requirements.txt --extra-index-url https://test.pypi.org/simple/