filipmadejibm / bluemix-python-eve-sample-filipnew

Python Eve Sample Deploy Powered by IBM Bluemix

This project is a Python-Eve Framework application (Flask-based) backend deployed on IBM Bluemix™ that provides a practical illustration of setting up a python server REST API to support mobile workloads and integration with 3rd party API platforms. After deployment, you'll have a REST API server that can be populated with the IEEE MA-L Public Listing. Using the first three-octet addresses (XX-XX-XX or XXXXXX), a deploy like this could be used as a lookup API and supports guidance given on the IEEE site for individuals interested in querying the public listing to download and parse the data locally. Some use cases include identifying if a client MAC Address is associated with a particular organization and identifying what three-octet addresses does an organization own. This sort of API can be handy in conjunction with Internet of Things (IoT) data analytics where MAC address data is common.

Version

1.0

Deployment

• Live Demo

• Cloud [~10 mins == A publicly visible deploy in the cloud. Sweet!]

  

• Local Dev

  1. Clone this repository to your local machine

  2. Install and start a local MongoDB listening on default settings

  3. Run Application

     $ python macreduce/run.py

• Data Population

  1. To verify basic server access, browse to ...

     • http://localhost:5005/api/v1
     • http://{enter_your_bluemixhost}.mybluemix.net/api/v1

  2. Invoke the appropriate custom endpoint to populate your deployed application with MAC Address Data hosted from the IEEE organizations site. This endpoint is protected via basic authentication. This will take a few minutes to process.

     $ curl -u bluemix:devfun http://localhost:5005/populate

     $ curl -u bluemix:devfun http://{enter_your_bluemixhost}.mybluemix.net/populate

  3. Awesome. You now have a REST API server that can be used to cross-correlate the 3 leading pairs of a MAC Address with its owning Organization. Have fun. Here's an example of the type of query that you can try ...

  $ curl -g -X GET -H "Accept: application/json; charset=utf-8" -H "Cache-Control: no-cache" 'http://{your_host}.mybluemix.net/api/v1/mac?where={"organization":{"$regex":"^ibm.*?$","$options":"i"}}' 4. Fun Enhancement: Try to extend the model schema to also include the address information for an organization. Hint: You'll need to tweak the helper module which parses (and ignores the address info from) the IEEE raw data.

Assumptions/Limitations/Constraints

• Using Python 2.7.9 as declared in the runtime.txt file

Dependencies

Services

• MongoDB provided by MongoLabs
• Redis Cache provided by RedisCloud (Not needed for Local Dev/Deployment)

Key Python Modules and Frameworks

• Eve (Rest API framework)
• GEvent (WSGI Server wrapper around Flask to bolster performance)
• Requests (Module for invoking HTTP Requests to 3rd party platforms and APIs)

Useful Binaries and Platforms

• IBM Bluemix
• IBM DevOps Services
• flake8 to provide PEP8 code syntax testing
• nosetests to provide Unit testing support

License: Apache 2.0

Supporting Resources

Python-Eve Framework StackOverflow

IBM Bluemix

Python Buildpack

IEEE MA-L Public Listing

IEEE Public OUI Text Document - Updated Daily