-
Notifications
You must be signed in to change notification settings - Fork 3
feat: setup repo #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
docs/CODE_OF_CONDUCT.md
Outdated
@@ -0,0 +1,76 @@ | |||
# Contributor Covenant Code of Conduct |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are these in the docs
directory? Can you copy the format of other open-source SCW projects like the CLI? There the CODE_OF_CONDUCT
is in the .github
dir: https://github.com/scaleway/scaleway-cli/tree/master/.github, and CONTRIBUTING.md
is top level.
README.md
Outdated
@@ -0,0 +1,75 @@ | |||
# Serverless Functions Python 💜 | |||
|
|||
Scaleway Serverless Functions is a framework to provide a good developer experience to write Serverless Functions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scaleway Serverless Functions is the main product, can you describe what this repo actually is? E.g. This repo contains utilities for testing your Python functions for Scaleway Serverless Functions.
Then Scaleway Serverless Functions links to the main docs, and we don't need to repeat what Serverless Functions do.
README.md
Outdated
|
||
Scaleway Serverless Functions is a framework to provide a good developer experience to write Serverless Functions. | ||
|
||
Serverless Functions make it easy to deploy, scale, and optimize your workloads on the cloud. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line can go as long as we have a link to the product page.
README.md
Outdated
|
||
Serverless Functions make it easy to deploy, scale, and optimize your workloads on the cloud. | ||
|
||
## ⚙️ Installation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change this heading to Quick Start
README.md
Outdated
|
||
## 📦 Usage | ||
|
||
### 🏡 Local testing |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delete the Usage
and Local testing
headings
README.md
Outdated
We love feedback. | ||
Don't hesitate to open a [Github issue](https://github.com/scaleway/serverless-functions-python/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). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Delete this line
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why ?I pick it from devtools repo and a great oppotunity to bring new users on slack
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, it's good, I just merged it into the line above
from serverless_functions_python import Context, Event, Response | ||
|
||
|
||
def handler(event: "Event", context: "Context") -> "Response": |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
_context
or context
? Not consistent in code in this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad. I add a _ to indicate an unused argument, but this seems unnecessary in a README. Removed the _ in the readme
.gitignore
Outdated
.webassets-cache | ||
|
||
# Sphinx documentation | ||
docs/_build/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AFAICT we aren't using Sphinx, can we delete everything that's not necessary in this file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Trimmed down the gitignore to leave only what would result in files added to the repo.
.github/workflows/python-publish.yml
Outdated
# This workflow uses actions that are not certified by GitHub. | ||
# They are provided by a third-party and are governed by | ||
# separate terms of service, privacy policy, and support | ||
# documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment line width in this file is not consistent. Do we need lines 5-8?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My bad, this was copied over from the API framework. This comment was generated by GitHub when we used their suggested workflow to publish a PyPI package.
.github/dependabot.yml
Outdated
updates: | ||
- package-ecosystem: github-actions | ||
# Workflow files stored in the | ||
# default location of `.github/workflows` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What is the rule on line length in this file? Does this comment need to be split over 2 lines?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure how I ended up with this, but this does not exceed yamllint default line length.
Description
Set up most of the repo without the code.
A lot of it is inspired or taken from the API framework repo.
Details
Poetry doesn't run with
python:3.8-alpine
:Steps to reproduce:
Workarounds: use ubuntu ? drop containers entirely ? drop python 3.8 support ?
I'm keen on the last option since I'm using the |= operator in the code.
EDIT: Nevermind, it's probably better to stop using alpine, because building and publishing a wheel with alpine is not a great idea