Metadata-Version: 2.4
Name: cdk_mate
Version: 1.0.1
Summary: A comprehensive Python toolkit for simplifying AWS CDK deployment workflows across multiple stacks
Author-email: Sanhe Hu <husanhe@gmail.com>
Maintainer-email: Sanhe Hu <husanhe@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/MacHu-GWU/cdk_mate-project
Project-URL: Documentation, https://cdk-mate.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/MacHu-GWU/cdk_mate-project
Project-URL: Issues, https://github.com/MacHu-GWU/cdk_mate-project/issues
Project-URL: Changelog, https://github.com/MacHu-GWU/cdk_mate-project/blob/main/release-history.rst
Project-URL: Download, https://pypi.org/pypi/cdk-mate#files
Keywords: aws,cdk,cloudformation,iac,deployment
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: <4.0,>=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.txt
License-File: AUTHORS.rst
Requires-Dist: boto3<2.0.0,>=1.35.99
Requires-Dist: boto-session-manager<3.0.0,>=2.1.1
Requires-Dist: aws-cdk-lib<3.0.0,>=2.0.0
Requires-Dist: func-args<2.0.0,>=1.0.2
Provides-Extra: dev
Requires-Dist: rich<15.0.0,>=14.3.4; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest<10.0.0,>=9.1.1; extra == "test"
Requires-Dist: pytest-cov<8.0.0,>=7.1.0; extra == "test"
Requires-Dist: moto<6.0.0,>=5.1.22; extra == "test"
Provides-Extra: doc
Requires-Dist: Sphinx<9.0.0,>=8.2.3; extra == "doc"
Requires-Dist: sphinx-copybutton<1.0.0,>=0.5.2; extra == "doc"
Requires-Dist: sphinx-design<1.0.0,>=0.7.0; extra == "doc"
Requires-Dist: sphinx-jinja<3.0.0,>=2.0.2; extra == "doc"
Requires-Dist: furo==2025.12.19; extra == "doc"
Requires-Dist: pygments<3.0.0,>=2.18.0; extra == "doc"
Requires-Dist: ipython<8.19.0,>=8.18.1; extra == "doc"
Requires-Dist: ipykernel<8.0.0,>=7.3.0; extra == "doc"
Requires-Dist: nbsphinx<1.0.0,>=0.9.8; extra == "doc"
Requires-Dist: rstobj<3.0.0,>=2.0.0; extra == "doc"
Requires-Dist: docfly<4.0.0,>=3.0.3; extra == "doc"
Provides-Extra: mise
Requires-Dist: PyGithub<3.0.0,>=2.8.0; extra == "mise"
Requires-Dist: httpx2<3.0.0,>=2.13.1; extra == "mise"
Dynamic: license-file


.. image:: https://readthedocs.org/projects/cdk-mate/badge/?version=latest
    :target: https://cdk-mate.readthedocs.io/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/MacHu-GWU/cdk_mate-project/actions/workflows/main.yml/badge.svg
    :target: https://github.com/MacHu-GWU/cdk_mate-project/actions?query=workflow:CI

.. image:: https://codecov.io/gh/MacHu-GWU/cdk_mate-project/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/MacHu-GWU/cdk_mate-project

.. image:: https://img.shields.io/pypi/v/cdk-mate.svg
    :target: https://pypi.python.org/pypi/cdk-mate

.. image:: https://img.shields.io/pypi/l/cdk-mate.svg
    :target: https://pypi.python.org/pypi/cdk-mate

.. image:: https://img.shields.io/pypi/pyversions/cdk-mate.svg
    :target: https://pypi.python.org/pypi/cdk-mate

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/cdk_mate-project/blob/main/release-history.rst

.. image:: https://img.shields.io/badge/⭐_Star_me_on_GitHub!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/cdk_mate-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://cdk-mate.readthedocs.io/en/latest/py-modindex.html

.. image:: https://img.shields.io/badge/Link-Install-blue.svg
    :target: `install`_

.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
    :target: https://github.com/MacHu-GWU/cdk_mate-project

.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
    :target: https://github.com/MacHu-GWU/cdk_mate-project/issues

.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
    :target: https://github.com/MacHu-GWU/cdk_mate-project/issues

.. image:: https://img.shields.io/badge/Link-Download-blue.svg
    :target: https://pypi.org/pypi/cdk-mate#files


Welcome to ``cdk_mate`` Documentation
==============================================================================
.. image:: https://cdk-mate.readthedocs.io/en/latest/_static/cdk_mate-logo.png
    :target: https://cdk-mate.readthedocs.io/en/latest/

CDK Mate is a comprehensive toolkit for managing AWS CDK deployments across multiple stacks and environments with minimal boilerplate code. It provides a flexible framework for organizing CDK stacks with clear separation between stack definition and deployment concerns. Key features include a powerful stack context management system for handling different environments (dev, test, prod), Python wrappers around CDK CLI commands for automated deployments, utilities for credential management, and best practices for multi-stack project organization. The library simplifies complex infrastructure deployments by enabling consistent configuration across environments while supporting both individual stack development and full environment deployments. CDK Mate helps development teams scale their infrastructure as code implementations while maintaining clean, testable, and maintainable code architecture.


.. _install:

Install
------------------------------------------------------------------------------

``cdk_mate`` is released on PyPI, so all you need is to:

.. code-block:: console

    $ pip install cdk-mate

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade cdk-mate


Claude Skill
------------------------------------------------------------------------------

This repo ships a Claude skill, `pypi-cdk_mate <https://github.com/MacHu-GWU/cdk_mate-project/tree/main/.claude/skills/pypi-cdk_mate>`_, that teaches AI coding agents such as Claude Code the public API of ``cdk_mate`` 1.x, its command classes, and the multi stack, multi environment best practices. To use it in all your projects, copy the folder into your personal skills directory:

.. code-block:: console

    $ git clone --depth 1 https://github.com/MacHu-GWU/cdk_mate-project.git
    $ cp -r cdk_mate-project/.claude/skills/pypi-cdk_mate ~/.claude/skills/
