Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Python package to add compatibility between Flask and AWS Lambda for creating RESTful applications.

Project description

Flask-Lambda2

Flask-Lambda2 is a python package to add a compatibility layer between a Flask application and AWS Lambda for creating RESTful applications.

This package is opinionated, in that “it locks or guides you into [our] way of doing things” or “doesn’t make it easy to diverse from [our] golden path.”

Installation

$ pip install flask-lambda2

Requirements

The main assumption here is that your project can comfortably and reasonably fit into a single endpoint, or you separate your Lambda functions to group certain, related API endpoints together.

Firstly, ensure your Lambda handler is set to project_api.app, where project_api is the filename (excluding the .py extension) containing your project’s API endpoint implementations and where app is the Flask instance (actually a FlaskLambda instance) with which you have added the URL rules onto.

Lastly, ensure that invokation convention from the location you plan to invoke the endpoints from roughly follows the calling convention shown below:

import boto3


client = boto3.client('lambda')
client.invoke(FunctionName='project_api',
              InvocationType='RequestResponse',
              Payload=json.dumps({'route':'/users/',
                                  'method':'get',
                                  'token':'123abc'}))

That’s it!

Tests

Tests are available in Flask-Lambda2/tests through invoking test.py with python test.py. Ensure all dependencies are installed through invoking pip install -r requirements.txt.

Functional Examples

GridLight-API

I have created a backend for a mobile application using this library, it’s source code is available here at the GridLight-API repository.

If you have any questions, feel free to e-mail me at pianka@eml.cc.

Built With

  • Flask - Micro web-framework based on Werkzeug and Jinja2

License

This project is licensed under the Apache 2.0 License - see the LICENSE.md file for details

Project details


Release history Release notifications

This version
History Node

2.0.0

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
flask_lambda2-2.0.0-py2.py3-none-any.whl (5.4 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Mar 14, 2018
flask-lambda2-2.0.0.tar.gz (3.6 kB) Copy SHA256 hash SHA256 Source None Mar 14, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page