https://github.com/alexkosj/pruun

Pruun is a CL utility for easily creating AWS lambda deployment packages within Python virtualenvs.
https://github.com/alexkosj/pruun

Last synced: 3 months ago
JSON representation

Pruun is a CL utility for easily creating AWS lambda deployment packages within Python virtualenvs.

• Host: GitHub
• URL: https://github.com/alexkosj/pruun
• Owner: alexkosj
• License: mit
• Created: 2020-06-30T01:56:02.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-11T01:22:07.000Z (about 4 years ago)
• Last Synced: 2024-07-10T12:06:25.478Z (4 months ago)
• Language: Python
• Homepage:
• Size: 5.33 MB
• Stars: 39
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![logo](assets/prune.png) pruun

![](https://github.com/alexkosj/pruun/workflows/Run%20tests/badge.svg?branch=master)

[![license](https://img.shields.io/badge/license-MIT-green.svg)](/LICENSE)

![python version](https://img.shields.io/badge/python-3.6%2C3.7%2C3.8-blue?logo=python)

Pruun is a CL utility for easily creating [AWS lambda deployment packages within Python virtualenvs](https://docs.aws.amazon.com/lambda/latest/dg/python-package.html#python-package-venv). 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](https://pip.pypa.io/en/stable/) 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

```

```sh-session

$ pruun --help

Usage: pruun [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Commands:

  package  Creates deployment package .zip file at given path.

$ pruun package my_lambda_handler.py

Locating all installed packages...  [####################################]  100%          

Creating deployment package...

Finit!

```

## Commands

### pruun package [OPTIONS] handler_path

```

Usage: pruun package [OPTIONS] [HANDLER_PATHS]...

  Creates deployment package .zip file at given path.

  handler_paths (Tuple[str, ...]): Name(s) of Lambda handler file(s)/dir(s).

  Trailing slash for a directory path is optional.

  package-file (str, optional): Desired filepath of deployment .zip file.

  Defaults to "deployment_package.zip" (in the cwd).

Options:

  --package-file PATH  Desired filepath 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`.