feat: initial code release (#2)

* feat: migrate to github

* chore: stop using |=

* refactor: change versioning order

* refactor: raise the exception instead of catching it

* fix: bad imports with src layout

* fix(framework): use older hints api to keep python3.8 compat

* chore: disable locally mypy because of issue with not-required

* fix(examples): change hints location

* chore: run mypy in strict mode

* fix: small error in code found by pylance

* chore: rename project with dashes

* chore: refrasing and spacing mistakes

* chore(test): format dict in test

* chore(ci): remove reporting

* docs: update emoji in readme reach-us for consistency accross repo

* refactor: rename folders

* refactor: add dunder to _format_request_context

* docs: remove unecessary emoji

Author: cyclimse

.github/CONTRIBUTING.md

@@ -79,4 +79,4 @@ Keep in mind only the **pull request title** will be used as the commit message
 
 See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
 
-Thank you for reading through all of this, if you have any questions feel free to [reach us](../README.md#💜-reach-us)!
+Thank you for reading through all of this, if you have any questions feel free to [reach us](../README.md#reach-us)!

.github/workflows/pytest.yml

@@ -14,7 +14,7 @@ jobs:
   test:
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     runs-on: ubuntu-22.04
     steps:
@@ -39,14 +39,4 @@ jobs:
 
       - name: Test with pytest
         working-directory: tests
-        run: poetry run pytest --junitxml=junit/test-results-${{ matrix.python-version
-          }}.xml
-
-      - name: Upload pytest report
-        uses: actions/upload-artifact@v3
-        with:
-          name: pytest-results-${{ matrix.python-version }}
-          path: tests/junit/test-results-${{ matrix.python-version }}.xml
-          retention-days: 3
-        # Use always() to always run this step to publish test results when there are test failures
-        if: ${{ always() }}
+        run: poetry run pytest

.github/workflows/report.yml

@@ -51,13 +51,15 @@ repos:
         additional_dependencies:
           - tomli # for reading config from pyproject.toml
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.0.0
+    rev: v1.0.1
     hooks:
       - id: mypy
+        exclude: "^tests/" # See: https://github.com/pre-commit/mirrors-mypy/issues/1
+        args: [--ignore-missing-imports] # Needed because pre-commit runs mypy in a venv
         additional_dependencies:
           - typing_extensions
-  - repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
-    rev: v1.0.6
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.4
     hooks:
-      - id: python-bandit-vulnerability-check
+      - id: bandit
         args: [--skip, B101, --recursive, clumper]

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 # Serverless Functions Python 💜
 
-This repo contains utilities for testing your Python functions for Scaleway Serverless Functions.
+This repo contains utilities for testing your Python handlers for Scaleway Serverless Functions.
 
 ## ⚙️ Quick Start
 
@@ -59,7 +59,7 @@ We welcome all contributions to our open-source projects, please see our [contri
 
 Do not hesitate to raise issues and pull requests we will have a look at them.
 
-## 💜 Reach Us
+## 📭 Reach Us
 
 We love feedback. Feel free to:
 

README.md

@@ -2,7 +2,9 @@
 from typing import TYPE_CHECKING
 
 if TYPE_CHECKING:
-    from serverless_functions_python import Context, Event, Response
+    # Doing a conditional import avoids the need to install the library
+    # when deploying the function
+    from scaleway_functions_python.framework.v1.hints import Context, Event, Response
 
 
 def handler(event: "Event", context: "Context") -> "Response":
@@ -18,6 +20,6 @@ def handler(event: "Event", context: "Context") -> "Response":
 
 
 if __name__ == "__main__":
-    from serverless_functions_python import serve_handler_locally
+    from scaleway_functions_python import local
 
-    serve_handler_locally(handler)
+    local.serve_handler(handler)

examples/mirror.py

@@ -1,7 +1,7 @@
 [tool.poetry]
-name = "serverless-functions-python"
+name = "scaleway-functions-python"
 version = "0.1.0"
-description = "Framework to provide a good developer experience when writing Serverless Functions in Python."
+description = "Utilities for testing your Python handlers for Scaleway Serverless Functions."
 authors = ["Scaleway Serverless Team <opensource@scaleway.com>"]
 
 readme = "README.md"
@@ -27,10 +27,6 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
 ]
 
-packages = [
-    { include = "framework", from = "src" },
-    { include = "testing", from = "src" },
-]
 include = ["CHANGELOG.md"]
 
 [tool.poetry.dependencies]
@@ -56,7 +52,6 @@ requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
 [tool.pytest.ini_options]
-pythonpath = ["src"]
 testpaths = ["tests"]
 
 [tool.pylint]
@@ -65,15 +60,22 @@ disable = "missing-module-docstring"
 # Commented Black formatted code.
 max-line-length = 89
 # Short and common names. e is commonly used for exceptions.
-good-names = "i,fp,e"
+good-names = "i,e"
 
 [tool.pylint-per-file-ignores]
-# Redfined outer name is for pytest fixtures
+# Import aliases are prefered over unused imports or __all__
+"__init__.py" = "useless-import-alias"
+# Redefined outer name is for pytest fixtures
 "/tests/" = "missing-class-docstring,missing-function-docstring,protected-access,redefined-outer-name"
 
 [tool.isort]
 profile = "black"
 
+[tool.mypy]
+python_version = "3.8"
+strict = true
+exclude = "tests"
+
 [tool.pydocstyle]
 # Compatible with Sphinx
 convention = "google"

pyproject.toml

@@ -0,0 +1,3 @@
+from . import local as local
+from .framework import v1 as v1
+from .local.serving import serve_handler as serve_handler

scaleway_functions_python/__init__.py

@@ -0,0 +1 @@
+from . import v1 as v1

scaleway_functions_python/framework/__init__.py

@@ -0,0 +1 @@
+from . import hints as hints