No description
Find a file
2016-12-21 00:41:08 +08:00
python_terraform 1. fix typo 2016-12-21 00:18:57 +08:00
test 1. add test case 2016-12-21 00:41:08 +08:00
.bumpversion.cfg Bump version: 0.7.8 → 0.8.0 2016-12-20 18:58:03 +08:00
.gitignore python-terraform-1 Make option with bool value/ more sense for the caller 2016-11-24 15:13:43 +08:00
.travis.yml update terraform bin files 2016-12-20 23:20:42 +08:00
DESCRIPTION.rst change description 2016-11-20 01:11:21 +08:00
LICENSE.txt 1. update travis deploy 2016-11-19 18:24:33 +08:00
MANIFEST.in release 0.0.2 to fury 2016-02-25 17:38:05 +08:00
README.md 1. let variables able to accept map and list 2016-12-20 18:53:01 +08:00
release.py add release script 2016-02-25 17:22:37 +08:00
requirements.txt python-terraform-1 Make option with bool value/ more sense for the caller 2016-11-24 15:13:43 +08:00
setup.cfg 1. add test cases, try tdd 2016-11-18 15:35:14 +08:00
setup.py fix description 2016-11-20 01:44:35 +08:00
tox.ini python-terraform-1 Make option with bool value/ more sense for the caller 2016-11-24 15:20:35 +08:00
VERSION Bump version: 0.7.8 → 0.8.0 2016-12-20 18:58:03 +08:00

Introduction

python-terraform is a python module provide a wrapper of terraform command line tool. terraform is a tool made by Hashicorp, please refer to https://terraform.io/

Status

Build Status

Installation

pip install python-terraform

Implementation

IMHO, how terraform design boolean options is confusing. Take input=True and -no-color option of apply command for example, they're all boolean value but with different option type. This make api caller don't have a general rule to follow but to do a exhaustive method implementation which I don't prefer to. Therefore I end-up with using IsFlagged or IsNotFlagged as value of option like -no-color and True/False value reserved for option like

Usage

For any terraform command

from python_terraform import Terraform
t = Terraform()
return_code, stdout, stderr = t.<cmd_name>(*arguments, **options)

For any options

if there's a dash in the option name, use under line instead of dash,
    ex. -no-color --> no_color
if it's a simple flag with no value, value should be IsFlagged
    ex. cmd('taint', allow_missing=IsFlagged)
if it's a boolean value flag like "-refresh=true", assign True or False
if it's a flag could be used multiple times, assign list to it's value
if it's a "var" variable flag, assign dictionary to it
if a value is None, will skip this option

Examples

Have a test.tf file under folder "/home/test"

1. apply with variables a=b, c=d, refresh=false, no color in the output

In shell:

cd /home/test
terraform apply -var='a=b' -var='c=d' -refresh=false -no-color

In python-terraform:

from python_terraform import Terraform
tf = Terraform(working_dir='/home/test')
tf.apply(no_color=IsFlagged, refresh=False, var={'a':'b', 'c':'d'})

or

from python_terraform import Terraform
tf = Terraform()
tf.apply('/home/test', no_color=IsFlagged, refresh=False, var={'a':'b', 'c':'d'})

2. fmt command, diff=true

In shell:

cd /home/test
terraform fmt -diff=true 

In python-terraform:

from python_terraform import Terraform
tf = terraform(working_dir='/home/test')
tf.fmt(diff=True)