ZDL-94: Integrate isort package

.github/workflows/django-cicd.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install black flake8 pytest mypy
+          pip install black flake8 pytest mypy isort
       - name: Lint with flake8
         run: |
           flake8 .  --statistics
@@ -27,6 +27,9 @@ jobs:
           mypy .
       - name: Check formatting
         run: black . --exclude=venv --check
+      - name: Check isort imports
+        run: |
+          isort . --check-only
   unit-test:
     runs-on: ubuntu-latest
     services:
@@ -50,6 +53,6 @@ jobs:
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
       - name: Run migrations
         run: python manage.py migrate
-      - name: Test with pytest
+      - name: Test with pytest with coverage
         run: |
           pytest . --cov

.isort.cfg

@@ -0,0 +1,2 @@
+[settings]
+profile=black

authentication/admin.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
+
 from authentication.models import User
 
 admin.site.register(User)

authentication/models.py

@@ -1,11 +1,12 @@
-from django.db import models
 from django.contrib.auth.models import (
     AbstractBaseUser,
-    Group,
     BaseUserManager,
+    Group,
     PermissionsMixin,
 )
+from django.db import models
 from rest_framework_simplejwt.tokens import RefreshToken
+
 from authentication.validators import UserTokens
 
 

authentication/serializers.py

@@ -1,7 +1,8 @@
-from rest_framework import serializers
-from authentication.models import User
 from django.contrib import auth
+from rest_framework import serializers
 from rest_framework.exceptions import AuthenticationFailed
+
+from authentication.models import User
 from authentication.validators import UserLogin
 
 

authentication/tests/factories/group_factory.py

@@ -1,5 +1,5 @@
-from django.contrib.auth.models import Group
 import factory
+from django.contrib.auth.models import Group
 
 
 class CustomersGroupFactory(factory.django.DjangoModelFactory):

authentication/tests/factories/user_factory.py

@@ -1,7 +1,8 @@
-from authentication.models import User
+import factory
 from factory import PostGenerationMethodCall
 from factory.django import DjangoModelFactory
-import factory
+
+from authentication.models import User
 
 
 class UserFactory(DjangoModelFactory):

authentication/tests/test_auth_api.py

@@ -1,10 +1,10 @@
+import pytest
+from django.contrib.auth.models import Group
 from django.test import Client
 from django.test.client import MULTIPART_CONTENT
 
-from authentication.tests.factories.user_factory import UserFactory
 from authentication.models import User
-from django.contrib.auth.models import Group
-import pytest
+from authentication.tests.factories.user_factory import UserFactory
 
 
 @pytest.mark.django_db

authentication/urls.py

@@ -1,9 +1,10 @@
 from django.urls import path
+
 from .views import (
-    UserRegisterView,
-    UserLoginView,
     SupplierRegisterView,
+    UserLoginView,
     UserProfileView,
+    UserRegisterView,
 )
 
 urlpatterns = [

authentication/views.py

@@ -1,16 +1,16 @@
 from rest_condition import Or
+from rest_framework import status
 from rest_framework.generics import GenericAPIView
 from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
 
 from .permissions import CustomerAccessPermission, SupplierAccessPermission
 from .serializers import (
-    UserSerializer,
-    UserLoginSerializers,
     SupplierSerializer,
+    UserLoginSerializers,
     UserProfileSerializer,
+    UserSerializer,
 )
-from rest_framework.response import Response
-from rest_framework import status
 
 
 class UserRegisterView(GenericAPIView):

conftest.py

@@ -1,8 +1,9 @@
 import pytest
-from authentication.tests.factories.user_factory import UserFactory
+from django.contrib.auth.models import Group
 from django.test.client import Client
 from pytest_django.lazy_django import skip_if_no_django
-from django.contrib.auth.models import Group
+
+from authentication.tests.factories.user_factory import UserFactory
 
 
 @pytest.fixture

orders/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
-from .models import Order, OrderItem, ShippingAddress
 
+from .models import Order, OrderItem, ShippingAddress
 
 admin.site.register(Order)
 admin.site.register(OrderItem)

orders/migrations/0001_initial.py

@@ -1,8 +1,8 @@
 # Generated by Django 3.0.8 on 2021-01-08 02:01
 
+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):

orders/migrations/0002_auto_20210917_2012.py

@@ -1,7 +1,7 @@
 # Generated by Django 3.0.8 on 2021-09-17 12:12
 
-from django.db import migrations, models
 import django.utils.timezone
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):

orders/models.py

@@ -1,9 +1,10 @@
-from django.utils import timezone
 from django.db import models
-from authentication.models import User
-from products.models import Product
 from django.db.models.signals import post_delete
 from django.dispatch import receiver
+from django.utils import timezone
+
+from authentication.models import User
+from products.models import Product
 
 
 class Order(models.Model):

orders/serializers.py

@@ -1,4 +1,5 @@
 from rest_framework import serializers
+
 from orders.models import Order, OrderItem, ShippingAddress
 from products.serializers import ProductSerializer
 

orders/tests/factories/order_factory.py

@@ -1,8 +1,10 @@
-from orders.models import Order
+import datetime
+
+import factory
 from factory.django import DjangoModelFactory
+
 from authentication.tests.factories.user_factory import UserFactory
-import factory
-import datetime
+from orders.models import Order
 
 
 class OrderFactory(DjangoModelFactory):

orders/tests/factories/order_item_factory.py

@@ -1,9 +1,11 @@
+import datetime
+
+import factory
+from factory.django import DjangoModelFactory
+
 from orders.models import OrderItem
-from products.tests.factories.product_factory import ProductFactory
 from orders.tests.factories.order_factory import OrderFactory
-from factory.django import DjangoModelFactory
-import factory
-import datetime
+from products.tests.factories.product_factory import ProductFactory
 
 
 class OrderItemFactory(DjangoModelFactory):

orders/tests/test_orders_api.py

@@ -1,10 +1,10 @@
 from datetime import datetime
 
-from orders.tests.factories.order_item_factory import OrderItemFactory
-from orders.tests.factories.order_factory import OrderFactory
-from orders.models import OrderItem, Order
 import pytest
 
+from orders.models import Order, OrderItem
+from orders.tests.factories.order_factory import OrderFactory
+from orders.tests.factories.order_item_factory import OrderItemFactory
 from products.tests.factories.product_factory import ProductFactory
 
 

orders/urls.py

@@ -1,7 +1,7 @@
-from orders.views import OrderViewSet
-from django.urls import path, include
+from django.urls import include, path
 from rest_framework.routers import DefaultRouter
 
+from orders.views import OrderViewSet
 
 router = DefaultRouter()
 router.register("", OrderViewSet)

orders/validators.py

@@ -1,6 +1,7 @@
-from pydantic import BaseModel
 from typing import Dict, List
 
+from pydantic import BaseModel
+
 
 class OrdersList(BaseModel):
     total_items: int

orders/views.py

@@ -1,27 +1,26 @@
+import datetime
+
+from rest_condition import Or
+from rest_framework import mixins, status, viewsets
+from rest_framework.decorators import action
 from rest_framework.generics import get_object_or_404
+from rest_framework.permissions import IsAuthenticated
+from rest_framework.response import Response
 
+from authentication.permissions import (
+    CustomerAccessPermission,
+    SupplierAccessPermission,
+)
 from orders.exceptions import UnprocessableEntity
 from orders.models import Order, OrderItem, ShippingAddress
-from rest_framework.response import Response
 from orders.serializers import (
     OrderItemSerializer,
     OrderSerializer,
-    UpdateCartSerializer,
     ShippingAddressSerializer,
+    UpdateCartSerializer,
 )
-from rest_framework.permissions import IsAuthenticated
-from authentication.permissions import (
-    CustomerAccessPermission,
-    SupplierAccessPermission,
-)
-from rest_framework import mixins, viewsets
-from rest_framework.decorators import action
-from rest_condition import Or
-
 from orders.validators import OrdersList
 from products.models import Product
-from rest_framework import status
-import datetime
 
 
 class OrderViewSet(mixins.ListModelMixin, viewsets.GenericViewSet):

products/admin.py

@@ -1,4 +1,5 @@
 from django.contrib import admin
+
 from products.models import Product
 
 admin.site.register(Product)

products/migrations/0001_initial.py

@@ -1,8 +1,8 @@
 # Generated by Django 3.0.8 on 2021-01-08 02:01
 
+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):

products/models.py

@@ -1,5 +1,5 @@
-from django.db import models
 from django.conf import settings
+from django.db import models
 
 
 class Product(models.Model):

products/serializers.py

@@ -1,4 +1,5 @@
 from rest_framework import serializers
+
 from products.models import Product
 
 

products/tests/factories/product_factory.py

@@ -1,6 +1,7 @@
-from products.models import Product
-from factory.django import DjangoModelFactory
 import factory
+from factory.django import DjangoModelFactory
+
+from products.models import Product
 
 
 class ProductFactory(DjangoModelFactory):

products/tests/test_products_api.py

@@ -1,8 +1,9 @@
 import pytest
-from products.tests.factories.product_factory import ProductFactory
-from products.models import Product
 from django.test.client import MULTIPART_CONTENT
 
+from products.models import Product
+from products.tests.factories.product_factory import ProductFactory
+
 
 @pytest.mark.django_db
 def test_list_all_products_with_empty_db(logged_in_client):

products/urls.py

@@ -1,7 +1,7 @@
-from products.views import ProductViewSet
+from django.urls import include, path
 from rest_framework import routers
-from django.urls import path, include
 
+from products.views import ProductViewSet
 
 router = routers.DefaultRouter()
 router.register("", ProductViewSet)

products/views.py

@@ -1,11 +1,13 @@
-from products.models import Product
+from rest_framework import filters
+from rest_framework.pagination import PageNumberPagination
+from rest_framework.parsers import MultiPartParser
 from rest_framework.permissions import IsAuthenticatedOrReadOnly
-from .serializers import ProductSerializer
-from authentication.permissions import SupplierAccessPermission
 from rest_framework.viewsets import ModelViewSet
-from rest_framework.parsers import MultiPartParser
-from rest_framework.pagination import PageNumberPagination
-from rest_framework import filters
+
+from authentication.permissions import SupplierAccessPermission
+from products.models import Product
+
+from .serializers import ProductSerializer
 
 
 class ProductViewSet(ModelViewSet):

requirements.txt

@@ -1,10 +1,12 @@
 appdirs==1.4.4
 asgiref==3.2.10
+atomicwrites==1.4.0
 attrs==19.3.0
 black==20.8b1
 certifi==2020.6.20
 chardet==3.0.4
 click==7.1.2
+colorama==0.4.4
 coreapi==2.3.3
 coreschema==0.0.4
 coverage==5.3.1
@@ -21,6 +23,7 @@ idna==2.10
 importlib-metadata==1.7.0
 inflection==0.5.1
 iniconfig==1.0.1
+isort==5.10.1
 itypes==1.2.0
 Jinja2==2.11.2
 MarkupSafe==1.1.1