Skip to content

Commit

Permalink
docs - basic usage / install (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
kapilt authored Sep 1, 2022
1 parent c517a41 commit 6769dc6
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ with the myriad real world usages of terraform, this library uses the
canonical implementation from terraform, along with the interpolation and evaluation
from defsec to offer a high level interface to parsing terraform modules.

# Installation

```
pip install tfparse
```

We currently distribute binaries for MacOS (x86_64, arm64) and Linux (x86_64, aarch64).


# Usage

A terraform module root, with `terraform init` having been performed to resolve module references.

```
from tfparse import load_from_path
parsed = load_from_path('path_to_terraform_root')
print(parsed.keys())
```

# Building

- requires a modern golang (1.18)
Expand Down

0 comments on commit 6769dc6

Please sign in to comment.