Merge pull request #3 from pritam001/feature-lint

Feature lint and pre-commit

Author: pritam001

.bandit.yml

@@ -0,0 +1,5 @@
+[bandit]
+    targets: src,test,*.py
+    exclude: dummy.py
+    skips:
+    tests:

.gitignore

@@ -138,3 +138,5 @@ DS_Store
 # logs
 logs/
 
+# mypy
+.mypy_cache/

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+      - id: black
+        language_version: python3.8
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8

Makefile

@@ -0,0 +1,91 @@
+CONDA_ENV_NAME=pyflask-base
+APP_NAME=pyflask-service
+APP_DIR=src
+TEST_DIR=test
+HOME_DIR_PY_FILES=*.py
+
+# echo _FormatCode_ guide:
+# 	0 	Reset all styles
+# 	1	Bold
+#	32 	Green
+#	34 	Blue
+#	35 	Magenta
+#	36	Cyan
+RESET_STYLES=\033[0m
+BOLD_BLUE=\033[1m\033[34m
+BOLD_CYAN=\033[1m\033[36m
+
+# Signifies our desired python version
+# Makefile macros (or variables) are defined a little bit differently than traditional bash, keep in mind that in the Makefile there's top-level Makefile-only syntax, and everything else is bash script syntax.
+PYTHON = python3
+
+# .PHONY defines parts of the makefile that are not dependant on any specific file
+# This is most often used to store functions
+.PHONY = help setup format lint test debug clean
+
+# Defining an array variable
+FILES = input output
+
+# Defines the default target that `make` will to try to make, or in the case of a phony target, execute the specified commands
+# This target is executed whenever we just type `make`
+.DEFAULT_GOAL = help
+
+
+# The @ makes sure that the command itself isn't echoed in the terminal
+help:
+	@echo "$(BOLD_BLUE)-----------------------------MAKE GUIDE----------------------------$(RESET_STYLES)"
+	@echo "$(BOLD_CYAN)make setup$(RESET_STYLES) : Setup pyflask-service"
+	@echo "$(BOLD_CYAN)make format$(RESET_STYLES) : Format and fix python code pyflask-service"
+	@echo "$(BOLD_CYAN)make lint$(RESET_STYLES) : Lint pyflask-service"
+	@echo "$(BOLD_CYAN)make test$(RESET_STYLES) : Test pyflask-service"
+	@echo "$(BOLD_CYAN)make debug$(RESET_STYLES) : Debug pyflask-service"
+	@echo "$(BOLD_CYAN)make clean$(RESET_STYLES) : Clean pyflask-service"
+	@echo "$(BOLD_CYAN)make dev-run$(RESET_STYLES) : Run pyflask-service in environment=development"
+	@echo "$(BOLD_CYAN)make prod-run$(RESET_STYLES) : Run pyflask-service in environment=prod"
+	@echo "$(BOLD_BLUE)-------------------------------------------------------------------$(RESET_STYLES)"
+
+
+setup: #: Use pip-tools, pip-compile, pip install
+	@echo "$(BOLD_CYAN)Setting up pyflask base$(RESET_STYLES)"
+	# Check for venv, conda else exit
+	@echo "$(BOLD_CYAN)Installing pip-tools . . .$(RESET_STYLES)"
+	pip install pip-tools
+	@echo "$(BOLD_CYAN)Generating requirements$(RESET_STYLES)"
+	pip-compile -q --build-isolation --output-file=requirements/requirements.txt requirements/requirements.in
+	@echo "$(BOLD_CYAN)Generating dev requirements$(RESET_STYLES)"
+	pip-compile -q --build-isolation --output-file=requirements/dev-requirements.txt requirements/dev-requirements.in
+	@echo "$(BOLD_CYAN)Syncing requirements$(RESET_STYLES)"
+	pip-sync -q requirements/requirements.txt requirements/dev-requirements.txt
+	@echo "$(BOLD_CYAN)Installing requirements$(RESET_STYLES)"
+	pip install -r requirements/requirements.txt
+	@echo "$(BOLD_CYAN)Installing dev requirements$(RESET_STYLES)"
+	pip install -r requirements/dev-requirements.txt
+	@echo "$(BOLD_CYAN)Adding pre-commit hooks$(RESET_STYLES)"
+	pre-commit install
+
+
+format: #: Format and fix python code with black, isort, autoflake
+	@echo "$(BOLD_CYAN)Blackifying $(RESET_STYLES)🍳"
+	black --version
+	black $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
+	@echo "$(BOLD_CYAN)ISorting 〽️$(RESET_STYLES)️"
+	isort --recursive $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
+	@echo "$(BOLD_CYAN)Flaking️❄️$(RESET_STYLES)"
+	flake8 --version
+	autoflake --remove-all-unused-imports --remove-unused-variables --remove-duplicate-keys --ignore-init-module-imports -i -r $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
+
+
+lint: #: Run static analysis with flake8, mypy and bandit
+	@echo "$(BOLD_CYAN)Flake linting ❄️$(RESET_STYLES)"
+	flake8 --version
+	flake8 $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
+	@echo "$(BOLD_CYAN)Static typing️️$(RESET_STYLES)⌨️"
+	mypy --version
+	mypy $(APP_DIR) $(HOME_DIR_PY_FILES)
+	@echo "$(BOLD_CYAN)Securing with bandit️🕵️️$(RESET_STYLES)"
+	bandit --version
+	bandit -l -i -r . --format=custom
+	@echo "$(BOLD_CYAN)Running pre-commit hooks 🏁️️️$(RESET_STYLES)"
+	pre-commit run --all-files
+	@echo "$(BOLD_CYAN)All checks passed 🏳️️️️$(RESET_STYLES)"
+

README.md

@@ -5,15 +5,42 @@ An "optionally opinionated and structured" flask boilerplate microservice for id
 ![Built with](https://img.shields.io/badge/-Built%20with-073551?style=flat-square)
 ![Python](https://img.shields.io/badge/-Python-3776AB?style=flat-square&logo=Python&logoColor=white)
 ![Flask](https://img.shields.io/badge/-Flask-000000?style=flat-square&logo=flask&logoColor=white)
+![License](https://img.shields.io/github/license/pritam001/pyflask-microservice-base?style=flat-square&label=License)
 
-Minimum supporting Python version: 3.6
+Tools
+------------------------------------------------------------------------------
+[![Min Python Version 3.6+](https://img.shields.io/badge/python-3.6+-3776AB.svg)](https://www.python.org/download/releases/3.6.0/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Static Analysis: flake8](https://img.shields.io/badge/static%20analysis-flake8-white.svg)](https://www.python.org/dev/peps/pep-0008/)
+[![Static Typing: mypy](https://img.shields.io/badge/static%20typing-mypy-blue.svg)](https://www.python.org/dev/peps/pep-0008/)
+[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
 
+Development Status
+------------------------------------------------------------------------------
 ![WIP](https://img.shields.io/badge/%20%F0%9F%9A%A7%20-Work%20in%20progress-important)
 
 Usage Guide
 ------------------------------------------------------------------------------
 This is a template project hosted on GitHub which can be used to create new repositories.
 
-[GitHub Guide: Creating a repository from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
+Steps for creating boilerplate project in GitHub
+------------------------------------------------------------------------------
+0. Create a new repository named "my-pyflask-project" using this template repository *
+0. `git clone https://www.github.com/username/my-pyflask-project.git`
+0. `cd my-pyflask-project`
+0. Create and activate conda environment `conda activate my-conda-venv` **
+0. `make setup` : Use pip-tools, pip-compile, pip install to setup python packages
+
+\* [GitHub Guide: Creating a repository from a template](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template)
+<br>
+\** [Guide to Conda environment](https://github.com/pritam001/pyflask-microservice-base/blob/master/documentation/conda.md)
+
+
+
+Linting Guide
+------------------------------------------------------------------------------
+`make format` : Format and fix python code with black, isort, autoflake
 
+`make lint` : Run static analysis with flake8, mypy and bandit
 

base_constructor.sh

@@ -1,6 +1,7 @@
 # Conda documentation
 
 ### 1. Install Pip
+https://www.shellhacks.com/python-install-pip-mac-ubuntu-centos/
 ### 2. Install Anaconda
 ##### Linux
 `wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh`