Skip to content

Commit dbd1742

Browse files
lucasscwcyclimse
andauthored
docs: update doc to comply with the go one (#7)
* Edit doc to comply with the go one * docs: update readme with feedback * docs: delete development section --------- Co-authored-by: Andy Méry <amery@scaleway.com>
1 parent e500827 commit dbd1742

File tree

1 file changed

+48
-12
lines changed

1 file changed

+48
-12
lines changed

README.md

+48-12
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
# Serverless Functions Python 💜
22

3-
This repo contains utilities for testing your Python handlers for Scaleway Serverless Functions.
3+
Scaleway Serverless Functions Python is a framework that simplifies Scaleway [Serverless Functions](https://www.scaleway.com/fr/serverless-functions/) local development.
4+
It enables you to debug your function locally and provide the event data format used in Scaleway Serverless Functions.
45

5-
## ⚙️ Quick Start
6+
This library helps you to write functions but for deployment please refer to the documentation.
7+
8+
Get started with Scaleway Functions:
9+
10+
- [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/serverless/functions/quickstart/)
11+
- [Scaleway Serverless Framework plugin](https://github.com/scaleway/serverless-scaleway-functions)
12+
- [Scaleway Serverless Examples](https://github.com/scaleway/serverless-examples)
13+
- [Scaleway Cloud Provider](https://scaleway.com)
14+
15+
Testing frameworks for Scaleway Serverless Functions in other languages can be found here:
16+
17+
- [Go](https://github.com/scaleway/serverless-functions-go)
18+
19+
## ⚙️ Quickstart
620

721
You can use `pip` to install the framework:
822

@@ -36,26 +50,48 @@ $ curl -X POST http://localhost:8080
3650
> Invalid method!
3751
```
3852

39-
## 🧱 Type hints
53+
## 🚀 Features
54+
55+
This repository aims to provide a better experience on **local testing, utils, and documentation**
56+
57+
### 🏡 Local testing
58+
59+
What this package does:
60+
61+
- **Format Input**: Serverless Functions have a specific input format encapsulating the body received by functions to add some useful data.
62+
The local testing package lets you interact with the formatted data.
63+
- **Advanced debugging**: To improve developer experience you can run your handler locally and debug it by running your code step-by-step or reading output directly before deploying it.
64+
65+
What this package does not:
66+
67+
- **Simulate performance**: Scaleway FaaS lets you choose different options for CPU/RAM that can have an impact
68+
on your development. This package does not provide specific limits for your function on local testing but you can profile your application or you can use our metrics available in [Scaleway Console](https://console.scaleway.com/)
69+
to monitor your application.
70+
- **Deploy functions**: When your function is uploaded we package it in an environment that can be different than yours. Our build pipelines support several dependencies but sometimes require specific system dependencies (especially those related to lib c) that we don't support
71+
If you have compatibility issues, please see the help section.
72+
73+
### 🧱 Type hints
4074

4175
The framework provides some types hints to make it easier to develop your handler. See this [example](examples/mirror.py) for more information on how to use them.
4276

43-
## 🌍 Resources
77+
## ❓ FAQ
4478

45-
Get started with Scaleway Functions:
79+
**Why do I need an additional package to call my function?**
4680

47-
- [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/serverless/functions/quickstart/)
48-
- [Scaleway Serverless Framework plugin](https://github.com/scaleway/serverless-scaleway-functions)
49-
- [Scaleway Serverless Examples](https://github.com/scaleway/serverless-examples)
50-
- [Scaleway Cloud Provider](https://scaleway.com)
81+
Your Function Handler can be served by a simple HTTP server but Serverless Ecosystem involves a lot of different layers that will change changes the headers, input and output of your function. This package aims to simulate everything your request will go through to help you debug your application properly.
82+
This library is not mandatory to use Scaleway Serverless Functions.
5183

52-
Testing frameworks for Scaleway Serverless Functions in other languages can be found here:
84+
**How my function will be deployed**
5385

54-
- [Go](https://github.com/scaleway/serverless-functions-go)
86+
To deploy your function please refer to our official documentation.
87+
88+
**Do I need to deploy my function differently?**
89+
90+
No, this framework does not affect deployment or performance.
5591

5692
## 🎓 Contributing
5793

58-
We welcome all contributions to our open-source projects, please see our [contributing guidelines](.github/CONTRIBUTING.md).
94+
We welcome all contributions to our open-source projects, please see our [contributing guidelines](./.github/CONTRIBUTING.md).
5995

6096
Do not hesitate to raise issues and pull requests we will have a look at them.
6197

0 commit comments

Comments
 (0)