Metadata-Version: 2.1
Name: py-tf-utils
Version: 0.1.0
Summary: Various Terraform Utilities
Home-page: https://github.com/phillipjf/tf-utils
Author: Phillip Ferentinos
Author-email: phillip.jf@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: python-hcl2
Requires-Dist: tabulate

# py-tf-utils

This project contains a command-line tool for various Terraform utilities.

For an example, see the `sample-module` directory.

## Installation

```sh
pip install py-tf-utils
```

## Usage

To test with the sample project:

```sh
# Will generate docs for `sample-module` and `sub-module`
tf-utils docs sample-module

# Will ONLY generate docs for `sub-module`
tf-utils docs sample-module/sub-module/

# Will show unused variables in `sample-module` and `sub-module`
tf-utils unused sample-module

# Will ONLY show unused variables in `sub-module`
tf-utils unused sample-module/sub-module/
```

The documentation can also be redirected to a file:

```sh
tf-utils docs sample-module/sub-module/ >> TF_DOCS.md
```

## Background

- [Using terraform-docs to keep your module documentation in sync](https://www.davidbegin.com/using-terraform-docs-to-automate-keeping-your-terraform-modules-documenting/)
- [Finding unused variables in a Terraform module](https://alexwlchan.net/2019/05/finding-unused-variables-in-a-terraform-module/)

