Reformat files add username endpoint

Author: RyanJField

.isort.cfg

@@ -0,0 +1,10 @@
+[settings]
+profile= black
+multi_line_output = 3
+include_trailing_comma = True
+force_grid_wrap = 0
+use_parentheses = True
+ensure_newline_before_comments = True
+line_length = 79
+max-line-length = 88
+extend-ignore = E203

custom_user/admin.py

@@ -13,15 +13,24 @@ class Meta(UserChangeForm.Meta):
 class CustomUserAdmin(UserAdmin):
     form = CustomUserChangeForm
     fieldsets = (
-        (None, {'fields': ('username', 'password')}),
-        ('Personal info', {'fields': ('full_name', 'email', 'orgs')}),
-        ('Permissions', {
-            'fields': ('is_active', 'is_staff', 'is_superuser', 'groups', 'user_permissions'),
-        }),
-        ('Important dates', {'fields': ('last_login', 'date_joined')}),
+        (None, {"fields": ("username", "password")}),
+        ("Personal info", {"fields": ("full_name", "email", "orgs")}),
+        (
+            "Permissions",
+            {
+                "fields": (
+                    "is_active",
+                    "is_staff",
+                    "is_superuser",
+                    "groups",
+                    "user_permissions",
+                ),
+            },
+        ),
+        ("Important dates", {"fields": ("last_login", "date_joined")}),
     )
-    readonly_fields = ('email', 'full_name', 'orgs')
-    list_display = ('username', 'email', 'full_name', 'is_staff')
+    readonly_fields = ("email", "full_name", "orgs")
+    list_display = ("username", "email", "full_name", "is_staff")
 
 
 admin.site.register(CustomUser, CustomUserAdmin)

custom_user/apps.py

@@ -2,4 +2,4 @@
 
 
 class CustomUserConfig(AppConfig):
-    name = 'custom_user'
+    name = "custom_user"

custom_user/managers.py

@@ -9,36 +9,34 @@ class CustomUserManager(BaseUserManager):
 
     def _create_user(self, username, password, **extra_fields):
         if not username:
-            raise ValueError('The given username must be set')
+            raise ValueError("The given username must be set")
         username = self.model.normalize_username(username)
         user = self.model(username=username, **extra_fields)
         user.set_password(password)
         user.save(using=self._db)
         return user
 
     def create_superuser(self, username, password=None, **extra_fields):
-        extra_fields.setdefault('is_staff', True)
-        extra_fields.setdefault('is_superuser', True)
+        extra_fields.setdefault("is_staff", True)
+        extra_fields.setdefault("is_superuser", True)
 
-        if extra_fields.get('is_staff') is not True:
-            raise ValueError('Superuser must have is_staff=True.')
-        if extra_fields.get('is_superuser') is not True:
-            raise ValueError('Superuser must have is_superuser=True.')
+        if extra_fields.get("is_staff") is not True:
+            raise ValueError("Superuser must have is_staff=True.")
+        if extra_fields.get("is_superuser") is not True:
+            raise ValueError("Superuser must have is_superuser=True.")
 
         return self._create_user(username, password, **extra_fields)
 
     def create_user(self, password=None, **kwargs):
         """Create and return a `User` with an username"""
 
-        username = kwargs.get('username')
+        username = kwargs.get("username")
 
         if username is None:
             raise TypeError("Users must have a username.")
 
-        user = self.model(
-            username = self.model.normalize_username(username)
-        )
+        user = self.model(username=self.model.normalize_username(username))
         user.set_password(password)
         user.save()
 
-        return user
+        return user

custom_user/models.py

@@ -5,6 +5,7 @@
 
 from .managers import CustomUserManager
 
+
 def _get_users():
     _authorised_users_file = settings.AUTHORISED_USER_FILE
     if _authorised_users_file:
@@ -16,6 +17,7 @@ def _get_users():
             return []
     return []
 
+
 def _get_user(username):
     _users = _get_users()
     for _user in _users:
@@ -24,29 +26,34 @@ def _get_user(username):
                 return _user
     return None
 
+
 def _is_valid_user(username):
     if _get_user(username):
         return True
     return False
 
+
 def _get(key, username):
     _user = _get_user(username)
     if _user:
         if key in _user:
             return _user[key]
     return None
 
+
 def _get_full_name(username):
     if _get("fullname", username):
         return _get("fullname", username)
-    return 'User Not Found'
+    return "User Not Found"
+
 
 def _get_email(username):
     _user = _get_user(username)
     if _user:
         if "email" in _user:
             return _user["email"]
-    return f'{username}@users.noreply.github.com'
+    return f"{username}@users.noreply.github.com"
+
 
 def _get_orgs(username):
     if _get("orgs", username):
@@ -58,6 +65,7 @@ class User(AbstractUser):
     """
     Custom user that retrieves user details from the SCRC personnel database.
     """
+
     objects = CustomUserManager()
 
     REQUIRED_FIELDS = []
@@ -77,9 +85,10 @@ def clean(self):
             if _get_users():
                 if not _is_valid_user(self.username):
                     raise ValidationError(
-                    {'username': "Username is not in allowed users"})
+                        {"username": "Username is not in allowed users"}
+                    )
         AbstractBaseUser.clean(self)
-    
+
     def save(self, *args, **kwargs):
         # This overriding of the save method is necessary because Django by default does not call the
         # full_clean() method and there is where the clean() method is called

data_management/admin.py

@@ -2,15 +2,16 @@
 
 from . import models
 
-admin.site.site_header = 'FAIR Data Management'
+admin.site.site_header = "FAIR Data Management"
 
 
 class BaseAdmin(admin.ModelAdmin):
     """
     Base model for admin views.
     """
-    readonly_fields = ('updated_by', 'last_updated')
-    list_display = ('last_updated',)
+
+    readonly_fields = ("updated_by", "last_updated")
+    list_display = ("last_updated",)
 
     def save_model(self, request, obj, form, change):
         """
@@ -24,8 +25,9 @@ class IssueAdmin(BaseAdmin):
     """
     Admin view for the Issue model.
     """
-    readonly_fields = ('updated_by', 'last_updated', 'linked_objects')
-    list_display = ('short_desc', 'severity', 'last_updated')
+
+    readonly_fields = ("updated_by", "last_updated", "linked_objects")
+    list_display = ("short_desc", "severity", "last_updated")
 
     @classmethod
     def linked_objects(cls, issue):
@@ -39,6 +41,6 @@ def linked_objects(cls, issue):
     if issubclass(cls, models.Issue):
         admin.site.register(cls, IssueAdmin)
     else:
-        data = {'list_display': cls.ADMIN_LIST_FIELDS + ('updated_by', 'last_updated')}
-        admin_cls = type(name + 'Admin', (BaseAdmin,), data)
+        data = {"list_display": cls.ADMIN_LIST_FIELDS + ("updated_by", "last_updated")}
+        admin_cls = type(name + "Admin", (BaseAdmin,), data)
         admin.site.register(cls, admin_cls)

data_management/apps.py

@@ -2,4 +2,4 @@
 
 
 class DataManagementConfig(AppConfig):
-    name = 'data_management'
+    name = "data_management"

data_management/management/commands/_example_data.py

@@ -787,26 +787,26 @@ def init_db():
 
     namespace_1 = Namespace.objects.get_or_create(
         name="PSU",
-        full_name = "Pennsylvania State University",
-        defaults={'website': 'https://ror.org/04p491231', 'updated_by' : user},
+        full_name="Pennsylvania State University",
+        defaults={"website": "https://ror.org/04p491231", "updated_by": user},
     )[0]
 
     namespace_2 = Namespace.objects.get_or_create(
         name="user_1",
-        full_name = 'Example user 1', 
-        defaults={'updated_by' : user},
+        full_name="Example user 1",
+        defaults={"updated_by": user},
     )[0]
 
     namespace_3 = Namespace.objects.get_or_create(
         name="user_3",
-        full_name = "Example user 3",
-        defaults={'updated_by' : user},
+        full_name="Example user 3",
+        defaults={"updated_by": user},
     )[0]
 
     namespace_4 = Namespace.objects.get_or_create(
         name="user_4",
-        full_name = "Example user 4",
-        defaults={'updated_by' : user},
+        full_name="Example user 4",
+        defaults={"updated_by": user},
     )[0]
 
     data_product_1 = DataProduct.objects.get_or_create(

data_management/management/commands/get_token.py

@@ -1,12 +1,13 @@
-import os 
+import os
 
 from django.core.management.base import BaseCommand
 from django.contrib.auth import get_user_model
 from rest_framework.authtoken.models import Token
 
+
 class Command(BaseCommand):
     def handle(self, **options):
         user_model = get_user_model()
-        user = user_model.objects.get_by_natural_key('admin')
+        user = user_model.objects.get_by_natural_key("admin")
         token = Token.objects.get_or_create(user=user)
         print(token[0])

data_management/management/commands/set_site_info.py

@@ -4,15 +4,14 @@
 from data_management import settings as dm_settings
 from django.contrib.sites.models import Site
 
-from data_management.models import (
-    StorageRoot
-)
+from data_management.models import StorageRoot
 from django.contrib.auth import get_user_model
 
+
 class Command(BaseCommand):
     def handle(self, **options):
         if settings.DOMAIN_URL:
-            domain = re.sub(r'http.*:\/\/', "", settings.DOMAIN_URL)
+            domain = re.sub(r"http.*:\/\/", "", settings.DOMAIN_URL)
             if domain[-1] == "/":
                 domain = domain.rstrip(domain[-1])
             this_site = Site.objects.all()[0]
@@ -26,10 +25,8 @@ def handle(self, **options):
                     domain_url = settings.DOMAIN_URL
                     if domain_url[-1] != "/":
                         domain_url += "/"
-                    root = f'{settings.DOMAIN_URL}data/'
+                    root = f"{settings.DOMAIN_URL}data/"
                     StorageRoot.objects.create(
                         updated_by=user,
                         root=root,
                     )
-
-