node package manager
Stop wasting time. Easily manage code sharing in your team. Create a free org »


Serverless Python Requirements

serverless circleci npm

A Serverless v1.x plugin to automatically bundle dependencies from requirements.txt and make them available in your PYTHONPATH.

Requires Serverless >= v1.12


sls plugin install -n serverless-python-requirements

Cross compiling!

Compiling non-pure-Python modules or fetching their manylinux wheels is supported on non-linux OSs via the use of Docker and the docker-lambda image. To enable docker usage, add the following to your serverless.yml:

    dockerizePip: true

The dockerizePip option supports a special case in addition to booleans of 'non-linux' which makes it dockerize only on non-linux environments.

To utilize your own Docker container instead of the default, add the following to your serverless.yml:

    dockerImage: <image name>:tag

This must be the full image name and tag to use, including the runtime specific tag if applicable.

Pipenv support ✨🍰✨

If you include a Pipfile and have pipenv installed instead of a requirements.txt this will use pipenv lock --r to generate them. It is fully compatible with all options such as zip and dockerizePip. If you don't want this plugin to generate it for you, set the following option:

    usePipenv: false

Dealing with Lambda's size limitations

To help deal with potentially large dependencies (for example: numpy, scipy and scikit-learn) there is support for compressing the libraries. This does require a minor change to your code to decompress them. To enable this add the following to your serverless.yml:

    zip: true

and add this to your handler module before any code that imports your deps:

  import unzip_requirements
except ImportError:

Omitting Packages

You can omit a package from deployment with the noDeploy option. Note that dependencies of omitted packages must explicitly be omitted too. By default, this will not install the AWS SDKs that are already installed on Lambda. This example makes it instead omit pytest:

      - pytest

Extra Config Options

extra pip arguments

You can specify extra arguments to be passed to pip like this:

      dockerizePip: true
          - --cache-dir
          - .requirements-cache

Customize requirements file name

Some pip workflows involve using requirements files not named requirements.txt. To support these, this plugin has the following option:

    fileName: requirements-prod.txt

Customize Python executable

Sometimes your Python executable isn't available on your $PATH as python2.7 or python3.6 (for example, windows or using pyenv). To support this, this plugin has the following option:

    pythonBin: /opt/python3.6/bin/python

Manual invocations

The .requirements and using zip support) files are left behind to speed things up on subsequent deploys. To clean them up, run sls requirements clean. You can also create them (and unzip_requirements if using zip support) manually with sls requirements install.

Invalidate requirements caches on package

If you are using your own Python library, you have to cleanup .requirements on any update. You can use the following option to cleanup .requirements everytime you package.

    invalidateCaches: true