Add pre-commit & flake8 config files; run pre-commit hooks on GA (#298)

* Add pre-commit & flake8 congif files * Add pre-commit hook run to GA workflow * Rename GA workflows * Exclude doc/conf.py from pre-commit linter * Apply black formatting to doc/conf.py * Only exclude doc/conf.py from flake8 check * Only exclude doc/conf.py from flake8 check * Format doc/conf.py * Configure pep8speaks to not comment on line length up to 90 chars long

Author: acrellin

.flake8

@@ -0,0 +1,16 @@
+# See:
+#
+# https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes (E, W)
+# https://flake8.pycqa.org/en/latest/user/error-codes.html (F)
+# https://github.com/PyCQA/flake8-bugbear
+#
+# for error codes. And
+#
+# https://flake8.pycqa.org/en/latest/user/violations.html#selecting-violations-with-flake8
+#
+# for error classes selected below.
+
+[flake8]
+max-line-length = 80
+select = C,E,F,W,B,B950
+ignore = E501, W503, E203

.github/workflows/docs_build.yml

@@ -1,4 +1,4 @@
-name: Build cesium docs
+name: Build docs
 
 on:
  push:

.github/workflows/tests.yml

@@ -1,4 +1,4 @@
-name: Run cesium test suite
+name: Test Cesium
 
 on:
  push:
@@ -41,6 +41,12 @@ jobs:
 
  which python; python --version
 
+ - name: Formatting and linting checks
+ if: github.ref != 'refs/heads/master'
+ run: |
+ pip install pre-commit
+ pre-commit run --from-ref ${{ github.event.pull_request.base.sha }} --to-ref ${{ github.event.pull_request.head.sha }}
+
  - name: Run test suite
  run: |
  if [[ -n $COVERAGE ]]; then

.pep8speaks.yml

@@ -2,10 +2,9 @@ scanner:
  diff_only: True # Errors caused by only the patch are shown, not the whole file
 
 pycodestyle:
- max-line-length: 80 # Default is 79 in PEP8
+ max-line-length: 90 # Default is 79 in PEP8
  ignore: # Errors and warnings to ignore
  - W391
  - E203
 
 no_blank_comment: True # If True, no comment is made when the bot does not find any pep8 errors
-

.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+repos:
+ - repo: https://github.com/pre-commit/pre-commit-hooks
+ rev: v2.5.0
+ hooks:
+ - id: check-yaml
+ - id: end-of-file-fixer
+ - id: trailing-whitespace
+ - repo: https://github.com/python/black
+ rev: 20.8b1
+ hooks:
+ - id: black
+ pass_filenames: true
+ - repo: https://gitlab.com/pycqa/flake8
+ rev: 3.8.4
+ hooks:
+ - id: flake8
+ pass_filenames: true
+ exclude: doc/conf.py