Skip to content

Commit 56c1d6a

Browse files
committed
docs: add custom provider section to README
1 parent 3af90c3 commit 56c1d6a

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -565,6 +565,31 @@ package:
565565
- '**'
566566
```
567567

568+
## Custom Provider Support
569+
570+
### Scaleway
571+
572+
This plugin is compatible with the [Scaleway Serverless Framework Plugin](https://github.com/scaleway/serverless-scaleway-functions) to package dependencies for Python functions deployed on [Scaleway](https://www.scaleway.com/en/serverless-functions/). To use it, add the following to your `serverless.yml`:
573+
574+
```yaml
575+
provider:
576+
name: scaleway
577+
runtime: python311
578+
579+
plugins:
580+
- serverless-python-requirements
581+
- serverless-scaleway-functions
582+
```
583+
584+
To handle native dependencies, it's recommended to use the Docker builder with the image provided by Scaleway:
585+
586+
```yaml
587+
custom:
588+
pythonRequirements:
589+
# Can use any Python version supported by Scaleway
590+
dockerImage: rg.fr-par.scw.cloud/scwfunctionsruntimes-public/python-dep:3.11
591+
```
592+
568593
## Contributors
569594

570595
- [@dschep](https://github.com/dschep) - Lead developer & original maintainer

0 commit comments

Comments
 (0)