Metadata-Version: 2.4
Name: aws-cdk-modules
Version: 1.0.0.dev2
Summary: Python repository for AWS CDK modules
Project-URL: Documentation, https://collier-p-charlie.github.io/aws-cdk-modules
Project-URL: Repository, https://github.com/collier-p-charlie/aws-cdk-modules
Project-URL: Issues, https://github.com/collier-p-charlie/aws-cdk-modules/issues
Project-URL: Changelog, https://github.com/collier-p-charlie/aws-cdk-modules/blob/main/CHANGELOG.md
Author-email: Charlie Collier <collier.p.charlie@gmail.com>
Maintainer-email: Charlie Collier <collier.p.charlie@gmail.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Framework :: Hatch
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Requires-Dist: aws-cdk-lib>=2.211.0
Requires-Dist: constructs>=10.4.2
Provides-Extra: docs
Requires-Dist: mkdocs; extra == 'docs'
Requires-Dist: mkdocs-material; extra == 'docs'
Requires-Dist: mkdocstrings[python]; extra == 'docs'
Provides-Extra: test
Requires-Dist: mypy; extra == 'test'
Requires-Dist: pre-commit; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: ruff; extra == 'test'
Description-Content-Type: text/markdown

# AWS CDK Modules

| Badges     |                                                                                                                                                                                                 |
|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| License    | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)                                                                                     |
| PyPI       | [![PyPI version](https://badge.fury.io/py/aws-cdk-modules.svg)](https://badge.fury.io/py/aws-cdk-modules) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/aws-cdk-modules.svg)](https://pypi.org/project/aws-cdk-modules/) |

| Version | Build Status                                                                                                                                                                                                                                                                                                                                    |
|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Main    | [![GitHub Build main](https://github.com/collier-p-charlie/aws-cdk-modules/actions/workflows/run-tests.yaml/badge.svg)](https://github.com/collier-p-charlie/aws-cdk-modules/actions) [![GitHub Build main](https://github.com/collier-p-charlie/aws-cdk-modules/actions/workflows/python-publish.yaml/badge.svg)](https://github.com/collier-p-charlie/aws-cdk-modules/actions) |

This repository contains **AWS CDK** _modules_ containing common design patterns.

**Table of contents**

- [Prerequisites](#prerequisites)
- [Modules](#modules)


## Prerequisites

This project uses `uv` as the primary **Python** package dependency manager.
This can be installed on **macOS** using `brew` (for other installation methods, see [here](https://docs.astral.sh/uv/getting-started/installation/)).
On first install, we should run the following commands:

```bash
uv sync --all-extras
pre-commit install
```


## Modules

X
