==================
Installation Guide
==================

.. meta::
   :description: Installation of Pynani
   :keywords: python, Messenger, pynani, documentation, guide


Using PIP
----------
.. code-block:: bash

    $ pip install pynani

Using pipenv
------------
.. code-block:: bash

    $ pipenv install pynani

By cloning repository
---------------------
.. code-block:: bash

    $ git clone https://github.com/jorge-jrzz/Pynani.git
    $ cd Pynani
    $ pip install .

Directly using pip
~~~~~~~~~~~~~~~~~~
.. code-block:: bash

    $ pip install git+https://github.com/jorge-jrzz/Pynani.git


It is generally recommended to use the first option.

While the API is production-ready, it is still under development and it has regular updates, do not forget to update it regularly by calling:

.. code-block:: bash

    $ pip install pynani --upgrade