Usage
#####

The expected usage of this service is through python to execute automated builds and automate the following steps.

However for purposes of this explanation we shall show manually executing a compilation through the web browser and windows explorer.

The steps to run a compilation are:
- Start a session with the service via HTTP
- Load your C++ and Makefile files to the session directory
- Execute the compilation
- Retrieve the results

To start a session with the HTTP instance, send it the REST API command start_session:

.. image:: _static/imgs/usage_1.png
  :alt: Getting session instance

The server returns the session instance.

Now the FTP Folder contains a folder for our session to use:

.. image:: _static/imgs/usage_2.png
  :alt: Getting FTP Folder

.. note:: Windows Explorer doesn't request authentication which is required to place and get files so you should now switch to another tool like FileZilla so you can login.

.. image:: _static/imgs/usage_3.png
  :alt: Send FTP files

Next execute the test by sending the REST command run_session with the session id:

.. image:: _static/imgs/usage_4.png
  :alt: Execute test

Once the test is completed, you will be able to retrieve the output build files from the server:

.. image:: _static/imgs/usage_5.png
  :alt: Get files