/serverless-builder

Python interface to easily generate serverless.yml.

Primary LanguagePythonMIT LicenseMIT

serverless-builder

PyPI Python License

Python interface to easily generate serverless.yml file.

To read more about features, visit 📜 our documentation.

Installation

pip install serverless-builder

Features

  • plugin management with autoconfiguration
  • function factory with some best practice hints
  • autoconfiguration of some provider specific features like AWS X-Ray
  • easy resource manipulation with troposphere lib (but if you want you can use old good dict)
  • easier IAM management with predefined permission sets
  • built-in support for any serverless attributes
  • integration with aws lambda powertools

Example of use

from serverless.aws.functions.event_bridge import RetryPolicy
from serverless.aws.functions.http import HTTPFunction
from serverless import Service
from serverless.provider import AWSProvider
from serverless.aws.features import XRay
from serverless.aws.iam.dynamodb import DynamoDBReader
from serverless.plugins import ComposedVars, PythonRequirements, Prune

from troposphere.dynamodb import Table, AttributeDefinition, KeySchema

service = Service(
    "service-name",
    "some dummy service",
    AWSProvider()
)
service.plugins.add(ComposedVars())
service.plugins.add(Prune())
service.plugins.add(PythonRequirements())

table = Table(
    "TestTable",
    BillingMode="PAY_PER_REQUEST",
    AttributeDefinitions=[
        AttributeDefinition(AttributeName="name", AttributeType="S")
    ],
    KeySchema=[KeySchema(AttributeName="name", KeyType="HASH")]
)

service.enable(XRay())
service.provider.iam.apply(DynamoDBReader(table))

service.builder.function.generic("test", "description")
service.builder.function.http("test", "description", "/", HTTPFunction.POST)

# Multiple events with different paths and/or methods can be set up for the same handler
# This will add the same handler to all of these: POST /, POST /alias, PUT /, PUT /alias
service.builder.function.http("test", "description", ["/", "/alias"], ["POST", "PUT"], handler="shared.handler")

# Context with pre-defined setup
with service.preset(
    layers=[{"Ref": "PythonRequirementsLambdaLayer"}],
    handler="test.handlers.custom_handler.handle"
) as p:
    p.http_get("test-list", "List all tests", "/")
    p.http_get("test-get", "Get one test", "/{test_id}")

event_bridge_function = service.builder.function.event_bridge(
    "event_bridge_function",
    "sample event bridge function",
    "epsy",
    {"source": ["saas.external"]},
)

event_bridge_function.use_delivery_dlq(RetryPolicy(5, 300))
event_bridge_function.use_async_dlq()

service.resources.add(table)

service.render()

New version release process

  • Update the version in pyproject.toml

    # increase the version number as per SemVer standards
version = "2.13.17"

  • Once ready to publish, create a new github release

    • its a good practice to match the tag with the version number as in pyproject.toml
    • Select set as latest release checkbox
    • Click Publish Release button.

  • Once published, it will trigger the release gh wf and publish the latest package to PyPi.