Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sloev/python-lambdarest
Flask like web framework for AWS Lambda
https://github.com/sloev/python-lambdarest
aws aws-lambda balancer framework json-schema lambda pypi python routing werkzeug
Last synced: about 1 month ago
JSON representation
Flask like web framework for AWS Lambda
- Host: GitHub
- URL: https://github.com/sloev/python-lambdarest
- Owner: sloev
- License: mit
- Created: 2017-02-07T15:30:04.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-03-08T21:03:10.000Z (over 1 year ago)
- Last Synced: 2024-09-29T08:41:43.502Z (about 1 month ago)
- Topics: aws, aws-lambda, balancer, framework, json-schema, lambda, pypi, python, routing, werkzeug
- Language: Python
- Homepage: https://sloev.github.io/python-lambdarest/
- Size: 1.44 MB
- Stars: 94
- Watchers: 35
- Forks: 23
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
 [](https://pypi.python.org/pypi/lambdarest) [](https://pypi.python.org/pypi/lambdarest)
# lambdarest 
Python routing mini-framework for [AWS Lambda](https://aws.amazon.com/lambda/) with optional JSON-schema validation.
### Features
* `lambda_handler` function constructor with built-in dispatcher
* Decorator to register functions to handle HTTP methods
* Optional JSON-schema input validation using same decorator
### Merchandise ❤️
You can support the development by [buying a wonderful cup](https://www.redbubble.com/i/mug/Lambdarest-by-sloev/73793554.9Q0AD) or [buy coffee for the maintainers cup](https://buymeacoffee.com/sloev)
[](https://www.redbubble.com/i/mug/Lambdarest-by-sloev/73793554.9Q0AD)
### External articles / tutorials
* [devgrok.com: Create a Private Microservice Using an Application Load Balancer](http://www.devgrok.com/2019/03/create-private-microservice-using.html)
Article about how to use **lambdarest** with **AWS Application Load Balancer**
* [rockset.com: Building a Serverless Microservice Using Rockset and AWS Lambda](https://rockset.com/blog/building-a-serverless-microservice-using-rockset-and-aws-lambda/)
Article about how to set up **lambdarest** in AWS infrastructure
**Other articles? add them [here](https://github.com/trustpilot/python-lambdarest/issues/55)**
## Installation
Install the package from [PyPI](http://pypi.python.org/pypi/) using [pip](https://pip.pypa.io/):
```bash
$ pip install lambdarest
```
## Getting Started
This module helps you to handle different HTTP methods in your AWS Lambda.
```python
from lambdarest import lambda_handler
@lambda_handler.handle("get")
def my_own_get(event):
return {"this": "will be json dumped"}
##### TEST #####
input_event = {
"body": '{}',
"httpMethod": "GET",
"resource": "/"
}
result = lambda_handler(event=input_event)
assert result == {"body": '{"this": "will be json dumped"}', "statusCode": 200, "headers":{}}
```
## Documentation
See [docs](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md) for **documentation and examples** covering amongst:
* [Advanced usage example](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#advanced-usage)
* [Query params](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#query-params)
* [Headers and MultiValueHeaders](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#headers-and-multivalueheaders)
* [Routing](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#routing)
* [Authorization Scopes](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#authorization-scopes)
* [Exception Handling](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#exception-handling)
* [AWS Application Load Balancer](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#aws-application-load-balancer)
* [CORS](https://github.com/trustpilot/python-lambdarest/blob/master/docs/README.md#cors)
## Anormal unittest behaviour with `lambda_handler` singleton
Because of python unittests leaky test-cases it seems like you shall beware of [this issue](https://github.com/trustpilot/python-lambdarest/issues/16) when using the singleton `lambda_handler` in a multiple test-case scenario.
## Tests
Use the following commands to install requirements and run test-suite:
```bash
$ pip install -e ".[dev]"
$ black tests/ lambdarest/
$ rm -f test_readme.py
$ pytest --doctest-modules -vvv
```
For more info see [Contributing...](https://github.com/trustpilot/python-lambdarest/blob/master/docs/CONTRIBUTING.md)
## Changelog
See [HISTORY.md](https://github.com/trustpilot/python-lambdarest/blob/master/docs/HISTORY.md)
## Contributors
Thanks for contributing!
[@sphaugh](https://github.com/sphaugh), [@amacks](https://github.com/amacks), [@jacksgt](https://github.com/jacksgt), [@mkreg](https://github.com/mkreg), [@aphexer](https://github.com/aphexer), [@nabrosimoff](https://github.com/nabrosimoff), [@elviejokike](https://github.com/elviejokike), [@eduardomourar](https://github.com/eduardomourar), [@devgrok](https://github.com/devgrok), [@AlbertoTrindade](https://github.com/AlbertoTrindade), [@paddie](https://github.com/paddie), [@svdgraaf](https://github.com/svdgraaf), [@simongarnier](https://github.com/simongarnier), [@martinbuberl](https://github.com/martinbuberl), [@adamelmore](https://github.com/adamelmore), [@sloev](https://github.com/sloev)
[Wanna contribute?](https://github.com/trustpilot/python-lambdarest/blob/master/docs/CONTRIBUTING.md)
And by the way, we have a [Code Of Friendlyhood!](https://github.com/trustpilot/python-lambdarest/blob/master/docs/CODE_OF_CONDUCT.md)
## FAQ
* Where is all the old versions?
they are gone see more here: https://github.com/sloev/python-lambdarest/issues/94
* What can i do to get the attention of the maintainer? see more here: https://github.com/sloev/python-lambdarest#merchandise