From 5894059d2da6a9ea85f3a3a21f4aad20db84e130 Mon Sep 17 00:00:00 2001 From: lucasscw <83953242+lucasscw@users.noreply.github.com> Date: Thu, 2 Mar 2023 15:54:53 +0100 Subject: [PATCH 1/3] Edit doc to comply with the go one --- README.md | 80 ++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 65 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ae1cd7d..bf681a2 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # Serverless Functions Python 💜 -This repo contains utilities for testing your Python handlers for Scaleway Serverless Functions. +Scaleway Serverless Functions Python is a framework which simplify Scaleway [Serverless Functions](https://www.scaleway.com/fr/serverless-functions/) local development. +It enables you to debug your function locally and provide the event data format used in Scaleway Serverless Functions. + +Be careful, this framework does not enable you to build and deploy your function (for more information, refer to the official documentation) + +Get started with Scaleway Functions (we support multiple languages :rocket:): + +- [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/serverless/functions/quickstart/) +- [Scaleway Serverless Framework plugin](https://github.com/scaleway/serverless-scaleway-functions) +- [Scaleway Serverless Examples](https://github.com/scaleway/serverless-examples) +- [Scaleway Cloud Provider](https://scaleway.com) + +Testing frameworks for Scaleway Serverless Functions in other languages can be found here: +- [Go](https://github.com/scaleway/serverless-functions-go) ## ⚙️ Quick Start @@ -35,33 +48,70 @@ $ curl http://localhost:8080 $ curl -X POST http://localhost:8080 > Invalid method! ``` +## 🚀 Features + +This repository aims to provide the best experience: **local testing, utils, documentation etc...** +additionally we love to share things with the community and we want to expose receipts to the public. That's why +we make our framework publicly available to help the community! + +### 🏡 Local testing + +What this package does: + +- **Format Input**: Serverless Functions have a specific input format encapsulating the body received by functions to add some useful data. + The local testing package lets you interact with the formatted data. +- **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. + +What this package does not: + +- **Simulate performance**: Scaleway FaaS lets you choose different options for CPU/RAM that can have an impact + on your development. This package does not provide specific limits for your function on local testing but you can + add [Profile your application](*LINK TO EDIT*) or you can use our metrics available in [Scaleway Console](https://console.scaleway.com/) + to monitor your application. +- **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 it requires specific system dependencies (especially those related to lib c) that we don't support + If you have compatibility issues, please see the help section. -## 🧱 Type hints + +### 🧱 Type hints 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. -## 🌍 Resources -Get started with Scaleway Functions: +## ❓ FAQ -- [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/serverless/functions/quickstart/) -- [Scaleway Serverless Framework plugin](https://github.com/scaleway/serverless-scaleway-functions) -- [Scaleway Serverless Examples](https://github.com/scaleway/serverless-examples) -- [Scaleway Cloud Provider](https://scaleway.com) +**Why do I need an additional package to call my function?** -Testing frameworks for Scaleway Serverless Functions in other languages can be found here: +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. +This library is not mandatory to use Scaleway Serverless Functions. -- [Go](https://github.com/scaleway/serverless-functions-go) +**How my function will be deployed** + +To deploy your function please refer to our official documentation. + +**Do I need to deploy my function differently?** + +No. This framework does not affect deployment nor performance. + + +## 🧑‍💻 Development + +This repository is at its early stage and is still in active development. +If you are looking for a way to contribute please read [CONTRIBUTING.md](./docs/CONTRIBUTING.md). + +## 🛟 Help & support + +- Scaleway support is available on Scaleway Console. +- Additionally, you can join our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/) ## 🎓 Contributing -We welcome all contributions to our open-source projects, please see our [contributing guidelines](.github/CONTRIBUTING.md). +We welcome all contributions to our open-source projects, please see our contributing guidelines . Do not hesitate to raise issues and pull requests we will have a look at them. ## 📭 Reach Us -We love feedback. Feel free to: - -- Open a [Github issue](https://github.com/scaleway/serverless-functions-python/issues/new) -- Send us a message on the [Scaleway Slack community](https://slack.scaleway.com/), in the [#serverless-functions](https://scaleway-community.slack.com/app_redirect?channel=serverless-functions) channel. +We love feedback. +Don't hesitate to open a [Github issue](https://github.com/scaleway/serverless-functions/go/issues/new) or +feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), +we are waiting for you on [#serverless-functions](https://scaleway-community.slack.com/app_redirect?channel=serverless-functions). From ae81a548bb350d06b6ab9eabb9787e59b0981170 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andy=20M=C3=A9ry?= Date: Thu, 2 Mar 2023 18:14:49 +0100 Subject: [PATCH 2/3] docs: update readme with feedback --- README.md | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index bf681a2..6bb820c 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Serverless Functions Python 💜 -Scaleway Serverless Functions Python is a framework which simplify Scaleway [Serverless Functions](https://www.scaleway.com/fr/serverless-functions/) local development. +Scaleway Serverless Functions Python is a framework that simplifies Scaleway [Serverless Functions](https://www.scaleway.com/fr/serverless-functions/) local development. It enables you to debug your function locally and provide the event data format used in Scaleway Serverless Functions. -Be careful, this framework does not enable you to build and deploy your function (for more information, refer to the official documentation) +This library helps you to write functions but for deployment please refer to the documentation. -Get started with Scaleway Functions (we support multiple languages :rocket:): +Get started with Scaleway Functions: - [Scaleway Serverless Functions Documentation](https://www.scaleway.com/en/docs/serverless/functions/quickstart/) - [Scaleway Serverless Framework plugin](https://github.com/scaleway/serverless-scaleway-functions) @@ -13,9 +13,10 @@ Get started with Scaleway Functions (we support multiple languages :rocket:): - [Scaleway Cloud Provider](https://scaleway.com) Testing frameworks for Scaleway Serverless Functions in other languages can be found here: + - [Go](https://github.com/scaleway/serverless-functions-go) -## ⚙️ Quick Start +## ⚙️ Quickstart You can use `pip` to install the framework: @@ -48,11 +49,10 @@ $ curl http://localhost:8080 $ curl -X POST http://localhost:8080 > Invalid method! ``` + ## 🚀 Features -This repository aims to provide the best experience: **local testing, utils, documentation etc...** -additionally we love to share things with the community and we want to expose receipts to the public. That's why -we make our framework publicly available to help the community! +This repository aims to provide a better experience on **local testing, utils, and documentation** ### 🏡 Local testing @@ -65,13 +65,11 @@ What this package does: What this package does not: - **Simulate performance**: Scaleway FaaS lets you choose different options for CPU/RAM that can have an impact - on your development. This package does not provide specific limits for your function on local testing but you can - add [Profile your application](*LINK TO EDIT*) or you can use our metrics available in [Scaleway Console](https://console.scaleway.com/) + 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/) to monitor your application. -- **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 it requires specific system dependencies (especially those related to lib c) that we don't support +- **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 If you have compatibility issues, please see the help section. - ### 🧱 Type hints 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. @@ -90,8 +88,7 @@ To deploy your function please refer to our official documentation. **Do I need to deploy my function differently?** -No. This framework does not affect deployment nor performance. - +No, this framework does not affect deployment or performance. ## 🧑‍💻 Development @@ -105,7 +102,7 @@ If you are looking for a way to contribute please read [CONTRIBUTING.md](./docs/ ## 🎓 Contributing -We welcome all contributions to our open-source projects, please see our contributing guidelines . +We welcome all contributions to our open-source projects, please see our contributing guidelines. Do not hesitate to raise issues and pull requests we will have a look at them. From 7b3b8bcd165b61d73392239f9161b4e35e8ae3e8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andy=20M=C3=A9ry?= Date: Thu, 2 Mar 2023 18:21:38 +0100 Subject: [PATCH 3/3] docs: delete development section --- README.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 6bb820c..d1e7beb 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,6 @@ What this package does not: 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. - ## ❓ FAQ **Why do I need an additional package to call my function?** @@ -90,25 +89,15 @@ To deploy your function please refer to our official documentation. No, this framework does not affect deployment or performance. -## 🧑‍💻 Development - -This repository is at its early stage and is still in active development. -If you are looking for a way to contribute please read [CONTRIBUTING.md](./docs/CONTRIBUTING.md). - -## 🛟 Help & support - -- Scaleway support is available on Scaleway Console. -- Additionally, you can join our [Slack Community](https://www.scaleway.com/en/docs/tutorials/scaleway-slack-community/) - ## 🎓 Contributing -We welcome all contributions to our open-source projects, please see our contributing guidelines. +We welcome all contributions to our open-source projects, please see our [contributing guidelines](./.github/CONTRIBUTING.md). Do not hesitate to raise issues and pull requests we will have a look at them. ## 📭 Reach Us -We love feedback. -Don't hesitate to open a [Github issue](https://github.com/scaleway/serverless-functions/go/issues/new) or -feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), -we are waiting for you on [#serverless-functions](https://scaleway-community.slack.com/app_redirect?channel=serverless-functions). +We love feedback. Feel free to: + +- Open a [Github issue](https://github.com/scaleway/serverless-functions-python/issues/new) +- Send us a message on the [Scaleway Slack community](https://slack.scaleway.com/), in the [#serverless-functions](https://scaleway-community.slack.com/app_redirect?channel=serverless-functions) channel.