Smokestack
==========

**Smokestack** is a Python framework for deploying Amazon Web Services CloudFormation stacks.

- Supports CloudFormation template files.
- Supports any template generator that can emit template bodies as strings.
- Renders beautiful execution previews.
- Deploys stacks in parallel, with dependencies described per-stack.
- Makes your infrastructure-as-code deployable via the command line.

Requirements
------------

Smokestack requires Python 3.8 or later.

Installation
------------

.. code-block:: console

   pip install smokestack

Licence
-------

**Smokestack**  is released at `github.com/cariad/smokestack <https://github.com/cariad/smokestack>`_ under the MIT Licence.

See `LICENSE <https://github.com/cariad/smokestack/blob/main/LICENSE>`_ for more information.

Contributing
------------

To contribute a bug report, enhancement or feature request, please raise an issue at `github.com/cariad/smokestack/issues <https://github.com/cariad/smokestack/issues>`_.

If you want to contribute a code change, please raise an issue first so we can chat about the direction you want to take.

The Author
----------

Hello! 👋 I'm **Cariad Eccleston** and I'm a freelance DevOps and backend engineer. My contact details are available on my personal wiki at `cariad.earth <https://cariad.earth>`_.

Please consider supporting my open source projects by `sponsoring me on GitHub <https://github.com/sponsors/cariad/>`_.


Contents
--------

.. toctree::
   :maxdepth: 1

   self
   usage/index
   cli