pygrestqlambda 0.0.0__tar.gz

pygrestqlambda-0.0.0/.github/workflows/publish.yml

@@ -0,0 +1,28 @@
+name: Publish
+
+on:
+  push:
+    tags: [ '*.*.*' ]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      # Checkout project code
+      - uses: actions/checkout@v4
+
+      # Set up python environment
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      # Re-run validation and build
+      - name: Validate
+        run: ./scripts/validate.sh
+
+      # Get pypi credentials and publish
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pygrestqlambda-0.0.0/.github/workflows/validate.yml

@@ -0,0 +1,25 @@
+name: Validate
+
+# Only run on PRs to the main branch
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout project code
+      - uses: actions/checkout@v3
+
+      # Install and run shellcheck for all shell scripts
+      - run: sudo apt install shellcheck
+      - run: for f in $(find scripts -type f -name *.sh); do shellcheck $f; done;
+
+      # Use python setup action to configure version
+      - uses: actions/setup-python@v3
+        with:
+          python-version: '3.x'
+
+      # Install python poetry and dependencies for use in later steps
+      - run: ./scripts/validate.sh

pygrestqlambda-0.0.0/.gitignore

@@ -0,0 +1,10 @@
+# Python
+__pycache__
+
+# Pytest
+/,pytest_cache
+/.coverage
+/htmlcov
+
+# Build
+/dist

pygrestqlambda-0.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Voquis Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pygrestqlambda-0.0.0/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: pygrestqlambda
+Version: 0.0.0
+Summary: PostgreSQL REST API framework for AWS Lambda functions
+Project-URL: Homepage, https://github.com/mesogate/pygrestqlambda
+Project-URL: Issues, https://github.com/mesogate/pygrestqlambda/issues
+Author-email: Voquis Limited <opensource@voquis.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: aws-xray-sdk
+Requires-Dist: boto3
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Python PostgreSQL REST API framework for AWS Lambda functions
+> [!NOTE]
+> Project status: `Alpha`
+
+A REST API web framework for persisting records in a PostgreSQL database.
+
+## Supported features
+- Automatic creation of `uid` fields
+- Automatic setting of `created_at` and `last_updated_at` timestamps
+- Automatic setting of `creator_uid` and `last_updater_uid`
+- RDS with IAM credentials

pygrestqlambda-0.0.0/README.md

@@ -0,0 +1,11 @@
+# Python PostgreSQL REST API framework for AWS Lambda functions
+> [!NOTE]
+> Project status: `Alpha`
+
+A REST API web framework for persisting records in a PostgreSQL database.
+
+## Supported features
+- Automatic creation of `uid` fields
+- Automatic setting of `created_at` and `last_updated_at` timestamps
+- Automatic setting of `creator_uid` and `last_updater_uid`
+- RDS with IAM credentials

pygrestqlambda-0.0.0/pyproject.toml

@@ -0,0 +1,37 @@
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[project]
+name = "pygrestqlambda"
+version = "0.0.0"
+description = "PostgreSQL REST API framework for AWS Lambda functions"
+readme = "README.md"
+requires-python = ">=3.11"
+
+authors = [{ name = "Voquis Limited", email = "opensource@voquis.com" }]
+
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+]
+
+dependencies = [
+  "aws-xray-sdk",
+  "boto3"
+]
+
+[project.optional-dependencies]
+dev = [
+  "build",
+  "pylint",
+  "pytest",
+  "pytest-cov",
+  "ruff",
+  "twine"
+]
+
+[project.urls]
+Homepage = "https://github.com/mesogate/pygrestqlambda"
+Issues = "https://github.com/mesogate/pygrestqlambda/issues"

pygrestqlambda-0.0.0/scripts/validate.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -euo pipefail
+
+# Assumes the src contains a single package to be built
+PACKAGE_PATH=$(find src/* -type d -not -path "src/__*" | head -n 1)
+PACKAGE_NAME=${PACKAGE_PATH#src/}
+echo "Using package path: $PACKAGE_PATH"
+echo "Using package name: $PACKAGE_NAME"
+
+# Install development dependencies with pip
+pip install .[dev]
+
+# Run formatting checks
+echo "Running ruff"
+ruff check
+
+echo "Running pylint"
+pylint src tests
+
+# Run tests and generate coverage reports
+echo "Running pytest"
+pytest --cov="$PACKAGE_NAME" \
+  --cov-report term \
+  --cov-report html \
+  --cov-fail-under=100.00
+
+# Check the build
+python -m build
+twine check --strict dist/*

pygrestqlambda-0.0.0/src/pygrestqlambda/aws/lambda_function/json_transform.py

@@ -0,0 +1,18 @@
+from uuid import UUID
+from datetime import datetime
+
+
+def json_output(value: object) -> str:
+    """
+    Calculates the serialised version of an object to return in a JSON response
+    """
+
+    # Handle UUIDs
+    if isinstance(value, UUID):
+        value = str(value)
+
+    # Handle timestamps
+    if isinstance(value, datetime):
+        value = value.isoformat()
+
+    return value

pygrestqlambda-0.0.0/src/pygrestqlambda/aws/lambda_function/proxy_integration_respose.py

@@ -0,0 +1,54 @@
+"""
+Receives payload in format sent by AWS REST API Gateway
+https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-input-format
+
+Returns payload structure expected by REST API Gateway
+https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
+"""
+
+import logging
+import json
+from dataclasses import dataclass
+from pygrestqlambda.aws.lambda_function.json_transform import json_output
+from base64 import b64encode
+
+
+@dataclass
+class LambdaFunctionProxyIntegrationResponse:
+    """
+    Lambda function response
+    """
+    is_base64_encoded: bool | None = False
+    status_code: int | None = 401
+    headers: dict | None = None
+    multi_value_headers: dict | None = None
+    body: str | None = None
+
+    def get_payload(self) -> dict:
+        """
+        Gets payload to send to REST API Gateway
+        """
+
+        # Set headers
+        if self.headers is None:
+            self.headers = {}
+
+        if "Content-Type" not in self.headers:
+            self.headers["Content-Type"] = "application/json"
+
+        # Calculate body
+        if self.is_base64_encoded:
+            body = b64encode(self.body).decode("utf-8")
+        else:
+            body = json.dumps(self.body, default=json_output)
+
+        logging.debug("Transforming dataclass dictionary to JSON")
+        data = {
+            "isBase64Encoded": self.is_base64_encoded,
+            "statusCode": self.status_code,
+            "headers": self.headers,
+            "multiValueHeaders": self.multi_value_headers,
+            "body": body,
+        }
+
+        return data

pygrestqlambda-0.0.0/src/pygrestqlambda/db/record.py

@@ -0,0 +1,66 @@
+from abc import ABCMeta
+
+
+class Record(metaclass=ABCMeta):
+    """
+    Generic record that maps to a row in a database table
+    """
+
+    def __init__(self, conn: bool = False) -> None:
+        self.conn = conn
+
+    def before_create(self):
+        """
+        Runs before a new record is created. Useful for mutating a new record
+        before being committed.
+        """
+        pass
+
+    def before_read(self):
+        """
+        Before a record is retrieved from the database. Useful for injecting
+        filters or sorting.
+        """
+        pass
+
+    def before_update(self):
+        """
+        Before a new record is created. Useful for mutating a record before it
+        is committed.
+        """
+        pass
+
+    def before_delete(self):
+        """
+        Before an existing record is deleted. Useful for e.g. updating counters
+        or other aggregate fields in other tables.
+        """
+        pass
+
+    def after_create(self):
+        """
+        Runs after a new record is created. Useful for updating e.g. counters
+        tables.
+        """
+        pass
+
+    def after_read(self):
+        """
+        After a record is retrieved from the database. Useful for transforming
+        retrieved data.
+        """
+        pass
+
+    def after_update(self):
+        """
+        Runs after a new record is updated. Useful for updating e.g. counters
+        tables.
+        """
+        pass
+
+    def after_delete(self):
+        """
+        Runs after an existing record is deleted. Useful for updating e.g.
+        counters tables.
+        """
+        pass

pygrestqlambda-0.0.0/tests/aws/lambda_function/test_json_transform.py

@@ -0,0 +1,27 @@
+"""
+Test JSON transformation for lambda proxy integration response
+"""
+
+from uuid import uuid4
+from datetime import datetime
+from pygrestqlambda.aws.lambda_function.json_transform import json_output
+
+
+def test_uuid():
+    """
+    Test UUIDs are transformed correctly
+    """
+
+    uid = uuid4()
+
+    assert json_output(uid) == str(uid)
+
+
+def test_datetime():
+    """
+    Test UUIDs are transformed correctly
+    """
+
+    now = datetime.now()
+
+    assert json_output(now) == now.isoformat()

pygrestqlambda-0.0.0/tests/test_record.py

@@ -0,0 +1,8 @@
+# from pygrestqlambda.db. import Record
+
+# def test_record():
+#     """
+
+#     """
+#     record = Record()
+#     assert record.conn