Add black and updated docs

.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      files: .
+

CONTRIBUTING.md

@@ -1,13 +1,24 @@
 # Contributing
 
+## Branch workflow
+
+READ BEFORE CREATE A BRANCH OR OPEN A PR/MR
+- We use [Github Glow](https://guides.github.com/introduction/flow/)
+
+## Commit Message Guidelines
+
+- The messages of the commits use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- See [Angular guideline](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)
+
+
 ## Installation
 
 After cloning this repo, create a [virtualenv](https://virtualenv.pypa.io/en/stable/) and ensure dependencies are installed by running:
 
 ```sh
 virtualenv venv
 source venv/bin/activate
-pip install -e requirements-dev.txt
+pip install -r requirements-dev.txt
 ```
 
 Well-written tests and maintaining good test coverage is important to this project. While developing, run new and existing tests with:
@@ -80,6 +91,16 @@ pipenv install --deploy
 pipenv shell
 ```
 
+
+## Black
+The code is formatted using [Black](https://github.com/psf/black).
+
+### pre-commit
+To activate *black* before each commit, run `pre-commit install`.  
+If any file is formatted before commit, you will need to add it again.
+
+
+
 ## Documentation
 
 This project use sphinx

Pipfile

@@ -21,6 +21,8 @@ flake8 = "*"
 tox = "*"
 bandit = "*"
 safety = "*"
+pre-commit = ">=2.7.1"
+black = ">=20.8b1"
 
-[requires]
-python_version = "3.6"
+[pipenv]
+allow_prereleases = true

pyproject.toml

@@ -0,0 +1,16 @@
+[tool.black]
+line-length = 120
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''

requirements-dev.txt

@@ -4,3 +4,5 @@ coverage==5.3
 pylint==2.6.0
 pytest-cov==2.10.1
 pylint==2.6.0
+pre-commit==2.7.1
+black==20.8b1

requirements.txt

@@ -3,4 +3,4 @@ SQLAlchemy==1.3.19
 Flask-Script==2.0.6
 py-ms[all]==2.6.1
 marshmallow==3.8.0
-marshmallow-sqlalchemy==0.23.1
+marshmallow-sqlalchemy==0.23.1

setup.cfg

@@ -2,4 +2,4 @@
 test=pytest
 
 [tool:pytest]
-addopts = --cov=project --cov=tests tests/
+addopts = --cov=project --cov=tests tests/

setup.py

@@ -5,14 +5,14 @@
 
 from setuptools import setup, find_packages
 
-version = __import__('project').__version__
-author = __import__('project').__author__
-author_email = __import__('project').__email__
+version = __import__("project").__version__
+author = __import__("project").__author__
+author_email = __import__("project").__email__
 
-if os.path.exists('README.rst'):
-    long_description = codecs.open('README.rst', 'r', 'utf-8').read()
+if os.path.exists("README.rst"):
+    long_description = codecs.open("README.rst", "r", "utf-8").read()
 else:
-    long_description = 'https://github.com/python-microservices/microservices-scaffold'
+    long_description = "https://github.com/python-microservices/microservices-scaffold"
 
 setup(
     name="MS-Scaffold",
@@ -31,17 +31,27 @@
         "Operating System :: OS Independent",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3.5",
-        "Programming Language :: Python :: 3.6"
+        "Programming Language :: Python :: 3.6",
     ],
-    python_requires='>=3.5',
+    python_requires=">=3.5",
     license="GPLv3",
     platforms=["any"],
     keywords="python, microservices",
-    url='https://github.com/python-microservices/microservices-scaffold',
+    url="https://github.com/python-microservices/microservices-scaffold",
     packages=find_packages(
-        exclude=['*.tests', '*.tests.*', 'tests.*', 'tests', '*.examples', '*.examples.*', 'examples.*', 'examples']),
+        exclude=[
+            "*.tests",
+            "*.tests.*",
+            "tests.*",
+            "tests",
+            "*.examples",
+            "*.examples.*",
+            "examples.*",
+            "examples",
+        ]
+    ),
     setup_requires=[
-        'pytest-runner>=2.0,<3dev',
+        "pytest-runner>=2.0,<3dev",
     ],
     include_package_data=True,
-)
+)