Expand on the Projects `Readme.md` / Quickstart

[michaelbrewer]

What were you initially searching for in the docs?

A quick start guide on the GitHub main page for AWS Lambda Powertools

Is this related to an existing part of the documentation? Please share a link

• README.md

Describe how we could make it clearer

Add a basic getting started guide with a couple simple examples for logger, tracer and maybe metrics. Once a developer got a taste of the library, they can still visit the full documentation site.

If you have a proposed update, please share it here

• Add a very quick guide for starting a new project with Powertools (maybe using AWS SAM CLI)
• Add a couple very basic examples that covers the make features of Powertools

from aws_lambda_powertools import Logger, Tracer
from aws_lambda_powertools.logging import correlation_paths
from aws_lambda_powertools.event_handler.api_gateway import ApiGatewayResolver

tracer = Tracer()
logger = Logger()
app = ApiGatewayResolver()

@app.get("/hello")
@tracer.capture_method
def get_hello_universe():
    return {"message": "hello universe"}

@logger.inject_lambda_context(correlation_id_path=correlation_paths.API_GATEWAY_REST)
@tracer.capture_lambda_handler
def lambda_handler(event, context):
    return app.resolve(event, context)

[heitorlessa]

Great idea actually. perhaps we should go back to the idea of having an examples folder with every utility using a dummy example (e.g. payments, booking) along with Infra.

[heitorlessa]

Agreed that Michal would be looking at it cc @mploski

[michaelbrewer]

As an example Chalice has quite a nice readme https://github.com/aws/chalice

[heitorlessa]

This is now released as part of 1.24.1 ;) https://github.com/awslabs/aws-lambda-powertools-python/releases/tag/v1.24.1

[michaelbrewer]

one thing missing is still a bit more of a taster on the github landing page (aka the actual readme), but this tutorial is really cool