Skip to content

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

Merged
merged 26 commits into from
Feb 28, 2023
Merged

feat: setup repo #1

merged 26 commits into from
Feb 28, 2023

Conversation

cyclimse
Copy link
Collaborator

@cyclimse cyclimse commented Feb 24, 2023

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:

$ docker run -it python:3.8-alpine sh
$ pip install poetry
>>> complains about needing gcc  to build a poetry inner dependency

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

@cyclimse cyclimse self-assigned this Feb 24, 2023
thomas-tacquet
thomas-tacquet previously approved these changes Feb 27, 2023
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
Copy link
Contributor

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.
Copy link
Contributor

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.
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Delete this line

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

Copy link
Contributor

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":
Copy link
Contributor

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

Copy link
Collaborator Author

@cyclimse cyclimse Feb 28, 2023

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/
Copy link
Contributor

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?

Copy link
Collaborator Author

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.

# 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.
Copy link
Contributor

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?

Copy link
Collaborator Author

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.

updates:
- package-ecosystem: github-actions
# Workflow files stored in the
# default location of `.github/workflows`
Copy link
Contributor

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?

Copy link
Collaborator Author

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.

@cyclimse cyclimse merged commit 721e276 into main Feb 28, 2023
@cyclimse cyclimse deleted the feat/setup-repo branch February 28, 2023 14:23
@cyclimse cyclimse mentioned this pull request Mar 2, 2023
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants