Merge pull request #55 from mantiumai/AlexN/pre-commit-hooks

run pre-commit hooks in CI

.github/workflows/django-test.yml

@@ -37,5 +37,5 @@ jobs:
         cd chirps; python manage.py test
     - name: Run Linting
       run: |
-        isort --check-only --diff .
+        pre-commit run -a
         pylint --load-plugins pylint_django --django-settings-module="chirps.settings" $(find . -name "*.py" | xargs)

.gitignore

@@ -161,4 +161,4 @@ cython_debug/
 .vscode/launch.json
 
 chirps/erl_crash.dump
-*.dump
+*.dump

.pre-commit-config.yaml

@@ -40,42 +40,42 @@ repos:
           - --exclude="(\.gitlab)"
 
   # pydocstyle checks docstring styles after blue is done reformatting
-#  - repo: https://github.com/pycqa/pydocstyle
-#    rev: 6.3.0
-#    hooks:
-#      - id: pydocstyle
-#        types: [python]
-#        exclude: 'test_.+\.py'
-#        args:
-#          - --config=.pydocstyle
+  - repo: https://github.com/pycqa/pydocstyle
+    rev: 6.3.0
+    hooks:
+      - id: pydocstyle
+        types: [python]
+        exclude: '^.*/migrations/.*$|test_.+\.py'
+        args:
+          - --config=.pydocstyle
 
   # After blue is done reformatting everything, double check it with flake8
-#  - repo: https://github.com/pycqa/flake8
-#    rev: 6.0.0
-#    hooks:
-#      - id: flake8
-#        types: [python]
-#        args:
-#          - --max-line-length=120
-#          - --extend-ignore=E203
+  - repo: https://github.com/pycqa/flake8
+    rev: 6.0.0
+    hooks:
+      - id: flake8
+        types: [python]
+        args:
+          - --max-line-length=120
+          - --extend-ignore=E203
 
   # mypy validates the python typing as per PEP 484
   # See https://jaredkhan.com/blog/mypy-pre-commit for the source of this
-#  - repo: local
-#    # We do not use pre-commit/mirrors-mypy,
-#    # as it comes with opinionated defaults
-#    # (like --ignore-missing-imports)
-#    # and is difficult to configure to run
-#    # with the dependencies correctly installed.
-#    hooks:
-#      - id: mypy
-#        name: mypy
-#        entry: "./scripts/run-mypy"
-#        # A script hook uses the active virtual environment, so it must be up-to-date with `poetry install --sync`
-#        language: script
-#        types_or: [python, toml]
-#        # use require_serial so that script
-#        # is only called once per commit
-#        require_serial: true
-#        # Print the number of files as a sanity-check
-#        verbose: true
+  # - repo: local
+  #    # We do not use pre-commit/mirrors-mypy,
+  #    # as it comes with opinionated defaults
+  #    # (like --ignore-missing-imports)
+  #    # and is difficult to configure to run
+  #    # with the dependencies correctly installed.
+  #    hooks:
+  #      - id: mypy
+  #        name: mypy
+  #        entry: "./scripts/run-mypy"
+  #        # A script hook uses the active virtual environment, so it must be up-to-date with `poetry install --sync`
+  #        language: script
+  #        types_or: [python, toml]
+  #        # use require_serial so that script
+  #        # is only called once per commit
+  #        require_serial: true
+  #        # Print the number of files as a sanity-check
+  #        verbose: true

chirps/account/admin.py

@@ -16,6 +16,7 @@ class ProfileInline(admin.StackedInline):
 
 class UserAdmin(BaseUserAdmin):
     """Define a new User admin."""
+
     inlines = [ProfileInline]
 
 

chirps/account/apps.py

@@ -1,4 +1,4 @@
-"""Configures the account app."""""
+"""Configures the account app."""
 from django.apps import AppConfig
 
 

chirps/account/forms.py

@@ -16,17 +16,20 @@ def clean_openai_key(self):
 
     class Meta:
         """Meta class for ProfileForm."""
+
         model = Profile
         fields = ['openai_key']
 
         widgets = {'openai_key': forms.PasswordInput(attrs={'class': 'form-control'})}
 
+
 class LoginForm(forms.Form):
     """Form for logging in."""
 
     username = forms.CharField(max_length=256)
     password = forms.CharField(max_length=256, widget=forms.PasswordInput)
 
+
 class SignupForm(forms.Form):
     """Form for signing up."""
 

chirps/account/tests.py

@@ -29,12 +29,9 @@ def test_new_account_signup(self):
         email = '[email protected]'
 
         # Create a new account
-        response = self.client.post(reverse('signup'), {
-            'username': username,
-            'email': email,
-            'password1': password,
-            'password2': password
-        })
+        response = self.client.post(
+            reverse('signup'), {'username': username, 'email': email, 'password1': password, 'password2': password}
+        )
         self.assertRedirects(response, '/', 302)
 
         # Logout (since the account creation )
@@ -47,6 +44,6 @@ def test_new_account_signup(self):
             {
                 'username': username,
                 'password': password,
-            }
+            },
         )
         self.assertRedirects(response, '/', status_code=302)

chirps/account/urls.py

@@ -17,5 +17,5 @@
         'password_reset/',
         auth_views.PasswordResetView.as_view(template_name='account/password_reset.html'),
         name='password_reset',
-    )
+    ),
 ]

chirps/account/views.py

@@ -27,6 +27,7 @@ def profile(request):
 
     return render(request, 'account/profile.html', {'form': form})
 
+
 def signup(request):
     """Render the signup page and handle posts."""
     if request.method == 'POST':
@@ -48,9 +49,7 @@ def signup(request):
             if has_error is False:
                 # Create the user:
                 user = User.objects.create_user(
-                    form.cleaned_data['username'],
-                    form.cleaned_data['email'],
-                    form.cleaned_data['password1']
+                    form.cleaned_data['username'], form.cleaned_data['email'], form.cleaned_data['password1']
                 )
                 user.save()
 
@@ -68,19 +67,19 @@ def signup(request):
 
     return render(request, 'account/signup.html', {'form': form})
 
+
 def login_view(request):
     """Render the login page."""
-
     # If there are no users, redirect to the installation page
     if User.objects.count() == 0:
         return redirect(reverse('install'))
 
     if request.method == 'POST':
         form = LoginForm(request.POST)
         if form.is_valid():
-            user = authenticate(request=request,
-                                username=form.cleaned_data['username'],
-                                password=form.cleaned_data['password'])
+            user = authenticate(
+                request=request, username=form.cleaned_data['username'], password=form.cleaned_data['password']
+            )
             if user:
                 login(request, user)
                 return redirect('/')

chirps/base_app/forms.py

@@ -4,11 +4,10 @@
 
 class InstallForm(forms.Form):
     """Form to render the new installation page."""
+
     superuser_username = forms.CharField(label='Superuser Username', max_length=100)
     superuser_email = forms.EmailField(label='Superuser Email', max_length=100)
     superuser_password = forms.CharField(label='Superuser Password', max_length=100, widget=forms.PasswordInput)
     superuser_password_confirm = forms.CharField(
-        label='Superuser Password (Confirm)',
-        max_length=100,
-        widget=forms.PasswordInput
+        label='Superuser Password (Confirm)', max_length=100, widget=forms.PasswordInput
     )

chirps/base_app/management/commands/celery.py

@@ -6,10 +6,11 @@
 
 class Command(BaseCommand):
     """Manage a local celery installation with this command."""
+
     help = 'Interact with the local celery broker'
 
     def add_arguments(self, parser):
-
+        """Add arguments to celery command"""
         parser.add_argument('--start', action='store_true', help='Start celery server')
         parser.add_argument('--stop', action='store_true', help='Stop celery server')
         parser.add_argument('--restart', action='store_true', help='Restart celery server')

chirps/base_app/management/commands/initialize_app.py

@@ -8,9 +8,11 @@
 
 class Command(BaseCommand):
     """Initialize the app by running multiple management commands."""
+
     help = 'Initialize the app by running multiple management commands'
 
     def handle(self, *args, **options):
+        """Handle the command"""
         # Run the 'redis --start' command
         self.stdout.write(self.style.WARNING('Starting Redis...'))
         call_command('redis', '--start')

chirps/base_app/management/commands/rabbitmq.py

@@ -6,16 +6,17 @@
 
 class Command(BaseCommand):
     """Management command for interacting with rabbitmq."""
+
     help = 'Interact with the local rabbitmq development server'
 
     def add_arguments(self, parser):
-
+        """Add arguments to rabbitmq command"""
         parser.add_argument('--start', action='store_true', help='Start rabbitmq server')
         parser.add_argument('--stop', action='store_true', help='Stop rabbitmq server')
         parser.add_argument('--status', action='store_true', help='Check rabbitmq server status')
 
     def handle(self, *args, **options):
-
+        """Handle rabbitmq command"""
         if options['start']:
             os.system('rabbitmq-server start -detached')
         elif options['stop']:

chirps/base_app/management/commands/redis.py

@@ -6,16 +6,17 @@
 
 class Command(BaseCommand):
     """Management command for interacting with redis."""
+
     help = 'Interact with the local redis development server'
 
     def add_arguments(self, parser):
-
+        """Add arguments to redis command"""
         parser.add_argument('--start', action='store_true', help='Start redis server')
         parser.add_argument('--stop', action='store_true', help='Stop redis server')
         parser.add_argument('--status', action='store_true', help='Check redis server status')
 
     def handle(self, *args, **options):
-
+        """Handle redis command"""
         if options['start']:
             os.system('redis-server --daemonize yes')
         elif options['stop']:

chirps/base_app/management/commands/start_services.py

@@ -7,9 +7,11 @@
 
 class Command(BaseCommand):
     """Initialize the app by running multiple management commands."""
+
     help = 'Initialize the app by running multiple management commands'
 
     def handle(self, *args, **options):
+        """Start the services required to run the application, then start the server with `runserver`"""
         # Run the 'redis --start' command
         self.stdout.write(self.style.WARNING('Starting Redis...'))
         call_command('redis', '--start')

chirps/base_app/urls.py

@@ -3,7 +3,4 @@
 
 from . import views
 
-urlpatterns = [
-    path('', views.index, name='index'),
-    path('install', views.install, name='install')
-]
+urlpatterns = [path('', views.index, name='index'), path('install', views.install, name='install')]

chirps/base_app/views.py

@@ -14,9 +14,9 @@ def index(request):
     """Render the index page."""
     return render(request, 'dashboard/index.html', {})
 
+
 def install(request):
     """Render the install page."""
-
     # If there are uses already, redirect to the dashboard
     if User.objects.count() > 0:
         return redirect(reverse('index'))
@@ -42,7 +42,7 @@ def install(request):
                 user = User.objects.create_superuser(
                     form.cleaned_data['superuser_username'],
                     form.cleaned_data['superuser_email'],
-                    form.cleaned_data['superuser_password']
+                    form.cleaned_data['superuser_password'],
                 )
 
                 # Create the user profile

chirps/chirps/settings.py

@@ -148,28 +148,28 @@
 
 # FERNET SETTINGS
 if os.getenv('FERNET_KEY') is None:
-    raise Exception('FERNET_KEY environment variable is not set') # pylint: disable=broad-exception-raised
+    raise Exception('FERNET_KEY environment variable is not set')   # pylint: disable=broad-exception-raised
 
 FERNET_KEY = os.getenv('FERNET_KEY')
 
 # LOGGING Configuration Options
 LOGGING = {
-    "version": 1,
-    "disable_existing_loggers": False,
-    "handlers": {
-        "console": {
-            "class": "logging.StreamHandler",
+    'version': 1,
+    'disable_existing_loggers': False,
+    'handlers': {
+        'console': {
+            'class': 'logging.StreamHandler',
         },
     },
-    "root": {
-        "handlers": ["console"],
-        "level": "WARNING",
+    'root': {
+        'handlers': ['console'],
+        'level': 'WARNING',
     },
-    "loggers": {
-        "django": {
-            "handlers": ["console"],
-            "level": os.getenv("DJANGO_LOG_LEVEL", "INFO"),
-            "propagate": False,
+    'loggers': {
+        'django': {
+            'handlers': ['console'],
+            'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),
+            'propagate': False,
         },
     },
 }

chirps/chirps/urls.py

@@ -3,6 +3,7 @@
 
 The `urlpatterns` list routes URLs to views. For more information please see:
     https://docs.djangoproject.com/en/4.2/topics/http/urls/
+
 Examples:
 Function views
     1. Add an import:  from my_app import views