diff --git a/README.md b/README.md index af6ba7a5..2c2ce1e0 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ PyPI - Python Version -Mangum is an adapter for running [ASGI](https://asgi.readthedocs.io/en/latest/) applications in AWS Lambda to handle API Gateway, ALB, and Lambda@Edge events. +Mangum is an adapter for running [ASGI](https://asgi.readthedocs.io/en/latest/) applications in AWS Lambda to handle Function URL, API Gateway, ALB, and Lambda@Edge events. ***Documentation***: https://mangum.io/ ## Features -- Event handlers for API Gateway [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) and [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) APIs, [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html), and [CloudFront Lambda@Edge](https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html). +- Event handlers for API Gateway [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) and [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) APIs, [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html), [Function URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html), and [CloudFront Lambda@Edge](https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html). - Compatibility with ASGI application frameworks, such as [Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), and [Quart](https://pgjones.gitlab.io/quart/). @@ -50,7 +50,7 @@ async def app(scope, receive, send): await send({"type": "http.response.body", "body": b"Hello, world!"}) -handler = Mangum(app) +handler = Mangum(app, lifespan="off") ``` Or using a framework: @@ -71,5 +71,5 @@ def read_root(): def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} -handler = Mangum(app) +handler = Mangum(app, lifespan="off") ``` diff --git a/docs/index.md b/docs/index.md index af6ba7a5..2c2ce1e0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,13 +8,13 @@ PyPI - Python Version -Mangum is an adapter for running [ASGI](https://asgi.readthedocs.io/en/latest/) applications in AWS Lambda to handle API Gateway, ALB, and Lambda@Edge events. +Mangum is an adapter for running [ASGI](https://asgi.readthedocs.io/en/latest/) applications in AWS Lambda to handle Function URL, API Gateway, ALB, and Lambda@Edge events. ***Documentation***: https://mangum.io/ ## Features -- Event handlers for API Gateway [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) and [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) APIs, [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html), and [CloudFront Lambda@Edge](https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html). +- Event handlers for API Gateway [HTTP](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api.html) and [REST](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-rest-api.html) APIs, [Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/lambda-functions.html), [Function URLs](https://docs.aws.amazon.com/lambda/latest/dg/lambda-urls.html), and [CloudFront Lambda@Edge](https://docs.aws.amazon.com/lambda/latest/dg/lambda-edge.html). - Compatibility with ASGI application frameworks, such as [Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), and [Quart](https://pgjones.gitlab.io/quart/). @@ -50,7 +50,7 @@ async def app(scope, receive, send): await send({"type": "http.response.body", "body": b"Hello, world!"}) -handler = Mangum(app) +handler = Mangum(app, lifespan="off") ``` Or using a framework: @@ -71,5 +71,5 @@ def read_root(): def read_item(item_id: int, q: str = None): return {"item_id": item_id, "q": q} -handler = Mangum(app) +handler = Mangum(app, lifespan="off") ``` diff --git a/docs/release-notes.md b/docs/release-notes.md deleted file mode 100644 index b0338acf..00000000 --- a/docs/release-notes.md +++ /dev/null @@ -1,77 +0,0 @@ -## 0.12.3 - -* Fix unhandled `api_gateway_base_path` in `AwsHttpGateway`. [#200](https://github.com/jordaneremieff/mangum/pull/204). Thanks [xpayn](https://github.com/xpayn)! - -## 0.12.2 - -* Exclude `tests/` directory from package. [#200](https://github.com/jordaneremieff/mangum/pull/200). Thanks [bradsbrown](https://github.com/bradsbrown)! - -## 0.12.1 - -* Make `boto3` optional [#197](https://github.com/jordaneremieff/mangum/pull/197). - -## 0.12.0 - -* Reintroduce WebSocket support [#190](https://github.com/jordaneremieff/mangum/pull/190). Thanks [eduardovra](https://github.com/eduardovra)! - -* Resolve several issues with ALB/ELB support [#184](https://github.com/jordaneremieff/mangum/pull/184), [#189](https://github.com/jordaneremieff/mangum/pull/189), [#186](https://github.com/jordaneremieff/mangum/pull/186), [#182](https://github.com/jordaneremieff/mangum/pull/182). Thanks [nathanglover](https://github.com/nathanglover) & [jurasofish](https://github.com/jurasofish)! - -* Refactor handlers to be separate from core logic [#170](https://github.com/jordaneremieff/mangum/pull/170). Thanks [four43](https://github.com/four43)! - -## 0.11.0 - -* Remove deprecated `enable_lifespan` parameter [#109](https://github.com/jordaneremieff/mangum/issues/109). - -* Include API Gateway v2 event cookies in scope headers [#153](https://github.com/jordaneremieff/mangum/pull/153). Thanks [araki-yzrh](https://github.com/araki-yzrh)! - -* Support ELB and fix APIGW v2 cookies response [#155](https://github.com/jordaneremieff/mangum/pull/155). Thanks [araki-yzrh](https://github.com/araki-yzrh)! - -* Add flake8 to CI checks [#157](https://github.com/jordaneremieff/mangum/pull/157). Thanks [emcpow2](https://github.com/emcpow2)! - -* Add type hints for lambda handler context parameter [#158](https://github.com/jordaneremieff/mangum/pull/158). Thanks [emcpow2](https://github.com/emcpow2)! - -* Extract ASGI scope creation into function [#162](https://github.com/jordaneremieff/mangum/pull/162). Thanks [emcpow2](https://github.com/emcpow2)! - -## 0.10.0 - -* Remove WebSocket support to focus on HTTP [#127](https://github.com/jordaneremieff/mangum/issues/127). - -* Support multiValue headers in response [#129](https://github.com/jordaneremieff/mangum/pull/129). Thanks [@koxudaxi](https://github.com/koxudaxi)! - -* Fix duplicate test names [#134](https://github.com/jordaneremieff/mangum/pull/134). Thanks [@a-feld](https://github.com/a-feld)! - -* Run tests and release package using GitHub Actions [#131](https://github.com/jordaneremieff/mangum/issues/131). Thanks [@simonw](https://github.com/simonw)! - -* Only prefix a slash on the api_gateway_base_path if needed [#138](https://github.com/jordaneremieff/mangum/pull/138). Thanks [@dspatoulas](https://github.com/dspatoulas)! - -* Add support to Brotli compress [#139](https://github.com/jordaneremieff/mangum/issues/139). Thanks [@fullonic](https://github.com/fullonic)! - -## 0.9.2 - -* Make boto3 dependency optional [#115](https://github.com/jordaneremieff/mangum/pull/115) - -## 0.9.1 - -* Bugfix lifespan startup behaviour and refactor lifespan cycle, deprecate `enable_lifespan` parameter, document protocols. [#108](https://github.com/jordaneremieff/mangum/pull/108) - -## 0.9.0 - -* Resolve issue with `rawQueryString` in HTTP APIs using wrong type [#105](https://github.com/jordaneremieff/mangum/issues/105) - -* Implement new WebSocket storage backends for managing connections (PostgreSQL, Redis, DyanmoDB, S3, SQlite) using a single `dsn` configuration parameter [#103](https://github.com/jordaneremieff/mangum/pull/103) - -## pre-0.9.0 - -I did not maintain a CHANGELOG prior to 0.9.0, however, I still would like to include a thank you to following people: - -[@lsorber](https://github.com/lsorber) -[@SKalt](https://github.com/SKalt) -[@koxudaxi](https://github.com/koxudaxi) -[@zachmullen](https://github.com/zachmullen) -[@remorses](https://github.com/remorses) -[@allan-simon](https://github.com/allan-simon) -[@jaehyeon-kim](https://github.com/jaehyeon-kim) - -Your contributions to previous releases have greatly improved this project and are very much appreciated. - -Special thanks to [@tomchristie](https://github.com/tomchristie) for all of his support, encouragement, and guidance early on, and [@rajeev](https://github.com/rajeev) for inspiring this project. diff --git a/mkdocs.yml b/mkdocs.yml index e929207c..80c94abe 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,7 +20,6 @@ nav: - ASGI Frameworks: "asgi-frameworks.md" - External Links: "external-links.md" - Contributing: "contributing.md" - - Release Notes: "release-notes.md" markdown_extensions: - mkautodoc