Metadata-Version: 2.1
Name: mangum
Version: 0.7.0
Summary: AWS Lambda & API Gateway support for ASGI
Home-page: https://github.com/erm/mangum
Author: Jordan Eremieff
Author-email: jordan@eremieff.com
License: MIT
Description: # Mangum
        
        <a href="https://pypi.org/project/mangum/">
            <img src="https://badge.fury.io/py/mangum.svg" alt="Package version">
        </a>
        <a href="https://travis-ci.org/erm/mangum">
            <img src="https://travis-ci.org/erm/mangum.svg?branch=master" alt="Build Status">
        </a>
        
        Mangum is an adapter for using [ASGI](https://asgi.readthedocs.io/en/latest/) applications with AWS Lambda & API Gateway.
        
        **Documentation**: [https://erm.github.io/mangum](https://erm.github.io/mangum)
        
        ## Requirements
        
        Python 3.6+
        
        ## Installation
        
        ```shell
        pip3 install mangum
        ```
        
        ## Usage
        
        The adapter class `Mangum` accepts the following optional arguments:
        
        - `enable_lifespan` : bool (default=True)
            
            Specify whether or not to enable lifespan support.
        
        - `api_gateway_base_path` : str (default=None)
            
            Base path to strip from URL when using a custom domain name.
        
        ### Event and context
        
        The AWS Lambda handler has `event` and `context` parameters. These are available in the ASGI `scope` object:
        
        ```python3
        scope['aws.event']
        scope['aws.context']
        ```
        
        ### Example
        
        ```python3
        from mangum import Mangum
        
        async def app(scope, receive, send):
            await send(
                {
                    "type": "http.response.start",
                    "status": 200,
                    "headers": [[b"content-type", b"text/plain; charset=utf-8"]],
                }
            )
            await send({"type": "http.response.body", "body": b"Hello, world!"})
        
        
        handler = Mangum(app, enable_lifespan=False) # disable lifespan for raw ASGI example
        ```
        
        ## WebSockets (experimental)
        
        The adapter currently provides some basic WebSocket support using `boto3` with [DynamoDB](https://aws.amazon.com/dynamodb/). To install Mangum with the optional dependency:
        
        ```shell
        pip3 install mangum[full]
        ```
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: full
