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.4.tar.gz (53.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

acai_aws-2.2.4-py3-none-any.whl (101.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: acai_aws-2.2.4.tar.gz
  • Upload date:
  • Size: 53.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for acai_aws-2.2.4.tar.gz
Algorithm Hash digest
SHA256 7c43e01f5e104d69c25371479bfec41b2c6e7ee6004f45e25d42cdd461678395
MD5 febb20845d5afe359e90c0daca876f6b
BLAKE2b-256 bc2bc90ff25be5a8f22830336b6ee5117a13b44c6db2e7196660eb2edadcdeac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: acai_aws-2.2.4-py3-none-any.whl
  • Upload date:
  • Size: 101.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.23

File hashes

Hashes for acai_aws-2.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f20d0dea77ad517b97dd67332bcc5c880ade8d4caf4c522477aa3f16d4a9dd
MD5 1b4f00b53309f35485d86f71737deebb
BLAKE2b-256 3a06e7808388c3cdc4f1c6aa03a8da0ba159b9d973e1032aa965a0d5965976bb

See more details on using hashes here.

Supported by

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