add example app

Author: Ahmed Ibrahim

example/core/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

example/core/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class CoreConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "core"

example/core/apps.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.2 on 2023-04-26 02:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="Human",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=128)),
+                (
+                    "level",
+                    models.IntegerField(
+                        choices=[(0, "Beginner"), (1, "Intermediate"), (2, "Advanced")]
+                    ),
+                ),
+                (
+                    "military_status",
+                    models.CharField(
+                        choices=[
+                            ("exempted", "Exempted"),
+                            ("served", "Served"),
+                            ("postponed", "Postponed"),
+                        ],
+                        max_length=128,
+                    ),
+                ),
+            ],
+        ),
+    ]

example/core/migrations/0001_initial.py

@@ -0,0 +1,17 @@
+from django.db import models
+
+
+class Human(models.Model):
+    class Level(models.IntegerChoices):
+        BEGINNER = 0
+        INTERMEDIATE = 1
+        ADVANCED = 2
+
+    class MilitaryStatus(models.TextChoices):
+        EXEMPTED = "exempted", "Exempted"
+        SERVED = "served", "Served"
+        POSTPONED = "postponed", "Postponed"
+
+    name = models.CharField(max_length=128)
+    level = models.IntegerField(choices=Level.choices)
+    military_status = models.CharField(choices=MilitaryStatus.choices, max_length=128)

example/core/migrations/__init__.py

@@ -0,0 +1,18 @@
+from rest_framework import serializers
+
+from django_rest_commons import EnumSerializer
+
+from . import models
+
+
+class HumanSerializer(serializers.ModelSerializer):
+    level = EnumSerializer(enum=models.Human.Level)
+    military_status = EnumSerializer(enum=models.Human.MilitaryStatus)
+
+    class Meta:
+        model = models.Human
+        fields = [
+            "id",
+            "level",
+            "military_status",
+        ]

example/core/models.py

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

example/core/serializers.py

@@ -0,0 +1,17 @@
+from rest_framework.permissions import IsAdminUser, IsAuthenticated
+
+from django_rest_commons import ModelViewSet
+
+from .models import Human
+from .serializers import HumanSerializer
+
+
+class HumanViewSet(ModelViewSet):
+    queryset = Human.objects.all()
+    serializer_class = HumanSerializer
+
+    permission_classes_create = [IsAdminUser]
+    permission_classes_destroy = [IsAdminUser]
+    permission_classes_update = [IsAdminUser]
+    permission_classes_list = [IsAuthenticated]
+    permission_classes_retrieve = [IsAuthenticated]

example/core/tests.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "dummy.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()