readme readme readme

Author: nir0s

README.md

@@ -20,35 +20,49 @@ You must have Packer installed prior to using this client (DUH!)
  pip install https://github.com/nir0s/python-packer/archive/master.tar.gz
 ```
 
-## Usage Example
+## Usage Examples
+
+### [Packer.build()](https://www.packer.io/docs/command-line/build.html)
 
 ```python
 import packer
 
 packerfile = 'packer/tests/resources/packerfile.json'
-output_file = 'packer/tests/resources/packerfile_fixed.json'
-atlas_token = 'oi21mok3mwqtk31om51o2joj213m1oo1i23n1o2'
-packer_exec_path = '/usr/bin/packer'
 exc = []
 only = ['my_first_image', 'my_second_image']
 vars = {"variable1": "value1", "variable2": "value2"}
 vars_file = 'path/to/vars/file'
+packer_exec_path = '/usr/bin/packer'
 
 p = packer.Packer(packerfile, exc=exc, only=only, vars=vars,
                   vars_file=vars_file, exec_path=packer_exec_path)
-print(p.version())  # `packer version`
-p.validate(syntax_only=False)  # `packer validates`
-print(p.fix(output_file))  # `packer fix`
-result = p.inspect()  # `packer inspect`
-print(result.parsed_output)
-p.build(parallel=True, debug=False, force=False)  # `packer build`
-# if you're logged into Atlas, you can also:
-p.push(create=True, token=atlas_token)  # `packer push`
+p.build(parallel=True, debug=False, force=False)
 ```
 
-The `inspect` method will return a dictionary containing the components:
+
+### [Packer.fix()](https://www.packer.io/docs/command-line/fix.html)
 
 ```python
+...
+
+output_file = 'packer/tests/resources/packerfile_fixed.json'
+print(p.fix(output_file))
+```
+
+The `output_file` parameter will write the output of the `fix` function to a file.
+
+
+###  [Packer.inspect()](https://www.packer.io/docs/command-line/inspect.html)
+
+If the `mrf` argument is set to `True`, the output will be parsed and returned as a dictionary containing the components:
+
+```python
+...
+
+result = p.inspect(mrf=True)
+print(result.parsed_output)
+
+# output:
 "variables": [
   {
     "name": "aws_access_key",
@@ -72,6 +86,60 @@ The `inspect` method will return a dictionary containing the components:
 ]
 ```
 
+If the `mrf` argument is set to `False`, the output will not be parsed but rather returned as is:
+
+```python
+...
+
+result = p.inspect(mrf=True)
+print(result.stdout)
+
+# output:
+Optional variables and their defaults:
+
+  aws_access_key          = {{env `AWS_ACCESS_KEY_ID`}}
+  aws_secret_key          = {{env `AWS_ACCESS_KEY`}}
+
+Builders:
+
+  amazon                   (amazon-ebs)
+
+Provisioners:
+
+  shell
+
+...
+
+```
+
+
+### [Packer.push()](https://www.packer.io/docs/command-line/push.html)
+
+You must be logged into Atlas to use the `push` function:
+
+```python
+...
+
+atlas_token = 'oi21mok3mwqtk31om51o2joj213m1oo1i23n1o2'
+p.push(create=True, token=atlas_token)
+```
+
+### [Packer.validate()](https://www.packer.io/docs/command-line/validate.html)
+
+```python
+...
+
+p.validate(syntax_only=False)
+```
+
+### Packer.version()
+
+```python
+...
+
+print(p.version())
+```
+
 ## Shell Interaction
 
 The [sh](http://amoffat.github.io/sh/) Python module is used to execute Packer.

packer/__init__.py

@@ -58,7 +58,7 @@ def fix(self, to_file=None):
                 f.write(result.stdout)
         return result
 
-    def inspect(self):
+    def inspect(self, mrf=True):
         """Inspects a Packer Templates file (`packer inspect -machine-readable`)
 
         To return the output in a readable form, the `-machine-readable` flag
@@ -85,12 +85,15 @@ def inspect(self):
               "name": "amazon"
             }
           ]
+        :param bool machine_readable: output in machine-readable form.
         """
-        command = self.packer.inspect
-        command = command.bake('-machine-readable', self.packerfile)
-        result = command()
-        result.parsed_output = self._parse_inspection_output(
-            result.stdout)
+        cmd = self.packer.inspect
+        cmd = self._add_opt(cmd, '-machine-readable' if mrf else None)
+        cmd = cmd.bake(self.packerfile)
+        result = cmd()
+        if mrf:
+            result.parsed_output = self._parse_inspection_output(
+                result.stdout)
         return result
 
     def push(self, create=True, token=False):

tester.py

@@ -10,9 +10,9 @@
 vars_file = '/x'
 
 p = packer.Packer(packerfile, exc=exc, only=only, vars=vars)
-print(p.version())
-print(p.validate(syntax_only=False))
-result = p.inspect()
-print result.parsed_output
-print(p.fix('TEST.json'))
-print(p.build())
+# print(p.version())
+# print(p.validate(syntax_only=False))
+result = p.inspect(mrf=False)
+print result.stdout
+# print(p.fix('TEST.json'))
+# print(p.build())