Merge pull request #44 from satyam-seth-learnings/setup-black

Setup black

Author: satyam-seth

.vscode/setting.json

@@ -0,0 +1,12 @@
+{
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll": "explicit"
+    },
+    "editor.rulers": [
+        100
+    ],
+    "[python]": {
+        "editor.defaultFormatter": "ms-python.black-formatter"
+    }
+}

README.md

@@ -202,3 +202,30 @@
   ```sh
   mypy .
   ```
+
+10. Setup black
+
+- Install black package
+
+  ```sh
+  pip install black
+  ```
+
+- Add installed black package to requirements file
+
+  ```sh
+  pip freeze | grep black >> requirements.txt 
+  ```
+
+- Add black config in `puproject.toml` file
+
+  ```toml
+  [tool.black]
+  force-exclude = "/migrations/"
+  ```
+
+- Fix formatting using black
+
+  ```sh
+  black .
+  ```

backend/settings.py

@@ -37,8 +37,8 @@
     "django.contrib.sessions",
     "django.contrib.messages",
     "django.contrib.staticfiles",
-    'rest_framework',
-    'core',
+    "rest_framework",
+    "core",
 ]
 
 MIDDLEWARE = [

core/models.py

@@ -2,6 +2,7 @@
 
 # Create your models here.
 
+
 class Student(models.Model):
     """Student Model"""
 
@@ -10,5 +11,5 @@ class Student(models.Model):
 
     def __str__(self):
         """Student string representation"""
-        
-        return f"{self.first_name} {self.last_name}"
+
+        return f"{self.first_name} {self.last_name}"

core/tests.py

@@ -4,6 +4,7 @@
 
 # Create your tests here.
 
+
 class StudentModelTest(TestCase):
     def setUp(self):
         self.student = Student.objects.create(
@@ -16,8 +17,8 @@ def test_student_creation(self):
 
         self.assertEqual(self.student.first_name, "John")
         self.assertEqual(self.student.last_name, "Doe")
-        
+
     def test_str_method(self):
         """Test the __str__ method of the Student model."""
-        
-        self.assertEqual(str(self.student), "John Doe")
+
+        self.assertEqual(str(self.student), "John Doe")

pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+force-exclude = "/migrations/"

requirements.txt

@@ -4,3 +4,4 @@ coverage==7.9.2
 mypy==1.17.0
 django-stubs==5.2.2
 djangorestframework-stubs==3.16.1
+black==25.1.0