Merge pull request #18 from Mng-dev-ai/add-linting

Add linting

Author: Mng-dev-ai

.DS_Store

@@ -7,7 +7,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: ["3.9", "3.10"]
+        python-version: ["3.8","3.9"]
         os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
@@ -25,3 +25,6 @@ jobs:
 
       - name: Run tests
         run: python runtests.py
+
+      - name: Run linting checks
+        run: bash scripts/check

.github/workflows/test.yml

@@ -75,10 +75,11 @@ Ready to contribute? Here's how to set up `drf-turbo` for local development.
 
    Now you can make your changes locally.
 
-5. The next step would be to run the test cases. Before you run runtests you should ensure all dependencies are installed
+5. When you're done making changes, check that your changes pass flake8,black,isort and the tests. you should ensure all dependencies are installed
 
     $ pip install -r requirements_dev.txt
-    $ python3 runtests.py
+    $ bash scripts/check
+    $ pytest
 
 6. Commit your changes and push your branch to GitHub::
 

CONTRIBUTING.rst

@@ -29,7 +29,7 @@
 autoclass_content = "both"
 
 # Theme
-html_theme = 'furo'
+html_theme = "furo"
 
 
 html_sidebars = {
@@ -42,6 +42,3 @@
         "sidebar/scroll-end.html",
     ]
 }
-
-
-

docs/.DS_Store

@@ -1,48 +1,49 @@
-from drf_turbo.serializer import BaseSerializer,Serializer,ModelSerializer
-from drf_turbo.fields import (
-    Field,StrField,EmailField,URLField,RegexField,IPField,PasswordField,UUIDField,SlugField,IntField,FloatField,DecimalField,BoolField,ChoiceField,MultipleChoiceField,DateTimeField,DateField,TimeField,FileField,ArrayField,DictField,JSONField,RelatedField,ManyRelatedField,ConstantField,RecursiveField,MethodField
-)
 from drf_turbo.exceptions import ValidationError
+from drf_turbo.fields import (ArrayField, BoolField, ChoiceField,
+                              ConstantField, DateField, DateTimeField,
+                              DecimalField, DictField, EmailField, Field,
+                              FileField, FloatField, IntField, IPField,
+                              JSONField, ManyRelatedField, MethodField,
+                              MultipleChoiceField, PasswordField,
+                              RecursiveField, RegexField, RelatedField,
+                              SlugField, StrField, TimeField, URLField,
+                              UUIDField)
+from drf_turbo.serializer import BaseSerializer, ModelSerializer, Serializer
 
 __author__ = """Michael Gendy"""
-__email__ = '[email protected]'
-__version__ = '0.1.6'
+__email__ = "[email protected]"
+__version__ = "0.1.6"
 
 __all__ = [
-    'BaseSerializer',
-    'Serializer',
-    'ModelSerializer',
-    'Field',
-    'StrField',
-    'EmailField',
-    'URLField',
-    'RegexField',
-    'IPField',
-    'PasswordField',
-    'UUIDField',
-    'SlugField',
-    'IntField',
-    'FloatField',
-    'DecimalField',
-    'BoolField',
-    'ChoiceField',
-    'MultipleChoiceField',
-    'DateTimeField',
-    'DateField',
-    'TimeField',
-    'FileField',
-    'ArrayField',
-    'DictField',
-    'JSONField',
-    'RelatedField',
-    'ManyRelatedField',
-    'ConstantField',
-    'RecursiveField',
-    'MethodField',
-    'ValidationError',
+    "BaseSerializer",
+    "Serializer",
+    "ModelSerializer",
+    "Field",
+    "StrField",
+    "EmailField",
+    "URLField",
+    "RegexField",
+    "IPField",
+    "PasswordField",
+    "UUIDField",
+    "SlugField",
+    "IntField",
+    "FloatField",
+    "DecimalField",
+    "BoolField",
+    "ChoiceField",
+    "MultipleChoiceField",
+    "DateTimeField",
+    "DateField",
+    "TimeField",
+    "FileField",
+    "ArrayField",
+    "DictField",
+    "JSONField",
+    "RelatedField",
+    "ManyRelatedField",
+    "ConstantField",
+    "RecursiveField",
+    "MethodField",
+    "ValidationError",
 ]
-
-
-
-
-

docs/conf.py

@@ -2,20 +2,23 @@
 
 from drf_turbo.utils import get_execption_detail
 
+
 cdef class DrfTurboException(Exception):
-    """Base class for all fast_rest-related errors."""
+    """
+    Base class for all exceptions raised by drf_turbo.
+    """
     status_code = 500
     default_detail = 'A server error occurred.'
     default_code = 'error'
-    
+
     def __cinit__(self, detail=None, code=None) -> None:
         if detail is None:
             detail = self.default_detail
         if code is None:
             code = self.default_code
-        
+
         self.detail = get_execption_detail(detail)
-        
+
     def __str__(self) -> str:
         return str(self.detail)
 
@@ -28,15 +31,16 @@ cdef class ValidationError(DrfTurboException):
             detail = self.default_detail
         if code is None:
             code = self.default_code
-            
+
         if isinstance(detail, tuple):
             detail = list(detail)
         elif not isinstance(detail, dict) and not isinstance(detail, list):
             detail = [detail]
 
         self.detail = get_execption_detail(detail)
-        
-class StringNotCollectionError(DrfTurboException,TypeError):
+
+
+class StringNotCollectionError(DrfTurboException, TypeError):
     pass