Skip to content

Commit c43a5e8

Browse files
authored
Merge pull request #769 from mploski/docs/quick-start
docs(tutorial): add new tutorial covering core features
2 parents 38c70b9 + e5e23d1 commit c43a5e8

10 files changed

+1050
-5
lines changed

Diff for: README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
A suite of Python utilities for AWS Lambda functions to ease adopting best practices such as tracing, structured logging, custom metrics, and more. (AWS Lambda Powertools [Java](https://github.com/awslabs/aws-lambda-powertools-java) and [Typescript](https://github.com/awslabs/aws-lambda-powertools-typescript) is also available).
88

9-
**[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Quick hello world example](https://github.com/aws-samples/cookiecutter-aws-sam-python)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**
9+
**[📜Documentation](https://awslabs.github.io/aws-lambda-powertools-python/)** | **[🐍PyPi](https://pypi.org/project/aws-lambda-powertools/)** | **[Roadmap](https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1)** | **[Detailed blog post](https://aws.amazon.com/blogs/opensource/simplifying-serverless-best-practices-with-lambda-powertools/)**
1010

1111
> **An AWS Developer Acceleration (DevAx) initiative by Specialist Solution Architects | [email protected]**
1212
@@ -27,12 +27,15 @@ A suite of Python utilities for AWS Lambda functions to ease adopting best pract
2727
* **[Idempotency](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/idempotency/)** - Convert your Lambda functions into idempotent operations which are safe to retry
2828
* **[Feature Flags](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/feature_flags/)** - A simple rule engine to evaluate when one or multiple features should be enabled depending on the input
2929

30+
3031
### Installation
3132

3233
With [pip](https://pip.pypa.io/en/latest/index.html) installed, run: ``pip install aws-lambda-powertools``
3334

34-
## Examples
3535

36+
## Tutorial and Examples
37+
38+
* [Tutorial](https://awslabs.github.io/aws-lambda-powertools-python/latest/tutorial)
3639
* [Serverless Shopping cart](https://github.com/aws-samples/aws-serverless-shopping-cart)
3740
* [Serverless Airline](https://github.com/aws-samples/aws-serverless-airline-booking)
3841
* [Serverless E-commerce platform](https://github.com/aws-samples/aws-serverless-ecommerce-platform)

Diff for: docs/media/cloudwatch_logs_insight_example.png

510 KB
Loading

Diff for: docs/media/metrics_utility_showcase.png

116 KB
Loading

Diff for: docs/media/tracer_utility_showcase_2.png

430 KB
Loading

Diff for: docs/media/tracer_utility_showcase_3.png

191 KB
Loading

Diff for: docs/media/tracer_xray_sdk_enriched.png

81.7 KB
Loading

Diff for: docs/media/tracer_xray_sdk_enriched_2.png

115 KB
Loading

Diff for: docs/media/tracer_xray_sdk_showcase.png

157 KB
Loading

Diff for: docs/tutorial.md

+1,041
Large diffs are not rendered by default.

Diff for: mkdocs.yml

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,16 @@ edit_uri: edit/develop/docs
77
nav:
88
- Homepage: index.md
99
- Changelog: changelog.md
10+
- Tutorial: tutorial.md
1011
- Roadmap: https://github.com/awslabs/aws-lambda-powertools-roadmap/projects/1" target="_blank
1112
- API reference: api/" target="_blank
1213
- Core utilities:
1314
- core/tracer.md
1415
- core/logger.md
1516
- core/metrics.md
1617
- Event Handler:
17-
- core/event_handler/appsync.md
18-
- core/event_handler/api_gateway.md
18+
- core/event_handler/appsync.md
19+
- core/event_handler/api_gateway.md
1920
- Utilities:
2021
- utilities/middleware_factory.md
2122
- utilities/parameters.md
@@ -64,7 +65,7 @@ markdown_extensions:
6465
- pymdownx.superfences
6566
- pymdownx.details
6667
- pymdownx.snippets:
67-
base_path: '.'
68+
base_path: "."
6869
check_paths: true
6970
- meta
7071
- toc:

0 commit comments

Comments
 (0)