Remove flake8 validation and add black instead

Add a `checks` job in workflow to do a preliminary checks

Author: Sergey Vilgelm

.github/workflows/test.yml

@@ -9,7 +9,31 @@ on:
   schedule:
     - cron: "0 1 * * *"
 jobs:
-  test:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.8
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ".[dev]"
+      - name: Format with black
+        run: |
+          if ! RES=$(black --check $(git diff --name-only --diff-filter=AM master -- "*.py") 2>&1); then
+            RES="${RES//'%'/'%25'}"
+            RES="${RES//$'\n'/'%0A'}"
+            RES="${RES//$'\r'/'%0D'}"
+            echo "::error ::${RES}"
+            exit 1
+          fi
+          echo ${RES}
+  unit-tests:
+    needs: checks
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -24,7 +48,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install ".[dev]"
+          pip install ".[test]"
       - name: Test with inv
         run: inv cover qa
       - name: Coveralls
@@ -35,7 +59,7 @@ jobs:
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
   bench:
-    needs: test
+    needs: unit-tests
     runs-on: ubuntu-latest
     if: github.event_name == 'pull_request'
     steps:

CONTRIBUTING.rst

@@ -41,7 +41,7 @@ There are some rules to follow:
 
 - your contribution should be documented (if needed)
 - your contribution should be tested and the test suite should pass successfully
-- your code should be mostly PEP8 compatible with a 120 characters line length
+- your code should be properly formatted (use ``black .`` to format)
 - your contribution should support both Python 2 and 3 (use ``tox`` to test)
 
 You need to install some dependencies to develop on flask-restx:

README.rst

@@ -18,8 +18,11 @@ Flask RESTX
     :target: https://pypi.org/project/flask-restx
     :alt: Supported Python versions
 .. image:: https://badges.gitter.im/Join%20Chat.svg
-   :alt: Join the chat at https://gitter.im/python-restx
-   :target: https://gitter.im/python-restx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+    :target: https://gitter.im/python-restx?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+    :alt: Join the chat at https://gitter.im/python-restx
+.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
+    :target: https://github.com/psf/black
+    :alt: Code style: black
 
 
 Flask-RESTX is a community driven fork of `Flask-RESTPlus <https://github.com/noirbizarre/flask-restplus>`_.

requirements/develop.pip

@@ -1,5 +1,2 @@
-invoke==1.3.0
-flake8==3.7.8
-readme-renderer==24.0
 tox==3.13.2
-twine==1.15.0
+black==19.10b0; python_version >= '3.6'

requirements/test.pip

@@ -10,3 +10,7 @@ pytest-mock==1.10.4
 pytest-profiling==1.7.0
 pytest-sugar==0.9.2
 tzlocal
+
+invoke==1.3.0
+readme-renderer==24.0
+twine==1.15.0

setup.cfg

@@ -1,8 +1,3 @@
-[flake8]
-ignore = E124,E128
-max-line-length = 120
-exclude = doc,.git
-
 [bdist_wheel]
 universal = 1
 

tasks.py

@@ -150,12 +150,6 @@ def qa(ctx):
     '''Run a quality report'''
     header(qa.__doc__)
     with ctx.cd(ROOT):
-        info('Python Static Analysis')
-        flake8_results = ctx.run('flake8 flask_restx tests', pty=True, warn=True)
-        if flake8_results.failed:
-            error('There is some lints to fix')
-        else:
-            success('No linter errors')
         info('Ensure PyPI can render README and CHANGELOG')
         info('Building dist package')
         dist = ctx.run('python setup.py sdist', pty=True, warn=False, hide=True)
@@ -168,8 +162,8 @@ def qa(ctx):
             error('README and/or CHANGELOG is not renderable by PyPI')
         else:
             success('README and CHANGELOG are renderable by PyPI')
-    if flake8_results.failed or readme_results.failed:
-        exit('Quality check failed', flake8_results.return_code or readme_results.return_code)
+    if readme_results.failed:
+        exit('Quality check failed', readme_results.return_code)
     success('Quality check OK')