Introduce Black coding style (#96)

Author: xen0l

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+-   repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    - id: check-ast
+    - id: flake8
+    - id: check-merge-conflict
+    - id: debug-statements
+    - id: requirements-txt-fixer
+-   repo: https://github.com/Lucas-C/pre-commit-hooks-bandit
+    rev: v1.0.4
+    hooks:
+    -   id: python-bandit-vulnerability-check

.pylintrc

@@ -144,7 +144,8 @@ disable=print-statement,
         invalid-name,
         no-member,
         arguments-differ,
-        ungrouped-imports
+        ungrouped-imports,
+        bad-continuation
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.travis.yml

@@ -16,7 +16,7 @@ install:
 before_script:
   - pytest --version
 script:
-  - ./test/run.py
+  - ./tests/run.py
 after_success:
   - codecov
 deploy:

CHANGELOG.md

@@ -2,6 +2,8 @@
 ------------------
 
 * Add support for Linux in **bootstrap**
+* Black coding style is now used
+* pre-commit hooks are available for easier development
 
 0.5.0 (2019-10-04)
 ------------------

README.md

@@ -1,5 +1,5 @@
 # aws-gate
-[![Build Status](https://travis-ci.org/xen0l/aws-gate.svg?branch=master)](https://travis-ci.org/xen0l/aws-gate)[![codecov](https://codecov.io/gh/xen0l/aws-gate/branch/master/graph/badge.svg)](https://codecov.io/gh/xen0l/aws-gate)[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5f4385e925e34788a20e40b4a3319b2d)](https://app.codacy.com/app/xen0l/aws-gate?utm_source=github.com&utm_medium=referral&utm_content=xen0l/aws-gate&utm_campaign=Badge_Grade_Settings)[![PyPI version](https://badge.fury.io/py/aws-gate.svg)](https://badge.fury.io/py/aws-gate)
+[![Build Status](https://travis-ci.org/xen0l/aws-gate.svg?branch=master)](https://travis-ci.org/xen0l/aws-gate)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)[![codecov](https://codecov.io/gh/xen0l/aws-gate/branch/master/graph/badge.svg)](https://codecov.io/gh/xen0l/aws-gate)[![Codacy Badge](https://api.codacy.com/project/badge/Grade/5f4385e925e34788a20e40b4a3319b2d)](https://app.codacy.com/app/xen0l/aws-gate?utm_source=github.com&utm_medium=referral&utm_content=xen0l/aws-gate&utm_campaign=Badge_Grade_Settings)[![PyPI version](https://badge.fury.io/py/aws-gate.svg)](https://badge.fury.io/py/aws-gate)
 
 AWS SSM Session manager client
 

aws_gate/__init__.py

@@ -1,5 +1,5 @@
-__version__ = '0.5.0'
-__description__ = 'aws-gate - AWS SSM Session Manager client CLI'
-__author__ = 'Adam Stevko'
-__author_email__ = '[email protected]'
-__url__ = 'https://github.com/xen0l/aws-gate'
+__version__ = "0.5.0"
+__description__ = "aws-gate - AWS SSM Session Manager client CLI"
+__author__ = "Adam Stevko"
+__author_email__ = "[email protected]"
+__url__ = "https://github.com/xen0l/aws-gate"

aws_gate/bootstrap.py

@@ -9,15 +9,20 @@
 import requests
 import unix_ar
 
-from aws_gate.constants import DEFAULT_GATE_BIN_PATH, PLUGIN_INSTALL_PATH, PLUGIN_NAME, SSM_PLUGIN_PATH
+from aws_gate.constants import (
+    DEFAULT_GATE_BIN_PATH,
+    PLUGIN_INSTALL_PATH,
+    PLUGIN_NAME,
+    SSM_PLUGIN_PATH,
+)
 from aws_gate.exceptions import UnsupportedPlatormError
 from aws_gate.utils import execute
 
 logger = logging.getLogger(__name__)
 
 
 def _check_plugin_version(path=PLUGIN_INSTALL_PATH):
-    return execute(path, ['--version'], capture_output=True)
+    return execute(path, ["--version"], capture_output=True)
 
 
 class Plugin:
@@ -26,7 +31,7 @@ class Plugin:
 
     @property
     def is_installed(self):
-        logger.debug('Checking if %s exists and is executable', PLUGIN_INSTALL_PATH)
+        logger.debug("Checking if %s exists and is executable", PLUGIN_INSTALL_PATH)
         return shutil.which(PLUGIN_INSTALL_PATH) is None
 
     def download(self):
@@ -35,71 +40,81 @@ def download(self):
 
         self.download_path = os.path.join(tmp_dir, file_name)
         try:
-            logger.debug('Downloading session-manager-plugin archive from %s', self.url)
+            logger.debug("Downloading session-manager-plugin archive from %s", self.url)
             with requests.get(self.url, stream=True) as req:
                 req.raise_for_status()
-                with open(self.download_path, 'wb') as f:
+                with open(self.download_path, "wb") as f:
                     shutil.copyfileobj(req.raw, f)
-                    logger.debug('Download stored at %s', self.download_path)
+                    logger.debug("Download stored at %s", self.download_path)
         except requests.exceptions.HTTPError as e:
-            logger.error('HTTP error while downloading %s: %s', self.url, e)
+            logger.error("HTTP error while downloading %s: %s", self.url, e)
 
     def install(self):
         download_dir = os.path.split(self.download_path)[0]
-        plugin_src_path = os.path.join(download_dir, SSM_PLUGIN_PATH[platform.system()]['bundle'])
+        plugin_src_path = os.path.join(
+            download_dir, SSM_PLUGIN_PATH[platform.system()]["bundle"]
+        )
         plugin_dst_path = PLUGIN_INSTALL_PATH
 
         if not os.path.exists(DEFAULT_GATE_BIN_PATH):
-            logger.debug('Creating %s', DEFAULT_GATE_BIN_PATH)
+            logger.debug("Creating %s", DEFAULT_GATE_BIN_PATH)
             os.makedirs(DEFAULT_GATE_BIN_PATH)
 
-        with open(plugin_src_path, 'rb') as f_src, open(plugin_dst_path, 'wb') as f_dst:
-            logger.debug('Copying %s to %s', plugin_src_path, plugin_dst_path)
+        with open(plugin_src_path, "rb") as f_src, open(plugin_dst_path, "wb") as f_dst:
+            logger.debug("Copying %s to %s", plugin_src_path, plugin_dst_path)
             shutil.copyfileobj(f_src, f_dst)
 
-        logger.debug('Setting execution permissions on %s', plugin_dst_path)
+        logger.debug("Setting execution permissions on %s", plugin_dst_path)
         os.chmod(plugin_dst_path, 0o755)
 
         version = _check_plugin_version(PLUGIN_INSTALL_PATH)
-        print('{} (version {}) installed successfully!'.format(PLUGIN_NAME, version))
+        print("{} (version {}) installed successfully!".format(PLUGIN_NAME, version))
 
     def extract(self):
         raise NotImplementedError
 
 
 class MacPlugin(Plugin):
-    url = SSM_PLUGIN_PATH['Darwin']['download']
+    url = SSM_PLUGIN_PATH["Darwin"]["download"]
 
     def extract(self):
         if not zipfile.is_zipfile(self.download_path):
-            raise ValueError('Invalid macOS session-manager-plugin ZIP file found {}'.format(self.download_path))
+            raise ValueError(
+                "Invalid macOS session-manager-plugin ZIP file found {}".format(
+                    self.download_path
+                )
+            )
 
-        with zipfile.ZipFile(self.download_path, 'r') as zip_file:
+        with zipfile.ZipFile(self.download_path, "r") as zip_file:
             download_dir = os.path.split(self.download_path)[0]
-            logger.debug('Extracting session-manager-plugin archive at %s', download_dir)
+            logger.debug(
+                "Extracting session-manager-plugin archive at %s", download_dir
+            )
             zip_file.extractall(download_dir)
 
 
 class LinuxPlugin(Plugin):
-    url = SSM_PLUGIN_PATH['Linux']['download']
+    url = SSM_PLUGIN_PATH["Linux"]["download"]
 
     def extract(self):
         ar_file = unix_ar.open(self.download_path)
-        tarball = ar_file.open('data.tar.gz/')
+        tarball = ar_file.open("data.tar.gz/")
         tar_file = tarfile.open(fileobj=tarball)
         download_dir = os.path.split(self.download_path)[0]
-        logger.debug('Extracting session-manager-plugin archive at %s', download_dir)
+        logger.debug("Extracting session-manager-plugin archive at %s", download_dir)
         tar_file.extractall(download_dir)
 
 
 def bootstrap(force=False):
     system = platform.system()
-    if system == 'Darwin':
+    if system == "Darwin":
         plugin = MacPlugin()
-    elif system == 'Linux':
+    elif system == "Linux":
         plugin = LinuxPlugin()
     else:
-        raise UnsupportedPlatormError('Unable to bootstrap session-manager-plugin on {}'.format(system))
+        raise UnsupportedPlatormError(
+            "Unable to bootstrap session-manager-plugin on {}".format(system)
+        )
 
     if plugin.is_installed or force:
         plugin.download()