.. _installation:

============
Installation
============


How to install the package
--------------------------

Install the whole ``pysmali`` package (or add it to your ``requirements.txt`` file):

.. code:: console

    $ pip install pysmali


.. hint::

    In most cases you want to create a virtual environment as it provides extra security features
    when working with packages. To create a simple virtual environment, run:

    .. code-block:: console
        :caption: Linux

        $ python3 -m venv ./venv && source ./venv/bin/activate

    .. code-block:: console
        :caption: Windows

        $ py -m venv ./venv && ./venv/Scripts/activate.bat