README.md

pruun

Pruun is a CL utility for easily creating AWS lambda deployment packages within Python virtualenvs. It was designed to work as a simple, out-of-the-box solution that can be integrated into any deployment pipeline.

NOTE: Supported OSs are Linux and MAC. Windows support is not fully tested at the moment.

Installation

Use the package manager pip to install pruun

pip install pruun

Usage

For the following usage examples, let's imagine this is simple directory structure:

.
├── requirements.txt
└── my_lambda_handler.py

$ pruun --help
Usage: pruun [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  package  Creates deployment package .zip file in current directory.
$ pruun package my_lambda_handler.py
Locating all installed packages...  [####################################]  100%          
Creating deployment package...
Finit!

Commands

pruun package [OPTIONS] HANDLER_FILE

Usage: pruun package [OPTIONS] HANDLER_FILE

  Creates deployment package .zip file in current directory.

  handler_file (str): Name of Lambda handler file.  Assumed to exist within
  current directory.

  package-file (str, optional): Desired filename of deployment .zip file.
  Defaults to "deployment_package.zip".

Options:
  --package-file PATH  Desired filename of deployment .zip file.
  --help               Show this message and exit.

Contributing

Set up the development environment by running make setup.

Before contributing a pull request, please make sure tests pass by running make test.