https://github.com/aleksac/terraform-py

pip installable terraform binary with wrapper for pre-commit
https://github.com/aleksac/terraform-py

pre-commit pre-commit-hook terraform

Last synced: 5 days ago
JSON representation

pip installable terraform binary with wrapper for pre-commit

• Host: GitHub
• URL: https://github.com/aleksac/terraform-py
• Owner: AleksaC
• License: mit
• Created: 2022-05-11T22:50:44.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T12:10:29.000Z (28 days ago)
• Last Synced: 2024-10-19T16:21:25.528Z (26 days ago)
• Topics: pre-commit, pre-commit-hook, terraform
• Language: Python
• Homepage:
• Size: 163 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# terraform-py

[![Add new versions](https://github.com/AleksaC/terraform-py/actions/workflows/add-new-versions.yml/badge.svg)](https://github.com/AleksaC/terraform-py/actions/workflows/add-new-versions.yml)

[![Run tests](https://github.com/AleksaC/terraform-py/actions/workflows/tests.yml/badge.svg)](https://github.com/AleksaC/terraform-py/actions/workflows/tests.yml)

pip installable [terraform](https://github.com/hashicorp/terraform) binary with wrapper for pre-commit.

The mechanism by which the terraform binary is downloaded is adapted from

[shellcheck-py](https://github.com/shellcheck-py/shellcheck-py).

## Getting started

### Installation

This package has been built to make it more convenient to run `terraform fmt`

`terraform validate` as pre-commit hooks so it hasn't been published to PyPI.

However you can install it using git:

```shell script

pip install git+https://github.com/AleksaC/[email protected]

```

### pre-commit hooks

Since `terraform fmt` and `terraform validate` take directories as inputs they

can't be used as pre-commit hooks directly. Hence there are wrappers for the

two commands that take list of filenames as input and run the commands on the

directories they are in. To use the hooks include the following config in your

`.pre-commit-config.yaml` file:

```yaml

repos:

  - repo: https://github.com/AleksaC/terraform-py

    rev: v1.9.8

    hooks:

      - id: tf-fmt

      - id: tf-validate

```

## Limitations

This package mirrors all terraform releases currently available on github,

however fmt and validate commands weren't available on the oldest versions

and worked differently in the initial releases. This shouldn't be a problem

since I don't expect versions so old to be used.

Versions before `1.0.3` won't work on Macs with M1 chip since darwin arm builds

weren't available for earlier versions. While x86 binaries would work

I didn't want to support that edge case in the platform detection code as it

won't be needed for the future releases.

`terraform validate` itself isn't particularly fast. In addition to that

`terraform init` needs to be performed before it, making it even slower.

In projects with lots of modules this can get quite slow, so you may need

to set up additional caching beside the one for pre-commit.

## Contact 🙋‍♂️

- [Personal website](https://aleksac.me)

- 

- [email protected]