Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aka-raccoon/hatch-aws

Hatch plugin for building AWS Lambda functions with SAM
https://github.com/aka-raccoon/hatch-aws

aws hatch

Last synced: about 2 months ago
JSON representation

Hatch plugin for building AWS Lambda functions with SAM

Host: GitHub
URL: https://github.com/aka-raccoon/hatch-aws
Owner: aka-raccoon
License: mit
Created: 2022-08-22T06:25:57.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-02-25T20:08:58.000Z (over 1 year ago)
Last Synced: 2024-07-17T19:54:31.105Z (2 months ago)
Topics: aws, hatch
Language: Python
Homepage:
Size: 44.9 KB
Stars: 11
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        


# hatch-aws

[![PyPI - Version](https://img.shields.io/pypi/v/hatch-aws.svg)](https://pypi.org/project/hatch-aws) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/hatch-aws.svg)](https://pypi.org/project/hatch-aws) [![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch) [![code style - black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![types - mypy](https://img.shields.io/badge/types-Mypy-blue.svg)](https://github.com/python/mypy) [![imports - isort](https://img.shields.io/badge/imports-isort-ef8336.svg)](https://github.com/pycqa/isort)

AWS builder plugin for **[Hatch 🥚🐍]()**.

*Hatch is modern, extensible Python project manager.*



---

Checkout my other plugin [hatch-aws-publisher](https://github.com/aka-raccoon/hatch-aws-publisher).

## Table of Contents

- [hatch-aws](#hatch-aws)

    - [Table of Contents](#table-of-contents)

    - [Global dependency](#global-dependency)

    - [Builder](#builder)

        - [How to use it](#how-to-use-it)

        - [Options](#options)

    - [License](#license)

## Global dependency

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

```toml

[build-system]

requires = ["hatchling", "hatch-aws"]

build-backend = "hatchling.build"

```

## Builder

The [builder plugin](https://hatch.pypa.io/latest/plugins/builder/reference/) name is called `aws`.

To start build process, run `hatch build -t aws`:

```bash

❯ hatch build -t aws

[aws]

Building lambda functions ...

MyAwsLambdaFunc ... success

Build successfull 🚀

/path/to/build/.aws-sam/build

```

### How to use it

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

   ```shell

   .

   ├── 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.

   ```toml

   [project]

   dependencies = ["boto3"]

   ```

3. Specify requirements for your lambda functions in `pyproject.toml` as optional dependencies. Use resource name from SAM template, but you have to adapt it to be compliant with [PEP standard](https://peps.python.org/pep-0503/#normalized-names>) (transform to lower case and replace `_` with `-`). For example, if you function name in SAM template is `GetAll_Accounts`, use `getall-accounts`.

   ```toml

   [project.optional-dependencies]

   lambda1 = ["pyaml"]

   lambda2 = ["request", "pydantic"]

   ```

4. Specify additional paths(source/destination) you want to copy to the build folder. Destination is relative to a build directory (`.aws-sam/build` by default). You can use glob `*` to copy common to all lambda functions.

   ```toml

   [tool.hatch.build.force-include]

   "src/batman/common" = "*/batman/common" # copy to all lambda functions

   ".editorconfig" = ".editorconfig.txt"

   "CHANGELOG.md" = "../CH.txt"

   "images/" = "*/images"

   ```

5. Set the `CodeUri` and `Handler` parameter pointing to your lambdas in SAM template. Only resources with `Runtime: python{version}` are supported. The rest is ignored.

   ```yaml

   Resources:

    Lambda1:

      Type: AWS::Serverless::Function

      Properties:

        Runtime: python3.9

        FunctionName: lambda1-function

        CodeUri: src

        Handler: my_app.lambdas.lambda1.main.app

        ...

    Lambda2:

      Type: AWS::Serverless::Function

      Properties:

        Runtime: python3.9

        FunctionName: lambda2-function

        CodeUri: src

        Handler: my_app.lambdas.lambda2.main.app

        ...

   ```

### Options

Following table contains available customization of builder behavior. You can find example of `pyproject.toml` in [tests/assets/pyproject.toml](https://github.com/aka-raccoon/hatch-aws/blob/main/tests/assets/pyproject.toml).

| Option       | Type    | Default        | Description                                              |

| ------------ | ------- | -------------- | -------------------------------------------------------- |

| `template`   | `str`   | `template.yml` | SAM template filename.                                   |

| `use-sam`    | `bool`  | `false`        | Use only `sam build` command without any custom actions. |

| `sam-exec`   | `str`   | `sam`          | Path to `sam` executable. Env var: `HATCH_SAM_EXEC`.     |

| `sam-params` | `array` |                | Additional `sam build` args.                             |

## License

Plugin `hatch-aws` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.