leftright

Diff binary files over HTTP

leftright REST API is the new web platform to compare two strings.

It runs using Tornado Web, one of the main python asynchronous networking library. It uses non-blocking network I/O and can scale for thousand of requests under right server conditions.

Hope you enjoy!

Preparing your environment

The bash way

$ git clone https://github.com/apast/leftright.git leftright
$ cd leftright
# run the following script:
$ bash leftright.sh

The pythonic way

If you prefer to run by your own, you can run the following commands:

$ . venv/bin/activate
$ pip install -r requirements.pip
$ cd src
$ python -m leftright

Some more details about command line interface

For some help, you can run:

$ python -m leftright -h

Using the tool

# Registering a new string to left side
$ curl -XPOST -vv http://localhost:8080/v1/diff/abc/left/Y29udGVudHJpa25hc2tqZGxhbWRsa3Nh

# Retrieving string from left side
$ curl -XGET -vv http://localhost:8080/v1/diff/abc/left

# Registering a new string to right side
$ curl -XPOST -vv http://localhost:8080/v1/diff/abc/right/Y29udGVudHJpZ2h0

# Retrieving string from right side
$ curl -XGET -vv http://localhost:8080/v1/diff/abc/right

# Retrieving full diff report comparing left to right side
$ curl -XGET -vv http://localhost:8080/v1/diff/abc

Continuous Integration

Our Travis-CI dashboard is available and there you can following the most updated info about build status, branch evolution and tests & code coverage statuses:

Hope to achieve 100% including patch tornadoweb.ioloop.IOLoop ASAP! We are almost there!

Code Quality

Our dashboard for code quality is running over Code Climate platform and can be accessed here.

Stay in Touch

If you want to contact me, you can find me out at:

Acknowledges

Thanks for your time and consideration to read my how to and analyse my project!

For any issues, questions or ideas for improvement, it will be a pleasure to listen and share more with you!

apast / leftright

readme