cloudformation-utils

A Python library for reading, writing and pre-processing CloudFormation YAML stacks


Keywords
aws, cloudformation, yaml, infrastructure, devops
License
Other
Install
pip install cloudformation-utils==0.0.3

Documentation

CloudFormation Utils

CI PyPI version Python versions License

A Python library for reading, writing and pre-processing CloudFormation YAML stacks.

Features

  • Read and write CloudFormation templates in YAML format
  • Pre-process templates with custom logic
  • Validate template structure
  • Support for modern Python versions (3.8+)

Installation

Install from PyPI:

pip install cloudformation-utils

For development:

git clone https://github.com/NitorCreations/cloudformation-utils.git
cd cloudformation-utils
make setup-dev

Usage

import cloudformation_utils

# Your usage examples here

Development

This project uses modern Python packaging and development tools:

Setup Development Environment

make setup-dev

This will:

  • Install the package in development mode
  • Install all development dependencies
  • Set up pre-commit hooks

Available Commands

make help                # Show all available commands
make test               # Run tests
make test-cov           # Run tests with coverage
make lint               # Run linting
make format             # Format code
make type-check         # Run type checking
make quality            # Run all quality checks
make build              # Build the package
make clean              # Clean build artifacts

Code Quality

This project uses:

Testing

Run tests:

make test

Run tests with coverage:

make test-cov

Releasing

Releases are automated via GitHub Actions when you push a tag:

git tag v0.0.4  # Next version after current 0.0.3
git push origin v0.0.4

Requirements

  • Python 3.8 or higher
  • PyYAML 6.0 or higher

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Run the test suite and quality checks
  5. Submit a pull request

Please ensure your code follows the project's coding standards and includes appropriate tests.