# serverless-py-requirements

> Serverless Python Requirements Plugin

Latest version **1.0.0** (published 2023-09-14) · 0 weekly downloads

## Install

```sh
npm install serverless-py-requirements
pnpm add serverless-py-requirements
yarn add serverless-py-requirements
bun add serverless-py-requirements
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-09-14 |
| First published | 2023-09-14 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=16.0 |
| Dependencies | 3 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | adminy8 |
| Keywords | serverless, python, requirements, pip, serverless framework plugin, serverless applications, serverless plugins, api gateway, lambda, aws, aws lambda, amazon, amazon web services, serverless.com |

## Links

- npm: https://www.npmjs.com/package/serverless-py-requirements
- npm.io page: https://npm.io/package/serverless-py-requirements

## Dependencies (3)

- [mkdirp](https://npm.io/package/mkdirp.md) ^3.0.1
- [rimraf](https://npm.io/package/rimraf.md) ^5.0.1
- [zip-lib](https://npm.io/package/zip-lib.md) ^0.7.3

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2023-09-14

## README

# sls-py-pkg
```yaml
plugins:
  - sls-py-pkg
custom:
  pythonRequirements:
    # These options are optional, only set them if you know what you're doing
    # excludeDefaults: false
    # cmd: pip install -r requirements.txt -r common_utils/requirements.txt -t .
    # pipArgs: >
    #   --index-url=https://pypi.org/simple
    #   --secondary-url=https://pypi.org/simple
    shared:
      common_utils:
        source: ../shared
        # if no functions specified, it will apply it to all
        functions:
          - hello
    exclude:
      - pyarrow/src

functions:
  hello:
    module: .
    handler: handler.hello
    zip: true # the handler now has to unzip its own "requirements.zip"
```
---
> **Note**

> Duplicate modules are not supported, for good practices

> filter using the `exclude` options, don't use ~~[Packaging patterns](https://www.serverless.com/framework/docs/providers/aws/guide/packaging)~~

>In handler.py, **shared** code can be imported like this:
```py
from common_utils import shared_resource
```

## Future Features Coming Soon ™️ (maybe)
---
- [ ] [zip-imports](https://docs.python.org/3/library/zipimport.html)
- [ ] zip deeper deps filtering for pyc and pyo files

## Requirements
---
- [x] python & pip installed
- [x] minimum required node version >= 16

---
_Source: https://npm.io/package/serverless-py-requirements · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._