feat: Run flake8 via pre-commit

- Document pre-commit usage and per-user configuration
- Correct a missing space in the contributing docs
- Replace mention of yapf as formatter with Black
- Check two previously not included files

Author: l0b0

.pre-commit-config.yaml

@@ -10,3 +10,10 @@ repos:
         language: system
         stages: [commit]
         types: [python]
+
+      - id: flake8
+        name: flake8
+        entry: flake8
+        language: system
+        stages: [commit]
+        types: [python]

README.md

@@ -77,21 +77,19 @@ To run linters, code formatters, and test suites all together, use `test`:
 
 ### Code quality checks
 
-PySTAC uses [flake8](http://flake8.pycqa.org/en/latest/) and [yapf](https://github.com/google/yapf) for code formatting and style checks.
-
-To run the flake8 style checks:
+PySTAC uses [flake8](http://flake8.pycqa.org/en/latest/) and [Black](https://github.com/psf/black) for code formatting and style checks. To run both:
 
 ```
-> flake8 pystac tests
+> pre-commit run --all-files
 ```
 
-To format code:
+To run these automatically when committing files (runs only on the staged files):
 
 ```
-> yapf -ipr pystac tests
+> pre-commit install --hook-type=pre-commit --overwrite
 ```
 
-Note that you may have to use `yapf3` explicitly depending on your environment.
+To avoid running these checks when committing, use `git commit --no-verify`.
 
 To check for spelling mistakes in modified files:
 

docs/conf.py

@@ -19,7 +19,7 @@
 
 sys.path.insert(0, os.path.abspath("."))
 sys.path.insert(0, os.path.abspath("../"))
-from pystac.version import __version__, STACVersion
+from pystac.version import __version__, STACVersion  # noqa:E402
 
 git_branch = (
     subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])

docs/contributing.rst

@@ -45,16 +45,10 @@ More details on using ``unittest`` are `here
 Code quality checks
 ^^^^^^^^^^^^^^^^^^^
 
-PySTAC uses `flake8 <http://flake8.pycqa.org/en/latest/>`_ and`black
+PySTAC uses `flake8 <http://flake8.pycqa.org/en/latest/>`_ and `black
 <https://github.com/psf/black>`_ for code formatting and style checks.
 
-To run the flake8 style checks:
-
-.. code-block:: bash
-
-    > flake8 pystac tests
-
-To format code:
+To run both:
 
 .. code-block:: bash
 

scripts/lint

@@ -9,13 +9,7 @@ echo
 mypy docs pystac setup.py tests
 
 echo
-echo " -- LINTING WITH FLAKE8 --"
-echo
-
-flake8 pystac setup.py tests
-
-echo
-echo " -- CHECKING FORMAT WITH BLACK --"
+echo " -- CHECKING WITH BLACK AND FLAKE8 --"
 echo
 
 pre-commit run --all-files