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

This page will help you install the Tyba Python Client.

Install the Python Client
-------------------------

#. Make sure you have python 3.8 or later installed. You can follow the instructions
   `here <https://wiki.python.org/moin/BeginnersGuide/Download>`__ to do so.

#. Install the Tyba python client

   .. code-block:: console

        pip install tyba-client

#. Upgrade the Tyba python client

   .. code-block:: console

        pip install --upgrade tyba-client

   .. _install_upgrade_deps:

#. Install/upgrade client dependencies

   The Tyba Python Client has two important Tyba-maintained dependencies (``generation_models`` and
   ``project_finance``). These should be installed as part of the pip-installation of the client, but in the event
   they are not, you can easily install them with pip, e.g.

   .. code-block:: console

        pip install generation-models

   Note that in the pip index they are called ``generation-models`` and ``tyba-financial-model``, respectively.

   Perhaps more useful, as we make improvements to the client and its dependencies, you will need to update them to
   access the latest features. Again, this can be achieved via pip, e.g.

   .. code-block:: console

        pip install --upgrade generation-models

Install JupyterLab (recommended)
----------------------------------------

`Jupyterlab <https://jupyter.org/>`_ is a browser-based interactive computing application that allows you to
execute code, visualize results, and annotate your process in easily shareable "notebooks". We recommend Jupyterlab to
streamline the execution of your Python Client code. Installation instructions can be found
`here <https://jupyter.org/install>`_.

Version History
---------------

`PyPi Package History <https://www.notion.so/Client-Installation-72c44ccae0214764962cec77a08d24a5?pvs=21>`_ (external link)

.. TODO: Should do something about this, can't be accurate anymore. Either delete or find a way to generate version
   history/changelogs