README.rst

======================================================================
Optimization of the Traveling-Salesman Problem based on a RESTlike API
======================================================================

This module allows you to find the best route given a set of points defined by their longitude & latitude. 

The cost criteria

Only one criterion at the moment: the distance between the requested points
Other cost criteria could be considered in future version

Requirements:

* cornice (1.0.0)
* waitress (0.8.9)
* python-gflags
* ortools
* gpsdistance (for testings only)

Launch with::

 $ python pserve.py development.ini --reload

Components
==========

The **REST API** lives in *views.py*.

Clients contact the tsp via REST/Json requests, on the three main views:

* / (POST for obtaining the route given a set of pairs of (latitude, longitude) coordinates)
* /credentials (POST for creating a new user - token -)
* /credentials (DELETE for removing a user)