plumbing-shannon-server

A simple Flask-based HTTP pony server for extracting "Shannon-related" properties from images.

Install

python ./setup.py install

Example

The setup.py script will install the shannon-server.py in /usr/local/bin (or your operating system's equivalent) but you can also run it directly like this:

python ./script/shannon-server.py -c server.cfg
INFO:werkzeug: * Running on http://127.0.0.1:5000/

setenv SHANNON_SERVER_CONFIG server.cfg
python ./scripts/shannon-server.py
INFO:werkzeug: * Running on http://127.0.0.1:5000/

You can also run shannon-server from any WSGI-compliant container-server-thing-y. Consult the init.d folder for an example of how to use shannon-server with gunicorn.

Endpoints

GET /ping

curl -X GET 'http://localhost:5000/ping'

{
	"stat": "ok"
}

GET /entropy

curl -X GET 'http://localhost:5000/entropy?file=test.png'

{
	"entropy": 9.386720101697886, 
}

POST /entropy

curl -X POST -F 'file=@/tmp/test.jpg' 'http://localhost:5000/entropy'

{
	"entropy": 9.386720101697886, 
}

GET /focalpoint

curl -X GET 'http://localhost:5000/focalpoint?file=test.png'

{
	"entropy": 9.386720101697886, 
	"h": 480, 
	"w": 640, 
	"x": 100, 
	"y": 180
}

POST /focalpoint

curl -X POST -F 'file=@/tmp/test.jpg' 'http://localhost:5000/focalpoint'

{
	"entropy": 9.386720101697886, 
	"h": 480, 
	"w": 640, 
	"x": 100, 
	"y": 180
}

Config

plumbing-shannon-server uses utility functions exported by the cooperhewitt.flask.http_pony library which checks your Flask application's configuration for details about how to handle things.

The following settings should be added to a standard ini style configutation file.

[flask]

port

The Unix TCP port you want your Flask server to listen on.

[http_pony]

local_path_root

If set then files sent using an HTTP GET parameter will be limited to only those that are are parented by this directory.

If it is not set then HTTP GET requests will fail.

upload_path_root

If set then files sent as an HTTP POST request will be first written to this directory before processing.

If not set then the operating system's temporary directory will be used.

allowed_extensions

A comma-separate list of valid file extensions for processing.

straup / plumbing-shannon-server Goto Github PK