juniper 0.2.5

Tool to streamline the build of python lambda functions.

Juniper is a packaging tool to stream and standardize the creation of a zip artifact for a set of AWS Lambda functions.

The zip artifacts generated include the source code of the dependencies defined in a given requirements.txt file as well as any shared libraries the function depends on. With the generated artifact, a developer can deploy a lambda function either manually, through the awscli or using a cloudformation/sam template.

Quickstart

With Python==3.6 and Docker installed, install juniper:

> pip install juniper

In order to package your lambda functions with juniper, you need to create a manifest file.

functions:
  # Name the zip file you want juni to create
  router:
    # The dependencies of the router function.
    requirements: ./src/requirements.txt.
    # Include this file in the generated zip artifact.
    include:
    - ./src/lambda_function.py

The folder structure this manifest refers to looks like:

.
├── manifest.yml
├── src
│   ├── requirements.txt
│   ├── lambda_function.py

Build it!

> juni build

Juniper creates the following artifact ./dist/router.zip 🎉

For a more comprehensive example, please take a look at our tutorial.

Python3.7 and Beyond

By default juniper uses docker containers to package your lambda functions. Behind the scenes, juniper creates a docker-compose file from your manifest. This file is used by the build command to spawn a build container per function definition.

Since the AWS Lambda service supports multiple python runtimes, it makes sense for juniper to give you the ability to specify a docker image. With the following manifest file, you can package the router lambda using a python3.7 image.

functions:
  router:
    # Use this docker image
    image: lambci/lambda:build-python3.7
    requirements: ./src/router/requirements.txt.
    # Include these local modules in the artifact
    include:
    - ./src/commonlib/mylib
    - ./src/router_function/router

Keep in mind that not every single docker image works, for more information on the type of images supported read juniper and docker.

Features

This list defines the entire scope of Juniper. Nothing more, nothing else.

• Minimal manifest file to define packaging

• Using docker containers as a way to install dependencies and generate the artifacts

• Ability to tailor the requirements.txt per lambda

• Create an individual zip artifact for multiple lambda functions

• Ability to include shared dependencies (python modules relative to the function being packaged)

• Specify docker image to package lamdba functions using different python runtimes.

Contributing

For guidance on setting up a development environment and how to make a contribution to Juniper, see the contributing guidelines.

Links

• Documentation: https://eabglobal.github.io/juniper/

• License: Apache Software License

• Code: https://github.com/eabglobal/juniper

• Issue tracker: https://github.com/eabglobal/juniper/issues

• Test status:

  • Linux, Mac: https://circleci.com/gh/eabglobal/juniper