aws-cdk-common 0.1.46

A shared package for common modules and constants for AWS Lambda applications

aws-cdk-common

aws-cdk-common is a shared package for common modules and constants for AWS Lambda applications based on AWS CDK.

Python environment

Installing Poetry

Poetry is a tool to manage Python projects in a deterministic way.

Installing pipx

pipx installs and runs Python applications in an isolated environment. Follow the instructions listed in pipx documentation for your specific environment.

Installing Poetry

pipx install poetry

Installing required modules

To install required modules, run:

poetry install --no-root

Setting Up the Development Environment

To install required modules for development, run:

poetry install --with dev --no-root

Activating the Virtual Environment

Starting with Poetry 2.x, the poetry shell command is no longer available. To activate the virtual environment:

1. Find the path to the Poetry-managed virtual environment:

   poetry env info --path
   

2. Activate the virtual environment:

   • Linux/macOS:

     source $(poetry env info --path)/bin/activate
     

   • Windows (PowerShell):

     . $(poetry env info --path)/Scripts/activate
     

Alternatively, you can directly execute commands in the Poetry-managed environment without activating the shell by prefixing commands with poetry run.

Pre-commit Hooks

We use pre-commit to ensure consistent code quality. Install the pre-commit hooks by running:

poetry run pre-commit install

Code Formatting and Quality Checks

• To format code with Black:

poetry run black .

• To sort imports with isort:

poetry run isort .

• To check code quality with Flake8:

poetry run flake8 .

These tools help maintain code quality and consistency across the project.

Tests

Unit tests

To run unit tests, after installing required modules for development, run:

poetry run pytest tests/unit

Integration tests

To run integration tests, after installing required modules for development, run:

poetry run pytest tests/integration

All tests

You can also run all tests (unit and integration) by running:

poetry run pytest