README.md
# Lambda Bundler
[](https://codeclimate.com/github/MauriceBrg/lambda_bundler/maintainability)
[](https://codeclimate.com/github/MauriceBrg/lambda_bundler/test_coverage)
[](https://badge.fury.io/py/lambda-bundler)
Lambda Bundler helps you package your python lambda functions and their dependencies for deployment to AWS.
It supports three different modes:
- Package dependencies for a Lambda layer
- Package code-only dependencies from multiple directories for deployment to Lambda
- Package your own code and external dependencies into a single zip for deployment to Lambda
Dependencies will be cached if possible in order to provide a fast build experience.
## Installation
The installation is very simple using pip:
```text
pip install lambda-bundler
```
## How to use
### Package a Lambda layer
```python
from lambda_bundler import build_layer_package
path_to_deployment_artifact = build_layer_package(
# You can install the dependencies from multiple
# requirement files into a single layer
requirement_files=[
"path/to/requirements.txt"
]
)
# path_to_deployment_artifact now points to a zip archive with the dependencies.
```
### Package code directories
```python
from lambda_bundler import build_lambda_package
path_to_deployment_artifact = build_lambda_package(
code_directories=[
"path/to/package",
"path/to/other/package
],
exclude_patterns=[
"*.pyc"
]
)
# path_to_deployment_artifact now contains the path to the zip archive
```
### Package code directories and dependencies
If you'd like to package your dependencies directly into the deployment artifact you can do that very easily. Please keep in mind, that the size limit for a zipped deployment package is 50MB according to the [documentation](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-limits.html) and the content of packages larger than 3MB won't be visible in the code editor in the console.
```python
from lambda_bundler import build_lambda_package
path_to_deployment_artifact = build_lambda_package(
code_directories=[
"path/to/package",
"path/to/other/package
],
requirement_files=[
"path/to/requirements.txt
],
exclude_patterns=[
"*.pyc"
]
)
# path_to_deployment_artifact now contains the path to the zip archive
```
## Configuration
The library uses a working directory to build and cache packages.
By default this is located in the `lambda_bundler_builds` folder in your temporary directory as determined by [python](https://docs.python.org/3/library/tempfile.html#tempfile.gettempdir).
If you'd like to change that, you can set the `LAMBDA_BUNDLER_BUILD_DIR` environment variable and point it to another directory.
If you're using the Cloud Development Kit and just want to do a `cdk synth` to check your infrastructure code without actually deploying it, you can set the environment variable `LAMBDA_BUNDLER_SKIP_INSTALL` to `true`. This will skip installing dependencies and bundling the code, which makes the process a lot faster - although it won't work when you try to deploy it with the variable set to `true`.
## Demo / Example
For an example of how to use this, I suggest you check out the [demo repository](https://github.com/MauriceBrg/lambda-bundler-demo) which includes a CDK app that deploys three lambda functions with dependencies of different sizes.
If you take a closer look at the [build pipeline](https://github.com/MauriceBrg/lambda-bundler-demo/actions?query=workflow%3ALambda-Bundler-Demo-Build) you'll see, how effective the caching is.
## Known Limitations
- Packages are downloaded and built on your local machine, that means you might experience problems with libraries that use C-extensions if your platform is not Linux. Building packages with Docker is something I'd like to look into if there's a demand for that.
- Currently there's no warnings/errors if your deployment package surpasses the Lambda limits - if there's a need for that I'll consider adding those.
- This is built towards integration with the AWS CDK in python and doesn't work well standalone. I'm considering adding a CLI interface for use in Deployment Pipelines. Let me know if this is something you could use.