Skip to content

Commit 1479829

Browse files
jdufresnedschep
authored andcommitted
Add documentation about how to include the default omitted packages (#290)
1 parent 337cd46 commit 1479829

File tree

1 file changed

+22
-3
lines changed

1 file changed

+22
-3
lines changed

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,16 +148,35 @@ This will remove all folders within the installed requirements that match
148148
the names in `slimPatterns`
149149
## Omitting Packages
150150
You can omit a package from deployment with the `noDeploy` option. Note that
151-
dependencies of omitted packages must explicitly be omitted too.
152-
By default, this will not install the AWS SDKs that are already installed on
153-
Lambda. This example makes it instead omit pytest:
151+
dependencies of omitted packages must explicitly be omitted too. By default,
152+
the following packages are omitted as they are already installed on Lambda:
153+
154+
* boto3
155+
* botocore
156+
* docutils
157+
* jmespath
158+
* pip
159+
* python-dateutil
160+
* s3transfer
161+
* setuptools
162+
* six
163+
164+
This example makes it instead omit pytest:
154165
```yaml
155166
custom:
156167
pythonRequirements:
157168
noDeploy:
158169
- pytest
159170
```
160171

172+
To include the default omitted packages, set the `noDeploy` option to an empty
173+
list:
174+
```yaml
175+
custom:
176+
pythonRequirements:
177+
noDeploy: []
178+
```
179+
161180
## Extra Config Options
162181
### Caching
163182
You can enable two kinds of caching with this plugin which are currently both DISABLED by default. First, a download cache that will cache downloads that pip needs to compile the packages. And second, a what we call "static caching" which caches output of pip after compiling everything for your requirements file. Since generally requirements.txt files rarely change, you will often see large amounts of speed improvements when enabling the static cache feature. These caches will be shared between all your projects if no custom cacheLocation is specified (see below).

0 commit comments

Comments
 (0)