Put some pre-commit checks in place

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+---
+minimum_pre_commit_version: 2.4.0
+repos:
+  # ----- Formatting ---------------------------------------------------------------------------->
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.0.1
+    hooks:
+      - id: trailing-whitespace   # Trims trailing whitespace.
+        args: [--markdown-linebreak-ext=md]
+      - id: mixed-line-ending     # Replaces or checks mixed line ending.
+        args: [--fix=lf]
+      - id: end-of-file-fixer     # Makes sure files end in a newline and only a newline.
+      - id: check-merge-conflict  # Check for files that contain merge conflict strings.
+      - id: check-ast             # Simply check whether files parse as valid python.
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.23.3
+    hooks:
+      - id: pyupgrade
+        name: Rewrite Code to be Py3.7+
+        args: [
+          --py37-plus
+        ]
+
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.6.0
+    hooks:
+      - id: reorder-python-imports
+        args: [
+          --py37-plus,
+        ]
+
+  - repo: https://github.com/psf/black
+    rev: 21.7b0
+    hooks:
+      - id: black
+        args: [-l 100, -S]
+
+  - repo: https://github.com/asottile/blacken-docs
+    rev: v1.10.0
+    hooks:
+      - id: blacken-docs
+        args: [--skip-errors]
+        files: ^docs/.*\.md$
+        additional_dependencies: [black==21.7b0]
+  # <---- Formatting -----------------------------------------------------------------------------
+
+  # ----- Security ------------------------------------------------------------------------------>
+  - repo: https://github.com/PyCQA/bandit
+    rev: "1.7.0"
+    hooks:
+      - id: bandit
+        name: Run bandit against the code base
+        args: [--silent, -lll]
+  # <---- Security -------------------------------------------------------------------------------

README.md

@@ -2,7 +2,7 @@
 
 The Amazon Elastic Kubernetes Service (EKS) Creation Engine (ECE) is a Python command-line program created by the Lightspin Office of the CISO to facilitate the creation and enablement of secure EKS Clusters, optionally further assured with continual Kubernetes Security Posture Management (KSPM), Runtime Protection, and Application Performance Monitoring (APM) capabilities.
 
-## What is this :eyes: :eyes: ?? 
+## What is this :eyes: :eyes: ??
 
 As stated above, the ECE is a Python utility to create a fully functioning EKS Cluster, complete with Nodegroups which are built off of EC2 Launch Templates as it was meant for creating EKS Nodegroups with custom AMIs with custom bootstrapping.
 
@@ -73,10 +73,39 @@ We are happy to take contributions from anywhere that will help expand this proj
 - Spot provider & Fargate Profile support for Nodegroups, and an option to not use Nodegroups
 - Create more Plugins for various utilities (e.g., Calico, OPA, NGINX Ingress Controller, etc.)
 
+### Basic Contributing Setup
+
+1. Fork the repository.
+2. Clone your fork and enter the `eks-creation-engine` directory.
+3. Get your Python things Python-y.
+
+```bash
+# Add upstream
+git remote add upstream https://github.com/lightspin-tech/eks-creation-engine.git
+
+# Create virtual env
+pip3 -m venv .env --prompt ece
+
+# Enter virtual env
+source .env/bin/activate
+
+# Install ECE reqs
+pip3 install -r requirements.txt
+
+# Install pre-commit
+pip3 install pre-commit
+
+# Ensure pre-commit runs... pre... commit
+pre-commit install
+
+# Init the pre-commit env and run checks
+pre-commit run -a
+```
+
 ## Contact Us :telephone_receiver: :telephone_receiver:
 
 For more information, contact us at support@lightspin.io.
 
 ## License :eight_spoked_asterisk: :eight_spoked_asterisk:
 
-This repository is available under the [Apache License 2.0](https://github.com/lightspin-tech/eks-creation-engine/blob/main/LICENSE).
+This repository is available under the [Apache License 2.0](https://github.com/lightspin-tech/eks-creation-engine/blob/main/LICENSE).

docs/HOWTO.md

@@ -347,4 +347,4 @@ For more information, contact us at support@lightspin.io.
 
 ## License :eight_spoked_asterisk: :eight_spoked_asterisk:
 
-This repository is available under the [Apache License 2.0](https://github.com/lightspin-tech/eks-creation-engine/blob/main/LICENSE).
+This repository is available under the [Apache License 2.0](https://github.com/lightspin-tech/eks-creation-engine/blob/main/LICENSE).