Models created: User, Project, Annotation, Comment, Label, Task

Author: IoannisSina

.gitignore

@@ -0,0 +1,3 @@
+bin/
+lib/
+*.pyc

label_buddy/annotations/__init__.py

@@ -0,0 +1,7 @@
+from django.contrib import admin
+
+#relative import
+from .models import Comment, Annotation
+
+admin.site.register(Comment)
+admin.site.register(Annotation)

label_buddy/annotations/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AnnotationsConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'annotations'

label_buddy/annotations/apps.py

@@ -0,0 +1,25 @@
+# Generated by Django 3.2.3 on 2021-06-03 10:48
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('users', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Comment',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('comment', models.TextField(help_text='Comment for an annotation')),
+                ('created_at', models.DateTimeField(auto_now=True, help_text='Date and time of comment creation')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='users.user')),
+            ],
+        ),
+    ]

label_buddy/annotations/migrations/0001_initial.py

@@ -0,0 +1,34 @@
+# Generated by Django 3.2.3 on 2021-06-03 10:49
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tasks', '0001_initial'),
+        ('users', '0001_initial'),
+        ('projects', '0001_initial'),
+        ('annotations', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Annotation',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('created_at', models.DateTimeField(auto_now=True, help_text='Date and time of annotation creation')),
+                ('updated_at', models.DateTimeField(help_text='Date and time of update')),
+                ('result', models.JSONField()),
+                ('reviewed_at', models.DateTimeField(blank=True, help_text='Date and time of a review')),
+                ('rejected_by_user', models.BooleanField(default=False)),
+                ('hidden_by_user', models.BooleanField(default=False)),
+                ('comment', models.ManyToManyField(blank=True, related_name='annotation_comment', to='annotations.Comment')),
+                ('project', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='projects.project')),
+                ('reviewed_by', models.ForeignKey(blank=True, on_delete=django.db.models.deletion.CASCADE, related_name='annotation_reviewer', to='users.user')),
+                ('task', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='tasks.task')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='annotation_user', to='users.user')),
+            ],
+        ),
+    ]

label_buddy/annotations/migrations/0002_annotation.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.3 on 2021-06-03 10:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('annotations', '0002_annotation'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='annotation',
+            name='result',
+            field=models.JSONField(null=True),
+        ),
+    ]

label_buddy/annotations/migrations/0003_alter_annotation_result.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.3 on 2021-06-03 10:59
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('annotations', '0003_alter_annotation_result'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='annotation',
+            name='result',
+            field=models.JSONField(blank=True, null=True),
+        ),
+    ]

label_buddy/annotations/migrations/0004_alter_annotation_result.py

@@ -0,0 +1,18 @@
+# Generated by Django 3.2.3 on 2021-06-03 11:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('annotations', '0004_alter_annotation_result'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='annotation',
+            name='reviewed_at',
+            field=models.DateTimeField(blank=True, help_text='Date and time of a review', null=True),
+        ),
+    ]

label_buddy/annotations/migrations/0005_alter_annotation_reviewed_at.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.2.3 on 2021-06-03 11:01
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('users', '0001_initial'),
+        ('annotations', '0005_alter_annotation_reviewed_at'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='annotation',
+            name='reviewed_by',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='annotation_reviewer', to='users.user'),
+        ),
+    ]

label_buddy/annotations/migrations/0006_alter_annotation_reviewed_by.py

@@ -0,0 +1,44 @@
+from django.db import models
+
+from users.models import User
+from tasks.models import Task
+from projects.models import Project
+
+# Create your models here.
+
+class Comment(models.Model):
+
+    '''
+    Comment class for comments done by reviewers
+    Annotators will be able to see the comments on their annotations
+    '''
+
+    comment = models.TextField(blank=False, help_text='Comment for an annotation')
+    user = models.ForeignKey(User, on_delete=models.CASCADE, blank=False)
+    created_at = models.DateTimeField(auto_now=True, help_text='Date and time of comment creation')
+
+
+class Annotation(models.Model):
+
+    '''
+    Annotation class for annotations done by annotators
+    Annotation format will be in JSON format
+    '''
+
+    task = models.ForeignKey(Task, on_delete=models.CASCADE, blank=False)                                   #task to which the annotation belongs
+    project = models.ForeignKey(Project, on_delete=models.CASCADE, blank=False)                             #project to which the annotation belongs
+    user = models.ForeignKey(User, on_delete=models.CASCADE, blank=False, related_name='annotation_user')   #user who annotated
+
+    created_at = models.DateTimeField(auto_now=True, help_text='Date and time of annotation creation')
+    updated_at = models.DateTimeField(blank=False, help_text='Date and time of update')
+
+    result = models.JSONField(blank=True, null=True)
+
+    reviewed_by = models.ForeignKey(User, on_delete=models.CASCADE, blank=True, null=True, related_name='annotation_reviewer')
+    reviewed_at = models.DateTimeField(blank=True, null=True, help_text='Date and time of a review')
+
+    rejected_by_user = models.BooleanField(default=False)
+    hidden_by_user = models.BooleanField(default=False)
+
+    comment = models.ManyToManyField(Comment, blank=True, related_name='annotation_comment')
+

label_buddy/annotations/migrations/__init__.py

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

label_buddy/annotations/models.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

label_buddy/annotations/tests.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for label_buddy project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'label_buddy.settings')
+
+application = get_asgi_application()

label_buddy/annotations/views.py

@@ -0,0 +1,135 @@
+"""
+Django settings for label_buddy project.
+
+Generated by 'django-admin startproject' using Django 3.2.3.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/3.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/3.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'django-insecure-!(7v*kvxyuj+ldou)*6xy5)a%w*z=0&_%yw$t9l0e^oxo50*+-'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+
+    #third party
+    'colorfield',
+    'url_or_relative_url_field',
+
+    #own
+    'users',
+    'projects',
+    'tasks',
+    'annotations',
+]
+
+MIDDLEWARE = [
+    'django.middleware.security.SecurityMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+]
+
+ROOT_URLCONF = 'label_buddy.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'label_buddy.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/3.2/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': BASE_DIR / 'db.sqlite3',
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
+    },
+    {
+        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/3.2/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/3.2/howto/static-files/
+
+STATIC_URL = '/static/'
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

label_buddy/db.sqlite3

@@ -0,0 +1,21 @@
+"""label_buddy URL Configuration
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/3.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path('admin/', admin.site.urls),
+]