Simple AWS Lambda proxy to handle API Gateway request
Project description
A simple proxy that can work on AWS Lambda as API-gateway proxy
Install
$ pip install -U pip
$ pip install lambda-proxyOr install from source:
$ git clone https://github.com/vincentsarag/lambda-proxy.git
$ cd lambda-proxy
$ pip install -U pip
$ pip install -e .Usage
With GET request
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<id>', methods=['GET'], cors=True)
>>> def print_id(id):
return ('OK', 'plain/text', id)With POST request
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<id>', methods=['POST'], cors=True)
>>> def print_id(id, body):
return ('OK', 'plain/text', id)Binary responses
When working with binary on API-Gateway we must return a base64 encoded string
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<filename>.jpg', methods=['GET'], cors=True, binary_b64encode=True)
>>> def print_id(filename):
with open(f"{filename}.jpg", "rb") as f:
return ('OK', 'image/jpeg', f.read())Enable compression (happens only if “Accept-Encoding” if found in headers)
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<filename>.jpg', methods=['GET'], cors=True, binary_b64encode=True, payload_compression_method="gzip")
>>> def print_id(filename):
with open(f"{filename}.jpg", "rb") as f:
return ('OK', 'image/jpeg', f.read())Simple Auth token
Lambda-proxy provide a simple token validation system.
a “TOKEN” variable must be set in the environment
each request must provide a “access_token” params (e.g curl http://myurl/test/tests/myid?access_token=blabla)
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<id>', methods=['GET'], cors=True, token=True)
>>> def print_id(id):
return ('OK', 'plain/text', id)URL schema and request parameters
QueryString parameters are passed as function’s options.
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route('/test/tests/<id>', methods=['GET'], cors=True)
>>> def print_id(id, name=None):
return ('OK', 'plain/text', f"{id}{name}")requests:
>>> curl /test/tests/000001
0001
>>> curl /test/tests/000001?name=vincent
0001vincentContext and Event passing
Pass event and context to the handler function.
>>> from lambda_proxy.proxy import API
>>> APP = API(app_name="app")
>>> @APP.route("/<id>", methods=["GET"], cors=True)
>>> @APP.pass_event
>>> @APP.pass_context
>>> def print_id(ctx, evt, id):
print(ctx)
print(evt)
return ('OK', 'plain/text', f"{id}")Examples
Contribution & Devellopement
Issues and pull requests are more than welcome.
Dev install & Pull-Request
$ git clone https://github.com/vincentsarago/lambda-proxy.git
$ cd lambda-proxy
$ pip install -e .[dev]Python >3.6 only
- This repo is set to use pre-commit to run flake8, pydocstring and
black (“uncompromising Python code formatter”) when committing new code.
$ pre-commit install
$ git add .
$ git commit -m'my change'
black....................................................................Passed
Flake8...................................................................Passed
Verifying PEP257 Compliance..............................................Passed
$ git push originLicense
See LICENSE.txt.
Changes
See CHANGES.txt.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file lambda_proxy-2.0.4.tar.gz.
File metadata
- Download URL: lambda_proxy-2.0.4.tar.gz
- Upload date:
- Size: 9.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 65e476312dc11e4b75a49344c468572a88875aa2faa771a2b5ab37cf235aea0b |
|
| MD5 | 42d0af67eb7cf7eabe0e77f9e39a2120 |
|
| BLAKE2b-256 | 1b16e2d16d982216ceec42cfdd1ec523d42d208005f047941cd792a22936cceb |
