.. _installation:

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

If you would like to run the service locally, there are multiple ways. It is like installing any flask app.

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

Requiremets are flask and python to run. The explicit depedencies are listed in `requirements.txt <https://github.com/Jai-Chaudhary/pig-latin-translation-microservice/blob/master/requirements.txt>`_

----------
Dockerfile
----------
You would need to install `docker <https://docs.docker.com/>`_.

.. code-block:: guess

  docker pull ja1chaudhary/pig-latin-translation-service
  docker run --name pig-latin-service -p 8000:8000 -d ja1chaudhary/pig-latin-translation-service

---------------
Python Package
---------------
To install the python package, directly


.. code-block:: guess

  pip install piglatintranslation

-------
Source
-------
To install from source

.. code-block:: guess

  git clone https://github.com/Jai-Chaudhary/pig-latin-translation-microservice
  cd pig-latin-translation-microservice
  python setup.py install
  python run.py

--------
Testing
--------
To run test cases, simply do

.. code-block:: guess

   python tests.py

The `travis code integration <https://travis-ci.org/Jai-Chaudhary/pig-latin-translation-microservice>`_ config automatically runs those tests on updates to master branch