https://github.com/epsagon/serverless-package-external

Add external folders to the deploy package 📦
https://github.com/epsagon/serverless-package-external

aws-lambda serverless serverless-common serverless-external serverless-framework serverless-package serverless-plugin

Last synced: about 1 month ago
JSON representation

Add external folders to the deploy package 📦

• Host: GitHub
• URL: https://github.com/epsagon/serverless-package-external
• Owner: epsagon
• License: mit
• Created: 2018-08-05T07:53:48.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-06-16T09:54:08.000Z (8 months ago)
• Last Synced: 2025-01-02T19:18:05.705Z (about 2 months ago)
• Topics: aws-lambda, serverless, serverless-common, serverless-external, serverless-framework, serverless-package, serverless-plugin
• Language: JavaScript
• Homepage: https://epsagon.com/blog/how-to-package-external-code-in-aws-lambda-using-serverless-framework/
• Size: 215 KB
• Stars: 55
• Watchers: 4
• Forks: 5
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# serverless-package-external 📦

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![npm version](https://badge.fury.io/js/serverless-package-external.svg)](https://badge.fury.io/js/serverless-package-external)

[![Build Status](https://travis-ci.com/epsagon/serverless-package-external.svg?branch=master)](https://travis-ci.com/epsagon/serverless-package-external)

> Deploy a Serverless Python Function services with external code

Before deploying, this plugin symlinks folders containing shared code into the root directory of your Serverless function.

This plugin works also with `serverless-offline` plugin.

### Installation

```

npm i serverless-package-external --save-dev

```

### Usage

```yml

service: service-name

plugins:

  - serverless-package-external

functions:

  # Your functions here

custom:

  packageExternal:

    external:

      - '../common'

      - '../service-a/module'

```

#### Example Directory Structure

```

└── common

    └── resource.py

└── service-a

    └── handler.py

    └── serverless.yml

    └── module

        └── main.py

└── service-b

    └── handler.py

    └── serverless.yml

```

In handler.py, external code can be imported:

```py

from common.resource import shared_resource

```

 

#### Licensing

serverless-package-external is licensed under the [MIT License](./LICENSE.txt).

It is originally based on [serverless-package-common](https://github.com/onlicar/serverless-package-common).