.. _install:

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

This part of the documentation covers the requirements and installation of sail-on client.

Requirements
------------

1. `Python`_ >= 3.7
2. `Poetry`_ >= 1.1.0

Installation
------------

Setup Poetry
^^^^^^^^^^^^

1. Install Poetry following the instructions available in the `installation page`_.


Installation with Poetry
^^^^^^^^^^^^^^^^^^^^^^^^

1. Clone the `sail-on-client`_ repository in your working directory::

      git clone https://github.com/darpa-sail-on/sail-on-client.git

   This would create sail-on-client directory in your working directory

2. Install sail-on-client in a virtual environment::

      cd sail-on-client
      poetry install
      poetry shell


.. Appendix 1: Links

.. _Python: https://www.python.org/downloads/release/python-370/
.. _installation page: https://python-poetry.org/docs/#installation
.. _Poetry: https://github.com/python-poetry/poetry
.. _sail-on-client: https://github.com/darpa-sail-on/sail-on-client