feat: setup repo #1

cyclimse · 2023-02-24T16:19:38Z

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

.pre-commit-config.yaml

tests/test_fake.py

examples/mirror.py

.gitignore

CHANGELOG.md

README.md

Shillaker · 2023-02-28T12:38:41Z

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct


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.

Shillaker · 2023-02-28T12:41:44Z

README.md

@@ -0,0 +1,75 @@
+# Serverless Functions Python 💜
+
+Scaleway Serverless Functions is a framework to provide a good developer experience to write Serverless Functions.


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.

Shillaker · 2023-02-28T12:41:59Z

README.md

+
+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.


This line can go as long as we have a link to the product page.

Shillaker · 2023-02-28T12:42:30Z

README.md

+
+Serverless Functions make it easy to deploy, scale, and optimize your workloads on the cloud.
+
+## ⚙️ Installation


Change this heading to Quick Start

Shillaker · 2023-02-28T12:43:03Z

README.md

+
+## 📦 Usage
+
+### 🏡 Local testing


Delete the Usage and Local testing headings

Shillaker · 2023-02-28T12:46:46Z

README.md

+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).


Delete this line

Why ?I pick it from devtools repo and a great oppotunity to bring new users on slack

Yes, it's good, I just merged it into the line above

Shillaker · 2023-02-28T12:47:08Z

examples/mirror.py

+    from serverless_functions_python import Context, Event, Response
+
+
+def handler(event: "Event", context: "Context") -> "Response":


_context or context? Not consistent in code in this PR

My bad. I add a _ to indicate an unused argument, but this seems unnecessary in a README. Removed the _ in the readme

Shillaker · 2023-02-28T12:47:48Z

.gitignore

+.webassets-cache
+
+# Sphinx documentation
+docs/_build/


AFAICT we aren't using Sphinx, can we delete everything that's not necessary in this file?

Trimmed down the gitignore to leave only what would result in files added to the repo.

Shillaker · 2023-02-28T12:48:45Z

.github/workflows/python-publish.yml

+# 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.


Comment line width in this file is not consistent. Do we need lines 5-8?

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.

Shillaker · 2023-02-28T12:49:12Z

.github/dependabot.yml

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


What is the rule on line length in this file? Does this comment need to be split over 2 lines?

Not sure how I ended up with this, but this does not exceed yamllint default line length.

cyclimse added 13 commits February 24, 2023 17:19

feat: setup repo

3b43b79

feat: add missing files to repo

0f0d4a7

chore: some cleanup

3555f0b

ci: initial commit

8ec6a23

ci: update to ubuntu github hosted

6890ea1

chore: add convential commit hook

e354fc1

fix(ci): missing dollar

dc6fd5c

fix(pre-commit): invalid values in hooks

8f60a8f

fix(ci): missing python version cache key for deps

e3f7920

fix: minimum python version in pyproject

3063cc7

chore: poetry lock

71adc8c

chore(ci): do not install dev dependencies

2e4141e

test(ci): remove python 3.8

b1ac6e4

cyclimse self-assigned this Feb 24, 2023

cyclimse requested review from Shillaker and thomas-tacquet February 24, 2023 17:18

cyclimse commented Feb 24, 2023

View reviewed changes

.pre-commit-config.yaml Show resolved Hide resolved

cyclimse commented Feb 24, 2023

View reviewed changes

tests/test_fake.py Show resolved Hide resolved

cyclimse commented Feb 24, 2023

View reviewed changes

examples/mirror.py Show resolved Hide resolved

cyclimse added 3 commits February 24, 2023 18:40

test(ci): remove alpine containers

6dc6da1

test(ci): experiment with junit report

a9e49b0

fix(ci): fix bad names

3d3c25e

Shillaker requested changes Feb 27, 2023

View reviewed changes

.gitignore Outdated Show resolved Hide resolved

CHANGELOG.md Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Show resolved Hide resolved

cyclimse added 3 commits February 27, 2023 12:07

fix(ci): missing install python

195db24

chore: update README

4c1d0e7

chore: clean up gitignore

c6a3333

thomas-tacquet previously approved these changes Feb 27, 2023

View reviewed changes

docs: use README from serverless go

19a5335

cyclimse dismissed thomas-tacquet’s stale review via 19a5335 February 27, 2023 16:56

docs: add contributing from serverless go

d245c8b

cyclimse requested review from Shillaker and thomas-tacquet February 27, 2023 17:03

cyclimse added 3 commits February 28, 2023 08:39

docs: update contributing

86750ce

docs: readme remove duplicated sections

e011b4f

docs: update readme

efa4d50

Shillaker requested changes Feb 28, 2023

View reviewed changes

cyclimse added 2 commits February 28, 2023 14:13

refactor: apply review suggestions

be40eff

chore: delete docs folder

2fe2502

Shillaker approved these changes Feb 28, 2023

View reviewed changes

thomas-tacquet approved these changes Feb 28, 2023

View reviewed changes

cyclimse merged commit 721e276 into main Feb 28, 2023

cyclimse deleted the feat/setup-repo branch February 28, 2023 14:23

cyclimse mentioned this pull request Mar 2, 2023

Edit doc to comply with the go one #7

Merged

3 tasks

		@@ -0,0 +1,75 @@
		# Serverless Functions Python 💜

		Scaleway Serverless Functions is a framework to provide a good developer experience to write Serverless Functions.


		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.


		Serverless Functions make it easy to deploy, scale, and optimize your workloads on the cloud.

		## ⚙️ Installation

		from serverless_functions_python import Context, Event, Response


		def handler(event: "Event", context: "Context") -> "Response":

feat: setup repo #1

feat: setup repo #1

Uh oh!

Conversation

cyclimse commented Feb 24, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cyclimse Feb 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

cyclimse commented Feb 24, 2023 •

edited

Loading

cyclimse Feb 28, 2023 •

edited

Loading