Update documentation and makefile

Author: pritam001

.bandit renamed to .bandit.yml

@@ -21,7 +21,7 @@ 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 lint test debug clean
+.PHONY = help setup format lint test debug clean
 
 # Defining an array variable
 FILES = input output
@@ -30,10 +30,12 @@ FILES = input output
 # 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"
@@ -43,13 +45,39 @@ help:
 	@echo "$(BOLD_BLUE)-------------------------------------------------------------------$(RESET_STYLES)"
 
 
-lint: #: Run static analysis with black, flake8, pylint, bandit and mypy
+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
+
+
+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, bandit and mypy
+	@echo "$(BOLD_CYAN)Flake linting ❄️$(RESET_STYLES)"
+	flake8 --version
 	flake8 $(APP_DIR) $(TEST_DIR) $(HOME_DIR_PY_FILES)
-	@echo "$(BOLD_CYAN)Securing️🕵️️$(RESET_STYLES)"
+	@echo "$(BOLD_CYAN)Securing with bandit️🕵️️$(RESET_STYLES)"
+	bandit --version
 	bandit -l -i -r . --format=custom
 

Makefile

@@ -5,9 +5,17 @@ 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)
+[![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.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)
 
+Development Status
+------------------------------------------------------------------------------
 ![WIP](https://img.shields.io/badge/%20%F0%9F%9A%A7%20-Work%20in%20progress-important)
 
 Usage Guide
@@ -20,9 +28,16 @@ Steps for creating boilerplate project in GitHub
 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. `sh base_constructor.sh`
+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, bandit and mypy