Metadata-Version: 2.1
Name: mangum
Version: 0.6.13
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. It also provies an experimental CLI for handling deployments. This project may face periods of inactivity from time to time, but PRs are welcomed.
        
        **Documentation**: [https://erm.github.io/mangum](https://erm.github.io/mangum)
        
        ## Requirements
        
        Python 3.7+
        
        ## Installation
        
        ```shell
        pip3 install mangum[full]
        ```
        
        ## Usage
        
        The adapter class `Mangum` accepts the following optional arguments:
        
        - `debug` : bool (default=False)
            
            Enable a simple error response if an unhandled exception is raised in the adapter.
        
        
        - `spec_version` : int (default=3)
            
            Set the ASGI specification version. ASGI 3 uses a single-callable, ASGI 2 uses a double-callable.
        
        - `enable_lifespan` : bool (default=True)
            
            Specify whether or not to enable lifespan support.
        
        ### 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
        ```
        
        
        ## Frameworks
        
        Any ASGI framework should work with Mangum, however there are cases where certain non-ASGI behaviour of an application will cause issues when deploying to a serverless platform. You may also need to specify `spec_version=2` for frameworks that do not support the latest ASGI version.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
Provides-Extra: full
