.. _getting_started-installation:

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

Tunel can be installed from pypi, or from source. 


Pypi
====

The module is available in pypi as `tunel <https://pypi.org/project/tunel/>`_,
To install:

.. code:: console

    $ pip install tunel



Virtual Environment
===================

Or you can install into a virtual environment - either from source or a release.

.. code:: console

    # Install release 0.0.1
    $ git clone -b 0.0.1 https://github.com/tunel-apps/tunel
    $ cd tunel
    $ pip install .

or

.. code:: console

    $ git clone https://github.com/tunel-apps/tunel
    $ cd tunel
    $ pip install .