Skip to main content

DRY, configurable, opinionated, minimalist framework for use with AWS Serverless Lambdas

Project description

CircleCI Quality Gate Status

Acai AWS

DRY, configurable, declarative python library for working with Amazon Web Service Lambdas.

Features

  • Highly configurable apigateway internal router
  • Openapi schema adherence for all event types
  • Generate OpenAPI docs from code base
  • Extensible and customizable middleware for validation and other tasks
  • DRY coding interfaces without the need of boilerplate
  • Ease-of-use with the serverless framework
  • Local Development support
  • Happy Path Programming (See Philosophy below)

Philosophy

The Acai philosophy is to provide a dry, configurable, declarative library for use with the amazon lambdas, which encourages Happy Path Programming (HPP).

Happy Path Programming is an idea in which inputs are all validated before operated on. This ensures code follows the happy path without the need for mid-level, nested exceptions and all the nasty exception handling that comes with that. The library uses layers of customizable middleware options to allow a developer to easily dictate what constitutes a valid input, without nested conditionals, try/catch blocks or other coding blocks which distract from the happy path that covers the majority of that codes intended operation.

Installation

This is a python module available through the pypi registry.

Before installing, download and install python. python 3 or higher is required.

Installation is done using the pip install command:

$ pip install acai_aws
# pipenv install acai_aws
# poetry add acai_aws

Documentation & Examples

Contributing

If you would like to contribute please make sure to follow the established patterns and unit test your code:

Unit Testing

To run unit test, enter command:

$ pipenv install
$ pipenv run test

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

acai_aws-2.2.3.tar.gz (53.2 kB view details)

Uploaded Source

Built Distribution

acai_aws-2.2.3-py3-none-any.whl (101.6 kB view details)

Uploaded Python 3

File details

Details for the file acai_aws-2.2.3.tar.gz.

File metadata

  • Download URL: acai_aws-2.2.3.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for acai_aws-2.2.3.tar.gz
Algorithm Hash digest
SHA256 2cee1610185fe5cfefecc1a2c4e31d96515f1194bd9f77da468746db6d8d7a1d
MD5 8d28edfa9150ee272d66bd2098c2b23c
BLAKE2b-256 6afb93682186bb9f1461e9566bde4d60c40fa695494c0a199ba64e76d7631d4b

See more details on using hashes here.

File details

Details for the file acai_aws-2.2.3-py3-none-any.whl.

File metadata

  • Download URL: acai_aws-2.2.3-py3-none-any.whl
  • Upload date:
  • Size: 101.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for acai_aws-2.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 9db2203b8900022c481dd3a8b2b90b968777830c60629c834b6b4a55689ab368
MD5 aa2d5b30ab0d435c58a5eb9c9c5515bc
BLAKE2b-256 786bdfdc91db329b7df0d771ce1b674f61488bae2b223aeb68aa86f410b79f54

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page