Add pre commit (#79)

danidee10 · web-flow · commit 902b7d39e52d · 2021-10-10T16:58:22.000+02:00
* add pre commit
* isort
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,16 @@
+repos:
+- repo: https://github.com/pycqa/isort
+  rev: 5.8.0
+  hooks:
+    - id: isort
+      name: isort (python)
+-   repo: https://github.com/ambv/black
+    rev: stable
+    hooks:
+    - id: black
+      language_version: python3
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.7.9
+    hooks:
+    - id: flake8
+
diff --git a/notifications/backends/aws_sqs_lambda.py b/notifications/backends/aws_sqs_lambda.py
@@ -1,13 +1,14 @@
 """AWS SQS backend"""
 
-import logging
 import json
+import logging
 
 import boto3
 
-from .base import BaseBackend
 from notifications import default_settings as settings
 
+from .base import BaseBackend
+
 
 class AwsSqsLambdaBackend(BaseBackend):
     logger = logging.getLogger('django_notifs.backends.aws_sqs_lambda')
diff --git a/notifications/backends/base.py b/notifications/backends/base.py
@@ -4,6 +4,7 @@
 import logging
 
 from django.utils.module_loading import import_string
+
 from notifications.channels import BaseNotificationChannel
 
 
diff --git a/notifications/backends/rq.py b/notifications/backends/rq.py
@@ -4,7 +4,6 @@
 from datetime import timedelta
 
 import django_rq
-
 from rq import Retry
 
 from .. import default_settings as settings
diff --git a/notifications/channels/base.py b/notifications/channels/base.py
@@ -2,10 +2,9 @@
 
 from django.utils.module_loading import import_string
 
-from notifications.utils import classproperty
 from notifications import default_settings as settings
-
 from notifications.providers import BaseNotificationProvider
+from notifications.utils import classproperty
 
 
 class BaseNotificationChannel(metaclass=abc.ABCMeta):
diff --git a/notifications/channels/django_channels.py b/notifications/channels/django_channels.py
@@ -1,6 +1,7 @@
 """Notification channels for django-notifs."""
 
 import json
+
 from notifications import default_settings as settings
 from notifications.channels import BaseNotificationChannel
 
diff --git a/notifications/consumers.py b/notifications/consumers.py
@@ -1,16 +1,16 @@
 """Channels consumers."""
 
-import json
 import asyncio
+import json
 import logging
 
 from channels.consumer import AsyncConsumer
 from channels.db import database_sync_to_async
 from channels.generic.websocket import AsyncWebsocketConsumer
 
-from . import default_settings as settings
 from notifications.backends.django_channels import ChannelsBackend
 
+from . import default_settings as settings
 
 logging.basicConfig(level=logging.INFO)
 logger = logging.getLogger('django_notifs.backends.channels')
diff --git a/notifications/default_settings.py b/notifications/default_settings.py
@@ -2,7 +2,6 @@
 
 from django.conf import settings
 
-
 NOTIFICATIONS_DELIVERY_BACKEND = getattr(
     settings,
     'NOTIFICATIONS_DELIVERY_BACKEND',
diff --git a/notifications/fields.py b/notifications/fields.py
@@ -2,7 +2,6 @@
 
 import django
 from django.db import models
-
 from django_jsonfield_backport.models import JSONField  # noqa
 
 django_version = float(django.get_version()[:3])
diff --git a/notifications/migrations/0001_initial.py b/notifications/migrations/0001_initial.py
@@ -2,9 +2,9 @@
 # Generated by Django 1.11 on 2017-06-24 00:20
 from __future__ import unicode_literals
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
diff --git a/notifications/migrations/0001_squashed_0010_notification_channels.py b/notifications/migrations/0001_squashed_0010_notification_channels.py
@@ -1,8 +1,9 @@
 # Generated by Django 3.1.7 on 2021-03-13 18:49
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
+
 import notifications.fields
 
 
diff --git a/notifications/migrations/0002_auto_20170718_1539.py b/notifications/migrations/0002_auto_20170718_1539.py
@@ -2,9 +2,9 @@
 # Generated by Django 1.11 on 2017-07-18 15:39
 from __future__ import unicode_literals
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
diff --git a/notifications/migrations/0002_django_jsonfield_backport.py b/notifications/migrations/0002_django_jsonfield_backport.py
@@ -2,10 +2,10 @@
 
 import django
 from django.db import migrations
-import notifications.fields
-
 from django_jsonfield_backport.models import JSONField  # noqa
 
+import notifications.fields
+
 django_version = float(django.get_version()[:3])
 
 if django_version >= 3.1:
diff --git a/notifications/migrations/0003_notification_channels_json.py b/notifications/migrations/0003_notification_channels_json.py
@@ -2,7 +2,6 @@
 
 import django
 from django.db import migrations
-
 from django_jsonfield_backport.models import JSONField  # noqa
 
 django_version = float(django.get_version()[:3])
diff --git a/notifications/migrations/0007_add_content_type_fields.py b/notifications/migrations/0007_add_content_type_fields.py
@@ -1,7 +1,7 @@
 # Generated by Django 2.2 on 2021-08-22 13:41
 
-from django.db import migrations, models
 import django.db.models.deletion
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
diff --git a/notifications/migrations/0008_auto_20210920_0149.py b/notifications/migrations/0008_auto_20210920_0149.py
@@ -1,8 +1,8 @@
 # Generated by Django 3.1.13 on 2021-09-19 23:49
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
diff --git a/notifications/migrations/0008_notification_extra_data.py b/notifications/migrations/0008_notification_extra_data.py
@@ -1,6 +1,7 @@
 # Generated by Django 2.0 on 2017-12-28 20:07
 
 from django.db import migrations
+
 import notifications.fields
 
 
diff --git a/notifications/migrations/0009_auto_20180112_0915.py b/notifications/migrations/0009_auto_20180112_0915.py
@@ -1,8 +1,8 @@
 # Generated by Django 2.0.1 on 2018-01-12 09:15
 
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
-import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
diff --git a/notifications/migrations/0010_notification_channels.py b/notifications/migrations/0010_notification_channels.py
@@ -1,6 +1,7 @@
 # Generated by Django 2.0.1 on 2018-01-28 08:27
 
 from django.db import migrations
+
 import notifications.fields
 
 
diff --git a/notifications/providers/email.py b/notifications/providers/email.py
@@ -1,7 +1,7 @@
-from . import BaseNotificationProvider
-
 from django.core.mail import EmailMessage, get_connection
 
+from . import BaseNotificationProvider
+
 
 class EmailNotificationProvider(BaseNotificationProvider):
     name = 'email'
diff --git a/notifications/providers/fcm_web.py b/notifications/providers/fcm_web.py
@@ -1,11 +1,10 @@
 """Adpaters to send notifications through various meduiums."""
 
+import requests
 from django.conf import settings
 
 from . import BaseNotificationProvider
 
-import requests
-
 
 class FCMWebNotificationProvider(BaseNotificationProvider):
     """Google FCM Web Provider."""
diff --git a/notifications/providers/pusher_channels.py b/notifications/providers/pusher_channels.py
@@ -1,8 +1,8 @@
-from . import BaseNotificationProvider
+from pusher import Pusher
 
 from notifications import default_settings as settings
 
-from pusher import Pusher
+from . import BaseNotificationProvider
 
 
 class PusherChannelsNotificationProvider(BaseNotificationProvider):
diff --git a/notifications/providers/slack.py b/notifications/providers/slack.py
@@ -1,8 +1,8 @@
-from . import BaseNotificationProvider
+from slack_sdk import WebClient
 
 from notifications import default_settings as settings
 
-from slack_sdk import WebClient
+from . import BaseNotificationProvider
 
 
 class SlackNotificationProvider(BaseNotificationProvider):
diff --git a/notifications/tests/test_backends.py b/notifications/tests/test_backends.py
@@ -1,14 +1,13 @@
 """General Tests."""
 
-from django.test import TestCase, override_settings
 from django.contrib.auth import get_user_model
+from django.test import TestCase, override_settings
 
+from ..backends import RQ, Celery, Channels
 from ..channels import ConsoleNotificationChannel
-from ..utils import get_notification_model
-from ..tasks import consume
-from ..backends import Celery, Channels, RQ
 from ..consumers import DjangoNotifsConsumer
-
+from ..tasks import consume
+from ..utils import get_notification_model
 
 Notification = get_notification_model()
 
diff --git a/notifications/tests/test_general.py b/notifications/tests/test_general.py
@@ -3,16 +3,15 @@
 import time
 from unittest import mock
 
-from django.db import models
 from django.contrib.auth import get_user_model
+from django.db import models
 from django.test import TestCase, override_settings
 
-from ..utils import notify, read, get_notification_model
 from .. import NotificationError
-from ..models import BaseNotificationModel
 from ..backends.base import BaseBackend
 from ..channels import ConsoleNotificationChannel
-
+from ..models import BaseNotificationModel
+from ..utils import get_notification_model, notify, read
 
 Notification = get_notification_model()
 
diff --git a/notifications/utils.py b/notifications/utils.py
@@ -1,7 +1,7 @@
 """Utilities and helper functions."""
 
-from django.utils.module_loading import import_string
 from django.conf import settings as django_settings
+from django.utils.module_loading import import_string
 
 from . import NotificationError
 
diff --git a/notifs/asgi.py b/notifs/asgi.py
@@ -1,12 +1,10 @@
 import os
 
+from channels.routing import ChannelNameRouter, ProtocolTypeRouter
 from django.core.asgi import get_asgi_application
 
-from channels.routing import ProtocolTypeRouter, ChannelNameRouter
-
 from notifications import consumers
 
-
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notifs.settings')
 
 application = ProtocolTypeRouter(
diff --git a/notifs/celery.py b/notifs/celery.py
@@ -1,11 +1,11 @@
 """Celery init."""
 
 from __future__ import absolute_import, unicode_literals
+
 import os
 
 from celery import Celery
 
-
 # set the default Django settings module for the 'celery' program.
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'notifs.settings')
 
diff --git a/notifs/wsgi.py b/notifs/wsgi.py
@@ -11,7 +11,6 @@
 
 from django.core.wsgi import get_wsgi_application
 
-
 os.environ.setdefault("DJANGO_SETTINGS_MODULE", "notifs.settings")
 
 application = get_wsgi_application()
diff --git a/requirements.txt b/requirements.txt
@@ -7,6 +7,7 @@ django-jsonfield-backport==1.0.4
 django-rq==2.4.0
 m2r2==0.2.7
 pusher==3.0.0
+pre-commit==2.15.0
 pytz==2017.2
 requests==2.25.1
 slack_sdk==3.11.2
diff --git a/setup.py b/setup.py
@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 
 from os import path
-from setuptools import find_packages, setup
 
+from setuptools import find_packages, setup
 
 # Package meta-data.
 NAME = 'django-notifs'
@@ -26,11 +26,10 @@
     'rq': ['django-rq>=2.4.0'],
     'channels': ['channels>=3.0.3', 'channels-redis>=3.2.0'],
     'sqs_lambda': ['boto3>=1.18.48'],
-
     # Provider requirements
     'pusher_channels': ['pusher>=3.0.0'],
     'slack': ['slack_sdk>=3.11.2'],
-    'anymail': ['django-anymail>=8.4']
+    'anymail': ['django-anymail>=8.4'],
 }
 EXCLUDE = ['notifs', 'tests', '*.tests', '*.tests.*', 'tests.*']
 
