1. refactor setup.py

2. add doc

README.md

@@ -0,0 +1,6 @@
+## 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/
+
+## This project is not stable yet

setup.py

@@ -11,11 +11,11 @@ module_name = 'terraform'
 setup(
     name=module_name,
     version="0.0.1",
-    url='https://github.com/beelit94/tsplk',
+    url='https://github.com/beelit94/python-terraform',
     license='BSD',
     author='Freddy Tan',
     author_email='ftan@splunk.com',
-    description='My Tool does one thing, and one thing well.',
+    description='This is a python module provide a wrapper of terraform command line tool',
     long_description=__doc__,
     packages=[module_name],
     include_package_data=True,
@@ -23,11 +23,6 @@ setup(
     zip_safe=False,
     platforms='any',
     install_requires=dependencies,
-    entry_points={
-        # 'console_scripts': [
-        #     'tsplk = %s.cli:main' % module_name,
-        # ],
-    },
     classifiers=[
         # As from http://pypi.python.org/pypi?%3Aaction=list_classifiers
         # 'Development Status :: 1 - Planning',

terraform/__init__.py

@@ -15,6 +15,9 @@ class Terraform:
         self.parallelism = 50
 
     def apply(self, targets=None, variables=None):
+        """
+        refer to https://terraform.io/docs/commands/apply.html
+        """
         variables = self.variables if variables is None else variables
         targets = self.targets if targets is None else targets