Skip to main content

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


Download files

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

Source Distribution

flask-lambda2-2.0.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

flask_lambda2-2.0.0-py2.py3-none-any.whl (5.4 kB view details)

Uploaded Python 2Python 3

File details

Details for the file flask-lambda2-2.0.0.tar.gz.

File metadata

  • Download URL: flask-lambda2-2.0.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for flask-lambda2-2.0.0.tar.gz
Algorithm Hash digest
SHA256 887e7cbc11504511d87288bdef0dcbfa5c39aed187edbbe321d189f8e2cb1b98
MD5 e174bd875233be53973a40131dc90925
BLAKE2b-256 b3a73f97356b529f39fb07db863fdc646b543f9e38e9fe87024ae6beca5d5cec

See more details on using hashes here.

File details

Details for the file flask_lambda2-2.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for flask_lambda2-2.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 8ac78409668d8be9c1b31383baa110d9709febe63274d2c0c7eb330426e41f58
MD5 3fea2204f26cf76a77ebc0bd4c30c0b3
BLAKE2b-256 3649f67b0970590a8b136b206643240406bd438639da1ca41109b0038d40ed9b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page