Metadata-Version: 2.1
Name: lambda-pyskel
Version: 2.0.0
Summary: Create skeleton of a python AWS Lambda function
Home-page: https://github.com/vincentsarago/lambda-pyskel
Author: Vincent Sarago
Author-email: vincent.sarago@gmail.com
License: BSD
Description: =============
        lambda-pyskel
        =============
        
        Create python AWS Lambda skeleton from templates.
        
        .. image:: https://img.shields.io/pypi/v/lambda-pyskel.svg
           :target: https://pypi.org/project/lambda-pyskel/
        
        .. image:: https://circleci.com/gh/vincentsarago/lambda-pyskel.svg?style=svg
           :target: https://circleci.com/gh/vincentsarago/lambda-pyskel
        
        .. image:: https://codecov.io/gh/vincentsarago/lambda-pyskel/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/vincentsarago/lambda-pyskel
        
        Shameless inspiration from @sgillies https://github.com/mapbox/pyskel
        
        Install
        =======
        
        You can install lambda-pyskel using pip
        
        .. code-block:: console
        
            $ pip install -U pip
            $ pip install lambda-pyskel
        
        or install from source:
        
        .. code-block:: console
        
            $ 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 gdal shared libraries and configuration
        
        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.rst             : 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
        =====
        
        .. code-block:: console
        
            $ Usage: lps [OPTIONS] NAME
        
              Create new python AWS Lambda skeleton.
        
            Options:
              --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
        
        .. code-block:: console
        
            $ 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**
        
        .. code-block:: console
        
          $ 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.
        
        .. code-block:: console
        
          $ pre-commit install
          $ git add .
          $ git commit -m'my change'
          black....................................................................Passed
          Flake8...................................................................Passed
          Verifying PEP257 Compliance..............................................Passed
          $ git push origin
        
Keywords: AWS-Lambda Python
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3
Provides-Extra: test
Provides-Extra: dev
