chore: add linting and formatting

Author: Chris

.pre-commit-config.yaml

@@ -1,10 +1,4 @@
 repos:
-# -   repo: https://github.com/pre-commit/pre-commit-hooks
-#     rev: v4.3.0
-#     hooks:
-#     -   id: check-yaml
-#     -   id: end-of-file-fixer
-#     -   id: trailing-whitespace
 -   repo: https://github.com/psf/black
     rev: 22.8.0
     hooks:
@@ -18,5 +12,6 @@ repos:
       types: [python]
       args:
         [
+          "-rn", # Only display messages
           "--rcfile=.pylintrc", # Link to your config file
         ]

README.md

@@ -0,0 +1,31 @@
+# Python Lint Example
+
+The example project installs `pre-commit`, `black` and `pylint` to demonstrate how to apply formatting and linting to a `git` commit.
+
+## Pre-requisites
+
+Run ` $ pip install -r requirements.txt`
+
+## pre-commit
+
+Runs hooks on every commit to automatically point out issues in code.
+
+Run ` $ pre-commit install` to setup the git hook scripts
+
+https://pre-commit.com/
+
+## black
+
+Black is the uncompromising Python code formatter.
+
+Run `black *.py`
+
+https://pypi.org/project/black/
+
+## pylint
+
+Pylint is a static code analyser for Python.
+
+Run `pylint *.py`
+
+https://pypi.org/project/pylint/

requirements.txt

@@ -1,4 +1,4 @@
 requests
-pre-commit
-pylint
+pre - commit
 black
+pylint