chore: add ruff to lint and format python code

Author: marcelovicentegc

.gitignore

@@ -32,4 +32,7 @@ coverage
 .ionide
 
 # IntelliJ
-.idea
+.idea
+
+# Ruff
+.ruff_cache

.husky/pre-commit

@@ -0,0 +1,7 @@
+echo "Running static tests..."
+pnpm run test:static
+echo "Done running static tests."
+
+echo "Formatting code..."
+pnpm run format
+echo "Done formatting code."

README.md

@@ -1,6 +1,6 @@
 # django-react-typescript <!-- omit from toc -->
 
-<img alt="django-react-typescript logo" src="assets/Logo.png" align="right" width="95" height="95" />
+<img alt="django-react-typescript logo" src="assets/Logo.png" align="right" width="120" height="120" />
 
 This is an non-opinionated Django 5 + React 18 boilerplate built with great development experience and easy deployment in mind.
 

api/apps.py

@@ -2,4 +2,4 @@
 
 
 class ApiConfig(AppConfig):
-    name = 'api'
+    name = "api"

api/filters/publications.py

@@ -1,10 +1,11 @@
 from django_filters import rest_framework as filters
 from backend.models.publications import Publication
 
+
 class PublicationFilter(filters.FilterSet):
-    tag = filters.CharFilter(field_name='tag', lookup_expr='icontains')
-    title = filters.CharFilter(field_name='title', lookup_expr='icontains')
+    tag = filters.CharFilter(field_name="tag", lookup_expr="icontains")
+    title = filters.CharFilter(field_name="title", lookup_expr="icontains")
 
     class Meta:
         model = Publication
-        fields = ['title', 'tag']
+        fields = ["title", "tag"]

api/serializers/__init__.py

@@ -1,2 +0,0 @@
-from .publications import PublicationsSerializer
-from .subscribers import SubscribersSerializer

api/serializers/publications.py

@@ -1,12 +1,22 @@
 from rest_framework import serializers
 from backend.models.publications import Publication
 
+
 class PublicationsSerializer(serializers.ModelSerializer):
     image = serializers.SerializerMethodField(read_only=True)
 
     def get_image(self, instance):
         return instance.image.url
 
     class Meta:
-        model = Publication  
-        fields = ('title', 'slug', 'description', 'body', 'image', 'tag', 'image_description', 'created_at')
+        model = Publication
+        fields = (
+            "title",
+            "slug",
+            "description",
+            "body",
+            "image",
+            "tag",
+            "image_description",
+            "created_at",
+        )

api/serializers/subscribers.py

@@ -1,7 +1,8 @@
 from rest_framework import serializers
 from backend.models.subscribers import Subscriber
 
+
 class SubscribersSerializer(serializers.ModelSerializer):
     class Meta:
         model = Subscriber
-        fields = ('name', 'contact_method', 'contact_info')
+        fields = ("name", "contact_method", "contact_info")

api/tests.py

@@ -1,3 +0,0 @@
-from django.test import TestCase
-
-# Create your tests here.

api/urls.py

@@ -1,15 +1,21 @@
 from django.urls import re_path
 from rest_framework.authtoken.views import obtain_auth_token
 from .views.subscribers import SubscribersEndpoint
-from .views.publications import PublicationsEndpoint, PublicationsQueryEndpoint, PaginatedPublicationsQueryEndpoint, PaginatedPublicationsEndpoint, PublicationEndpoint
+from .views.publications import (
+    PublicationsEndpoint,
+    PublicationsQueryEndpoint,
+    PaginatedPublicationsQueryEndpoint,
+    PaginatedPublicationsEndpoint,
+    PublicationEndpoint,
+)
 
 
 urlpatterns = [
-    re_path(r'^subscribers/$', SubscribersEndpoint.as_view() ),
-    re_path(r'^publications/p/$', PaginatedPublicationsEndpoint.as_view() ),
-    re_path(r'^publications/filter/$', PublicationsQueryEndpoint.as_view() ),
-    re_path(r'^publications/p/filter/$', PaginatedPublicationsQueryEndpoint.as_view()),
-    re_path(r'^publications/(?P<slug>[\w\-]+)/$', PublicationEndpoint.as_view()),
-    re_path(r'^publications/$', PublicationsEndpoint.as_view() ),
-    re_path(r'^authenticate/$', obtain_auth_token)
-]
+    re_path(r"^subscribers/$", SubscribersEndpoint.as_view()),
+    re_path(r"^publications/p/$", PaginatedPublicationsEndpoint.as_view()),
+    re_path(r"^publications/filter/$", PublicationsQueryEndpoint.as_view()),
+    re_path(r"^publications/p/filter/$", PaginatedPublicationsQueryEndpoint.as_view()),
+    re_path(r"^publications/(?P<slug>[\w\-]+)/$", PublicationEndpoint.as_view()),
+    re_path(r"^publications/$", PublicationsEndpoint.as_view()),
+    re_path(r"^authenticate/$", obtain_auth_token),
+]