Metadata-Version: 1.1
Name: lambkin
Version: 0.3.2
Summary: CLI tool for managing functions in AWS Lambda.
Home-page: https://github.com/jarpy/lambkin
Author: Toby McLaughlin
Author-email: toby@jarpy.net
License: UNKNOWN
Description: Deprecation Warning
        ===================
        
        Lambkin was designed as a simple tool for simple tasks. Today, it's
        difficult to recommend over more functional systems such as
        `Serverless <https://serverless.com/>`__ and
        `Apex <http://apex.run/>`__. Please consider alternatives before getting
        too involved with Lambkin.
        
        Lambkin
        =======
        
        Lambkin is a CLI tool for generating and managing simple functions in
        AWS Lambda.
        
        Supporting Node.js and Python, Lambkin generates skeleton functions,
        provides lightweight help for managing dependencies, and does its best
        to hide the complexity of publishing and running functions in Lambda.
        
        Quick Start
        ===========
        
        Prerequisites
        -------------
        
        -  A valid ``~/.aws/credentials`` file. eg.
        
           ::
        
               [default]
               aws_access_key_id = AKIAUAVOHGHOOWEEYIED
               aws_secret_access_key = 90kX2Y2bykTH9CpQFHCzN92tukYf26
        
           ... or the equivalent environment variables (``AWS_ACCESS_KEY_ID``
           and ``AWS_SECRET_ACCESS_KEY``).
        
        -  A working ``virtualenv`` command if you will be writing Lambda
           functions in Python.
        
        Installing
        ----------
        
        -  ``pip install lambkin``
        
        Examples
        --------
        
        Create a new Python function from a basic template
        ''''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin create cool-func
            cd cool-func
            $EDITOR cool-func.py
        
        ...or a maybe you prefer Node.js
        ''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin create cool-func --runtime=nodejs
            cd cool-func
            $EDITOR cool-func.js
        
        Install packages and dependencies for a Python function
        '''''''''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            $EDITOR requirements.txt
            lambkin build
        
        Install packages and dependencies for a Node.js function
        ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            $EDITOR Makefile
            lambkin build
        
        Bundle up your function (with libraries) and send it to Lambda
        ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin publish --description 'The best function ever.'
        
        Increase the timeout for a long-running function
        ''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin publish --description 'Slow' --timeout=300
        
        Increase the memory allocation for a function
        '''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin publish --description 'Big' --memory=1024
        
        Invoke the published function, right now!
        '''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin run
        
        Schedule the function to run at regular intervals
        '''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin schedule --rate='10 minutes'
        
        Remove the function from Lambda, but keep it locally
        ''''''''''''''''''''''''''''''''''''''''''''''''''''
        
        .. code:: bash
        
            lambkin unpublish
        
        Dependencies - pip and npm
        --------------------------
        
        Python functions get a ``requirements.txt`` file where you can specify
        dependencies. They will be installed into your function's virtualenv by
        ``lambkin build``.
        
        For now, Node.js functions just get a Makefile. Nicer, more Node-ish
        dependency management is planned for the future.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
