Fixed #1199 -- Added pre-commit hooks (#1198)

* Added pre-commit with a few hooks

* Add pre-commit instructions in README

Author: Paolo Melchiorre

.pre-commit-config.yaml

@@ -0,0 +1,22 @@
+exclude: \/migrations\/
+default_language_version:
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.3.0"
+    hooks:
+      - id: debug-statements
+      - id: detect-private-key
+      - id: file-contents-sorter
+        files: ^(requirements/\w*.txt)$
+        args: ["--ignore-case", "--unique"]
+      - id: fix-encoding-pragma
+        args: ["--remove"]
+  - repo: https://github.com/pycqa/isort
+    rev: "5.10.1"
+    hooks:
+      - id: isort
+  - repo: https://github.com/pycqa/flake8
+    rev: "5.0.4"
+    hooks:
+      - id: flake8

README.rst

@@ -394,3 +394,27 @@ Running Locally with Docker
 
     docker-compose exec web tox
     docker-compose exec web python -m manage test
+
+Pre-commit checks
+-----------------
+
+`pre-commit <https://pre-commit.com>`_ is a framework for managing pre-commit
+hooks. These hooks help to identify simple issues before committing code for
+review. By checking for these issues before code review it allows the reviewer
+to focus on the change itself, and it can also help to reduce the number CI
+runs.
+
+To use the tool, first install ``pre-commit`` and then the git hooks::
+
+.. console::
+
+    $ python3 -m pip install pre-commit
+    $ python3 -m pre_commit install
+
+On the first commit ``pre-commit`` will install the hooks, these are
+installed in their own environments and will take a short while to
+install on the first run. Subsequent checks will be significantly faster.
+If the an error is found an appropriate error message will be displayed.
+If the error was with ``isort`` then the tool will go ahead and fix them for
+you. Review the changes and re-stage for commit if you are happy with
+them.

foundation/templatetags/foundation.py

@@ -1,9 +1,8 @@
 from decimal import ROUND_HALF_EVEN
 
-from django import template
 import moneyed
-from moneyed.localization import _format, format_money, _sign
-
+from django import template
+from moneyed.localization import _format, _sign, format_money
 
 register = template.Library()
 

foundation/urls/meetings.py

@@ -2,7 +2,6 @@
 
 from .. import views
 
-
 urlpatterns = [
     path('',
          views.MeetingArchiveIndex.as_view(),

requirements/common.txt

@@ -1,11 +1,11 @@
-Django==3.2.15
+Babel==2.10.1
 django-contact-form==1.9
 django-hosts==5.1
 django-money==2.1.1
-Babel==2.10.1
 django-push==1.1
 django-recaptcha==3.0.0
 django-registration-redux==2.10
+Django==3.2.15
 docutils==0.17.1
 feedparser==6.0.8
 Jinja2==3.1.2

requirements/dev.txt

@@ -1,4 +1,4 @@
 -r common.txt
-
+pre-commit~=2.20.0
 transifex-client==0.14.4
 watchdog==2.1.6

requirements/prod.txt

@@ -1,5 +1,4 @@
 -r common.txt
-
 django-pylibmc==0.6.1
 django-redis-cache==3.0.1
 pylibmc==1.6.1

requirements/tests.txt

@@ -1,4 +1,3 @@
 -r dev.txt
-
 coverage==6.3.2
 requests-mock==1.9.3