chore:migrate to django_ckeditor_5

Dockerfile

@@ -18,9 +18,10 @@ RUN apt-get update && apt-get install --no-install-recommends -y \
 
 
 ENV PYTHONUNBUFFERED=1 \
-    PYTHONDONTWRITEBYTECODE=1 \
     CODE_PATH="/code" \
-    VENV_PATH="/code/.venv"
+    VENV_PATH="/code/.venv" \
+    UV_COMPILE_BYTECODE=1 \
+    UV_LINK_MODE=copy
 
 FROM python-base AS builder
 

context/migrations/0001_initial.py

@@ -1,6 +1,5 @@
-# Generated by Django 3.2 on 2021-05-20 07:32
+# Generated by Django 4.2.17 on 2025-01-14 09:53
 
-from django.conf import settings
 from django.db import migrations, models
 import django.db.models.deletion
 
@@ -10,28 +9,25 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
         migrations.CreateModel(
             name='Context',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('created_at', models.DateTimeField(auto_now_add=True)),
-                ('modified_at', models.DateTimeField(auto_now=True)),
-                ('code', models.CharField(max_length=10, unique=True)),
                 ('order', models.PositiveIntegerField(db_index=True, editable=False, verbose_name='order')),
-                ('title', models.CharField(max_length=255)),
-                ('title_en', models.CharField(max_length=255, null=True)),
-                ('title_es', models.CharField(max_length=255, null=True)),
-                ('title_fr', models.CharField(max_length=255, null=True)),
-                ('description', models.TextField()),
-                ('description_en', models.TextField(null=True)),
-                ('description_es', models.TextField(null=True)),
-                ('description_fr', models.TextField(null=True)),
-                ('created_by', models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
-                ('updated_by', models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='created at')),
+                ('modified_at', models.DateTimeField(auto_now=True, verbose_name='modified at')),
+                ('code', models.CharField(max_length=50, unique=True, verbose_name='code')),
+                ('title', models.CharField(max_length=255, verbose_name='title')),
+                ('title_en', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('title_es', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('title_fr', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('description', models.TextField(verbose_name='description')),
+                ('description_en', models.TextField(null=True, verbose_name='description')),
+                ('description_es', models.TextField(null=True, verbose_name='description')),
+                ('description_fr', models.TextField(null=True, verbose_name='description')),
             ],
             options={
                 'ordering': ('order',),
@@ -42,21 +38,20 @@ class Migration(migrations.Migration):
             name='Module',
             fields=[
                 ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
-                ('created_at', models.DateTimeField(auto_now_add=True)),
-                ('modified_at', models.DateTimeField(auto_now=True)),
-                ('code', models.CharField(max_length=10, unique=True)),
                 ('order', models.PositiveIntegerField(db_index=True, editable=False, verbose_name='order')),
-                ('title', models.CharField(max_length=255)),
-                ('title_en', models.CharField(max_length=255, null=True)),
-                ('title_es', models.CharField(max_length=255, null=True)),
-                ('title_fr', models.CharField(max_length=255, null=True)),
-                ('description', models.TextField()),
-                ('description_en', models.TextField(null=True)),
-                ('description_es', models.TextField(null=True)),
-                ('description_fr', models.TextField(null=True)),
-                ('context', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='modules', to='context.context')),
-                ('created_by', models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
-                ('updated_by', models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL)),
+                ('created_at', models.DateTimeField(auto_now_add=True, verbose_name='created at')),
+                ('modified_at', models.DateTimeField(auto_now=True, verbose_name='modified at')),
+                ('code', models.CharField(max_length=50, unique=True, verbose_name='code')),
+                ('title', models.CharField(max_length=255, verbose_name='title')),
+                ('title_en', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('title_es', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('title_fr', models.CharField(max_length=255, null=True, verbose_name='title')),
+                ('description', models.TextField(verbose_name='description')),
+                ('description_en', models.TextField(null=True, verbose_name='description')),
+                ('description_es', models.TextField(null=True, verbose_name='description')),
+                ('description_fr', models.TextField(null=True, verbose_name='description')),
+                ('question_completion_time', models.DurationField(blank=True, default=None, null=True, verbose_name='estimated time to complete question')),
+                ('context', models.ForeignKey(on_delete=django.db.models.deletion.PROTECT, related_name='modules', to='context.context', verbose_name='context')),
             ],
             options={
                 'ordering': ('order',),

context/migrations/0002_initial.py

@@ -0,0 +1,38 @@
+# Generated by Django 4.2.17 on 2025-01-14 09:53
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('context', '0001_initial'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='module',
+            name='created_by',
+            field=models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL, verbose_name='created by'),
+        ),
+        migrations.AddField(
+            model_name='module',
+            name='updated_by',
+            field=models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL, verbose_name='updated by'),
+        ),
+        migrations.AddField(
+            model_name='context',
+            name='created_by',
+            field=models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL, verbose_name='created by'),
+        ),
+        migrations.AddField(
+            model_name='context',
+            name='updated_by',
+            field=models.ForeignKey(blank=True, default=None, editable=False, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='+', to=settings.AUTH_USER_MODEL, verbose_name='updated by'),
+        ),
+    ]

docker/entrypoint.dev.sh

@@ -12,6 +12,7 @@ then
     fi
 else
     uv run manage.py collectstatic --no-input
+    uv run manage.py makemigrations
     uv run manage.py migrate --no-input
     uv run manage.py import_default_email_template
     uv run manage.py runserver_plus 0.0.0.0:8000 || uv run manage.py runserver 0.0.0.0:8000

neatplus/serializers.py

@@ -1,4 +1,3 @@
-from ckeditor_uploader.fields import RichTextUploadingField
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.utils.translation import gettext_lazy as _
@@ -7,8 +6,6 @@
 from rest_framework.fields import CharField
 from rest_framework_simplejwt.serializers import TokenObtainPairSerializer
 
-CKEDITOR_LOCATION = f"/{settings.MEDIA_LOCATION}/{settings.CKEDITOR_UPLOAD_PATH}"
-ORIGINAL_TEXT = f'src="{CKEDITOR_LOCATION}'
 
 UserModel = get_user_model()
 
@@ -48,26 +45,6 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
 
 
-class RichTextUploadingSerializerField(CharField):
-    def to_representation(self, value):
-        data = super().to_representation(value)
-        if not settings.USE_S3_STORAGE:
-            replace_text = ORIGINAL_TEXT.replace(
-                CKEDITOR_LOCATION,
-                self.context["request"].build_absolute_uri(CKEDITOR_LOCATION),
-            )
-            data = data.replace(ORIGINAL_TEXT, replace_text)
-        return data
-
-
-class RichTextUploadingModelSerializer(serializers.ModelSerializer):
-    def __init__(self, *args, **kwargs):
-        self.serializer_field_mapping[RichTextUploadingField] = (
-            RichTextUploadingSerializerField
-        )
-        super().__init__(*args, **kwargs)
-
-
 class TokenObtainPairDefenderSerializer(TokenObtainPairSerializer):
     def validate(self, attrs):
         from defender import config as defender_config