hatch-aws 0.2.0

Hatch plugin for building AWS Lambda functions with SAM

hatch-aws

AWS builder plugin for Hatch 🥚🐍. Hatch is modern, extensible Python project manager.

---

Table of Contents

• hatch-aws
  • Table of Contents
  • Global dependency
  • Builder
    • How to use it
    • Options
  • License

Global dependency

Add hatch-aws within the build-system.requires field in your pyproject.toml file.

[build-system]
requires = ["hatchling", "hatch-aws"]
build-backend = "hatchling.build"

Builder

The builder plugin name is called aws.

To enable it, include following configuration in you config file:

• pyproject.toml

  [tool.hatch.build.targets.aws]
  

• hatch.toml

  [build.targets.aws]
  

How to use it

1. Put your module and lambdas inside of src folder.

   .
   ├── pyproject.toml
   ├── src
   │   └── my_app
   │       ├── __init__.py
   │       ├── common
   │       │   ├── __init__.py
   │       │   ├── config.py
   │       │   └── models.py
   │       └── lambdas
   │           ├── lambda1
   │           │   ├── __init__.py
   │           │   └── main.py
   │           └── lambda2
   │               ├── __init__.py
   │               └── main.py
   └── template.yml
   

2. Specify common requirements for your project in pyproject.toml as dependencies.

   [project]
   dependencies = ["boto3"]
   

3. Specify requirements for your lambda functions in pyproject.toml as optional dependencies. Use module (folder) name.

   [project.optional-dependencies]
   lambda1 = ["pyaml"]
   lambda2 = ["requrest", "pydantic"]
   

4. Specify additional folders and files you want to copy to the build folder.

   [tool.hatch.build.targets.aws]
   include = ["src/my_app/common"]
   

5. Set the CodeUri and Handler parameter pointing to your lambdas in SAM template.

   Resources:
    Lambda1:
      Type: AWS::Serverless::Function
      Properties:
        FunctionName: lambda1-function
        CodeUri: src
        Handler: my_app.lambdas.lambda1.main.app
        ...
   
    Lambda2:
      Type: AWS::Serverless::Function
      Properties:
        FunctionName: lambda2-function
        CodeUri: src
        Handler: my_app.lambdas.lambda2.main.app
        ...
   

6. Run hatch build command.

   ❯ hatch build
   [aws]
   Building lambda functions ...
   Lambda1 ... success
   Lambda2 ... success
   Build successfull 🚀
   /path/to/projects/.aws-sam/build
   

Options

Following table contains available customization of builder behavior. You can find example of pyproject.toml in tests/assets/pyproject.toml.

Option	Type	Default	Description
template	str	template.yml	The filename of a SAM template.
use-sam	bool	false	Use only SAM for build. Do not run custom copy actions.
sam-params	array		Pass additional options to a SAM build command

License

Plugin hatch-aws is distributed under the terms of the MIT license.