Skip to main content

Create skeleton of a python AWS Lambda function

Project description

lambda-pyskel

Create python AWS Lambda skeleton from templates.

Packaging status CircleCI codecov

Shameless inspiration from @sgillies https://github.com/mapbox/pyskel

Install

You can install lambda-pyskel using pip

$ pip install -U pip
$ pip install lambda-pyskel

or install from source:

$ git clone https://github.com/vincentsarago/lambda-pyskel.git
$ cd lambda-pyskel
$ pip install -U pip
$ pip install -e .

Templates

Three different templates are available:

  • simple: simple python lambda function
  • rasterio: include rasterio wheels
  • gdal: include custom gdal (2.4.1) installation from remotepixel docker image

Each templates has the following structure::

pyskel/                : main module
    __init__.py
    handler.py         : handler function
tests/                 : python tests
    test_handler.py
    test_mod.py
Dockerfile             : Dockerfile to create the package.zip
LICENSE                : BSD-2 license file
Makefile               : make commands to create/tests the packages
README.md             : Readme
setup.py               : Python setup
tox.ini                : tox template

Deployement Toolkit

In addition to python module templates, lambda-pyskel can also add configuration files for serverless or kes toolkit.

kes: http://devseed.com/kes/

serverless: https://serverless.com

Usage

$ lps --help
Usage: lps [OPTIONS] NAME

  Create new python AWS Lambda skeleton.

Options:
  --version                             Show the version and exit.
  --template [simple|rasterio|gdal]     Use specific template (default: 'simple')
  --serverless-toolkit [kes|serverless] Add deployement toolkit
  --help                                Show this message and exit.

Create a python lambda function with rasterio

$ lps yo --template rasterio
$ ls -1 yo
  Dockerfile
  LICENSE
  Makefile
  README.rst
  setup.py
  tests/
  tox.ini
  yo/

# edit yo/handler.py and setup.py
$ make build

Contribution & Devellopement

Issues and pull requests are more than welcome.

Dev install & Pull-Request

$ git clone https://github.com/vincentsarago/lambda-pyskel.git
$ cd lambda-pyskel
$ pip install -e .[dev]

Python3.6 only

This repo is set to use pre-commit to run flake8, pydocstring and black ("uncompromising Python code formatter") when committing new code.

$ pre-commit install
$ git add .
$ git commit -m'my change'
black....................................................................Passed
Flake8...................................................................Passed
Verifying PEP257 Compliance..............................................Passed
$ git push origin

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for lambda-pyskel, version 3.0.0
Filename, size File type Python version Upload date Hashes
Filename, size lambda-pyskel-3.0.0.tar.gz (8.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page