Skip to content

Commit 19b7d11

Browse files
📝 Update README to note function URLs, remove unmaintained release notes in mkdocs (for now).
1 parent b85cd4a commit 19b7d11

4 files changed

Lines changed: 8 additions & 86 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
</a>
99
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/mangum.svg?style=flat-square">
1010

11-
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.
11+
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.
1212

1313
***Documentation***: https://mangum.io/
1414

1515
## Features
1616

17-
- 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).
17+
- 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).
1818

1919
- Compatibility with ASGI application frameworks, such as [Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), and [Quart](https://pgjones.gitlab.io/quart/).
2020

@@ -50,7 +50,7 @@ async def app(scope, receive, send):
5050
await send({"type": "http.response.body", "body": b"Hello, world!"})
5151

5252

53-
handler = Mangum(app)
53+
handler = Mangum(app, lifespan="off")
5454
```
5555

5656
Or using a framework:
@@ -71,5 +71,5 @@ def read_root():
7171
def read_item(item_id: int, q: str = None):
7272
return {"item_id": item_id, "q": q}
7373

74-
handler = Mangum(app)
74+
handler = Mangum(app, lifespan="off")
7575
```

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@
88
</a>
99
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/mangum.svg?style=flat-square">
1010

11-
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.
11+
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.
1212

1313
***Documentation***: https://mangum.io/
1414

1515
## Features
1616

17-
- 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).
17+
- 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).
1818

1919
- Compatibility with ASGI application frameworks, such as [Starlette](https://www.starlette.io/), [FastAPI](https://fastapi.tiangolo.com/), and [Quart](https://pgjones.gitlab.io/quart/).
2020

@@ -50,7 +50,7 @@ async def app(scope, receive, send):
5050
await send({"type": "http.response.body", "body": b"Hello, world!"})
5151

5252

53-
handler = Mangum(app)
53+
handler = Mangum(app, lifespan="off")
5454
```
5555

5656
Or using a framework:
@@ -71,5 +71,5 @@ def read_root():
7171
def read_item(item_id: int, q: str = None):
7272
return {"item_id": item_id, "q": q}
7373

74-
handler = Mangum(app)
74+
handler = Mangum(app, lifespan="off")
7575
```

docs/release-notes.md

Lines changed: 0 additions & 77 deletions
This file was deleted.

mkdocs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ nav:
2020
- ASGI Frameworks: "asgi-frameworks.md"
2121
- External Links: "external-links.md"
2222
- Contributing: "contributing.md"
23-
- Release Notes: "release-notes.md"
2423

2524
markdown_extensions:
2625
- mkautodoc

0 commit comments

Comments
 (0)