CFP
===

**CFP** is a Python package for building Amazon Web Services CloudFormation stack parameters.

- Supports cross-region and cross-account Systems Manager Parameter Store look-ups.
- Renders beautiful, colourful parameter keys and values for your logs.
- Compatible with Boto3.
- Unit testable.

Getting Started
---------------

**CFP** requires Python 3.8 or later.

Install **CFP** via pip:

.. code-block:: console

   $ pip install cfp

Licence
-------

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

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

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

To contribute a bug report, enhancement or feature request, please raise an issue at `github.com/cariad/cfp/issues <https://github.com/cariad/cfp/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
   stack-parameters
   sources/index