Metadata-Version: 2.3
Name: cdkit
Version: 0.1.3
Summary: A comprehensive AWS CDK utility library for creating type-safe, parameter-managed infrastructure configurations with pre-built vertical solution stacks.
License: MIT
Author: Sanhe Hu
Author-email: husanhe@gmail.com
Maintainer: Sanhe Hu
Maintainer-email: husanhe@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Provides-Extra: auto
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: Sphinx (>=7.4.7,<8.0.0) ; extra == "doc"
Requires-Dist: aws-cdk-lib (>=2.179.0,<3.0.0)
Requires-Dist: boto-session-manager (>=1.7.2,<2.0.0) ; extra == "test"
Requires-Dist: boto3 (>=1.35.99,<2.0.0) ; extra == "test"
Requires-Dist: build (>=1.2.1,<2.0.0) ; extra == "dev"
Requires-Dist: cdk-mate (>=0.1.4,<1.0.0) ; extra == "test"
Requires-Dist: docfly (==3.0.0) ; extra == "doc"
Requires-Dist: func-args (>=1.0.0,<2.0.0)
Requires-Dist: furo (==2024.8.6) ; extra == "doc"
Requires-Dist: ipython (>=8.18.1,<8.19.0) ; extra == "doc"
Requires-Dist: jinja2 (>=3.0.3,<4.0.0) ; extra == "dev"
Requires-Dist: moto (>=5.0.28,<6.0.0) ; extra == "test"
Requires-Dist: nbsphinx (>=0.8.12,<1.0.0) ; extra == "doc"
Requires-Dist: pygments (>=2.18.0,<3.0.0) ; extra == "doc"
Requires-Dist: pytest (>=8.2.2,<9.0.0) ; extra == "test"
Requires-Dist: pytest-cov (>=6.0.0,<7.0.0) ; extra == "test"
Requires-Dist: requests (>=2.31.0,<3.0.0) ; extra == "dev"
Requires-Dist: rich (>=13.8.1,<14.0.0) ; extra == "dev"
Requires-Dist: rstobj (==1.2.1) ; extra == "doc"
Requires-Dist: sphinx-copybutton (>=0.5.2,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-design (>=0.6.1,<1.0.0) ; extra == "doc"
Requires-Dist: sphinx-jinja (>=2.0.2,<3.0.0) ; extra == "doc"
Requires-Dist: twine (>=6.0.0,<7.0.0) ; extra == "dev"
Requires-Dist: wheel (>=0.45.0,<1.0.0) ; extra == "dev"
Project-URL: Changelog, https://github.com/MacHu-GWU/cdkit-project/blob/main/release-history.rst
Project-URL: Documentation, https://cdkit.readthedocs.io/en/latest/
Project-URL: Download, https://pypi.org/pypi/cdkit#files
Project-URL: Homepage, https://github.com/MacHu-GWU/cdkit-project
Project-URL: Issues, https://github.com/MacHu-GWU/cdkit-project/issues
Project-URL: Repository, https://github.com/MacHu-GWU/cdkit-project
Description-Content-Type: text/x-rst


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

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

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

.. image:: https://img.shields.io/pypi/v/cdkit.svg
    :target: https://pypi.python.org/pypi/cdkit

.. image:: https://img.shields.io/pypi/l/cdkit.svg
    :target: https://pypi.python.org/pypi/cdkit

.. image:: https://img.shields.io/pypi/pyversions/cdkit.svg
    :target: https://pypi.python.org/pypi/cdkit

.. image:: https://img.shields.io/badge/✍️_Release_History!--None.svg?style=social&logo=github
    :target: https://github.com/MacHu-GWU/cdkit-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/cdkit-project

------

.. image:: https://img.shields.io/badge/Link-API-blue.svg
    :target: https://cdkit.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/cdkit-project

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

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

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


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

``cdkit`` is a comprehensive AWS CDK utility library designed to streamline infrastructure-as-code development with enhanced parameter management, construct abstractions, and pre-built vertical solution stacks. It provides robust tools for creating AWS resources with improved type safety, parameter validation, and simplified configuration. For practical usage examples, developers are encouraged to explore the sample implementations in the `cdkit/tests/ <https://github.com/MacHu-GWU/cdkit-project/tree/main/cdkit/tests>`_ directory and the `cdk/ <https://github.com/MacHu-GWU/cdkit-project/tree/main/cdk>`_ folder, which demonstrate how to leverage the library's advanced features for creating complex cloud infrastructure configurations.


.. _install:

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

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

.. code-block:: console

    $ pip install cdkit

To upgrade to latest version:

.. code-block:: console

    $ pip install --upgrade cdkit

