11 |
14 | {% endblock %}
15 |
--------------------------------------------------------------------------------
/label_buddy/label_buddy/asgi.py:
--------------------------------------------------------------------------------
1 | """
2 | ASGI config for label_buddy project.
3 |
4 | It exposes the ASGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.2/howto/deployment/asgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.asgi import get_asgi_application
13 |
14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'label_buddy.settings')
15 |
16 | application = get_asgi_application()
17 |
--------------------------------------------------------------------------------
/label_buddy/label_buddy/wsgi.py:
--------------------------------------------------------------------------------
1 | """
2 | WSGI config for label_buddy project.
3 |
4 | It exposes the WSGI callable as a module-level variable named ``application``.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.2/howto/deployment/wsgi/
8 | """
9 |
10 | import os
11 |
12 | from django.core.wsgi import get_wsgi_application
13 |
14 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'label_buddy.settings')
15 |
16 | application = get_wsgi_application()
17 |
--------------------------------------------------------------------------------
/label_buddy/static/js/index.js:
--------------------------------------------------------------------------------
1 | $(document).ready(function(){
2 | $('.clickable-row td:last-child').click(function(e){
3 | e.stopPropagation()
4 | });
5 | $(".clickable-row td:last-child").on({
6 | mouseenter: function () {
7 | document.getElementById('index-table').classList.remove("table-hover");
8 | },
9 | mouseleave: function () {
10 | document.getElementById('index-table').classList.add("table-hover");
11 | }
12 | });
13 | });
14 |
--------------------------------------------------------------------------------
/label_buddy/tasks/serializers.py:
--------------------------------------------------------------------------------
1 | from rest_framework import serializers
2 | from .models import Task
3 |
4 |
5 | class TaskSerializer(serializers.ModelSerializer):
6 |
7 | """
8 | Serializer for task API endpoint data.
9 | """
10 |
11 | class Meta:
12 | model = Task
13 | fields = [
14 | "project",
15 | "file",
16 | "url",
17 | "extra",
18 | "status",
19 | "review_status",
20 | "assigned_to",
21 | ]
22 |
--------------------------------------------------------------------------------
/label_buddy/templates/account/verification_sent.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% load i18n %}
4 |
5 | {% block title %} ◦ Verify Your E-mail Address {% endblock %}
6 |
7 | {% block content %}
8 | {{ block.super }}
9 |
{% trans "Verify Your E-mail Address" %}
10 |
11 |
{% blocktrans %}We have sent an e-mail to you for verification. Follow the link provided to finalize the signup process. Please contact us if you do not receive it within a few minutes.{% endblocktrans %}
13 | Projects shown in this page are projects which you are involved to.
14 | You must be manager, annotator or reviewer for the project in order to enter it.
15 |
16 |
17 |
18 |
19 |
--------------------------------------------------------------------------------
/label_buddy/projects/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 |
3 | # Relative import
4 | from .models import Project, Label
5 |
6 |
7 | # Admin now has filters and search
8 | class ProjectAmdin(admin.ModelAdmin):
9 |
10 | """
11 | Project class for the admin site. list_display shows the fields
12 | displayed in the admin site.
13 | """
14 |
15 | search_fields = ["title"]
16 | list_display = ["id", "title", "created_at", "users_can_see_other_queues", "project_type"]
17 | ordering = ("created_at",)
18 | list_filter = ["users_can_see_other_queues", "project_type"]
19 |
20 |
21 | class LabelAdmin(admin.ModelAdmin):
22 |
23 | """
24 | Label class for the admin site. list_display shows the fields
25 | displayed in the admin site.
26 | """
27 |
28 | list_display = ["name", "parent"]
29 |
30 |
31 | admin.site.register(Project, ProjectAmdin)
32 | admin.site.register(Label, LabelAdmin)
33 |
--------------------------------------------------------------------------------
/label_buddy/templates/account/verified_email_required.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% load i18n %}
4 |
5 |
6 | {% block title %} ◦ Verify Your E-mail Address {% endblock %}
7 |
8 | {% block content %}
9 | {{ block.super }}
10 |
{% blocktrans %}This part of the site requires us to verify that
15 | you are who you claim to be. For this purpose, we require that you
16 | verify ownership of your e-mail address. {% endblocktrans %}
17 |
18 |
{% blocktrans %}We have sent an e-mail to you for
19 | verification. Please click on the link inside this e-mail. Please
20 | contact us if you do not receive it within a few minutes.{% endblocktrans %}
13 | Annotations shown below are either already reviewed by you or are unreviewed.
14 | Annotations reviewed by other reviewers are not showed here. If a reviewer deletes his/her review
15 | for an annotation, then you will be able to review it.
16 |
17 |
18 |
19 |
20 |
--------------------------------------------------------------------------------
/label_buddy/users/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 | from django.contrib.auth.models import Group
3 |
4 | # Relative import
5 | from .models import User
6 |
7 |
8 | class UsersAdmin(admin.ModelAdmin):
9 |
10 | """
11 | User class for the admin site. list_display shows the fields
12 | displayed in the admin site.
13 | """
14 |
15 | search_fields = ["email", "username"]
16 | exclude = (
17 | "user_permissions",
18 | "title",
19 | "groups",
20 | "password",
21 | "last_login",
22 | "is_featured",
23 | "location",
24 | "media_count",
25 | "is_active",
26 | )
27 | list_display = [
28 | "id",
29 | "name",
30 | "username",
31 | "email",
32 | "first_name",
33 | "last_name",
34 | "can_create_projects",
35 | "phone_number",
36 | "avatar",
37 | "date_joined",
38 | ]
39 | list_filter = ["can_create_projects", ]
40 | ordering = ("id",)
41 |
42 |
43 | admin.site.register(User, UsersAdmin)
44 | admin.site.unregister(Group) # Remove groups from admin
45 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2021 GFOSS - Open Technologies Alliance (Οργανισμός Ανοιχτών Τεχνολογιών - EEΛΛΑΚ)
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/label_buddy/templates/account/password_change.html:
--------------------------------------------------------------------------------
1 | {% extends 'base.html' %}
2 |
3 | {% load crispy_forms_tags %}
4 |
5 | {% block title %} ◦ Change Password{% endblock %}
6 |
7 | {% block breadcrumbs %}
8 |
9 |
{% if token_fail %}{% trans "Bad Token" %}{% else %}{% trans "Change Password" %}{% endif %}
15 |
16 | {% if token_fail %}
17 | {% url 'account_reset_password' as passwd_reset_url %}
18 |
{% blocktrans %}The password reset link was invalid, possibly because it has already been used. Please request a new password reset.{% endblocktrans %}
19 | {% else %}
20 | {% if form %}
21 |
26 | {% else %}
27 |
{% blocktrans with confirmation.email_address.email as email %} Please confirm that {{ email }} is an e-mail address for user {{ user_display }}.{% endblocktrans %}
{% blocktrans %}This e-mail confirmation link expired or is invalid. Please issue a new e-mail confirmation request. You will be redirected to login page in 5 seconds.{% endblocktrans %}
13 | Inspect the annotation completed by the user. Leave a comment in the corresponding
14 | field and submit you review.
15 |
16 | Approve annotation if you did not find any wrong labels.
17 | Delete you review (if already exists) by clicking the delete button.
18 | Reject annotation if there is a labeld tagged which does not make sense. Let
19 | the annotator know the regions that should be modified. Once the annotator updates the annotation you will be able
20 | to review it again.
21 |
13 | Select a label and drug on the waveform in order to create a region. The region created will be labeled with
14 | the selected label and you will be able to see the region's starting and ending point to the left of your screen.
15 | You can delete or play selected regions by clicking on them and after clicking the play/delete buttons which appear under
16 | the waveform.
17 | Save your annotation by clicking the Save button.
18 | View the comment (if review exists) of the reviewer by clicking the Review button
19 | Delete your annotation (if exists) by clicking the Delete button.
20 | Click Next to start annotating the next unlabeled task.
21 |
22 |
23 |
24 |
25 |
26 |
Projects instructions
27 |
28 |
29 |
30 | {{ project.instructions }}
31 |
32 |
33 |
34 |
--------------------------------------------------------------------------------
/label_buddy/users/password_validators.py:
--------------------------------------------------------------------------------
1 | import re
2 |
3 | from django.core.exceptions import ValidationError
4 | from django.utils.translation import ugettext as _
5 |
6 |
7 | class NumberValidator(object):
8 |
9 | """
10 | Custom password validator which ensures that the password will contain
11 | at least 1 digit.
12 | """
13 |
14 | def validate(self, password, user=None):
15 | if not re.findall('\\d', password):
16 | raise ValidationError(
17 | _("The password must contain at least 1 digit, 0-9."),
18 | code='password_no_number',
19 | )
20 |
21 | def get_help_text(self):
22 | return _(
23 | "Your password must contain at least 1 digit, 0-9."
24 | )
25 |
26 |
27 | class UppercaseValidator(object):
28 |
29 | """
30 | Custom password validator which ensures that the password will contain
31 | at least 1 uppercase letter, A-Z.
32 | """
33 |
34 | def validate(self, password, user=None):
35 | if not re.findall('[A-Z]', password):
36 | raise ValidationError(
37 | _("The password must contain at least 1 uppercase letter, A-Z."),
38 | code='password_no_upper',
39 | )
40 |
41 | def get_help_text(self):
42 | return _(
43 | "Your password must contain at least 1 uppercase letter, A-Z."
44 | )
45 |
46 |
47 | class SymbolValidator(object):
48 |
49 | """
50 | Custom password validator which ensures that the password will contain
51 | at least 1 symbol.
52 | """
53 |
54 | def validate(self, password, user=None):
55 | if not re.findall('[()[\\]{}|\\`~!@#$%^&*_\\-+=;:\'",<>./?]', password):
56 | raise ValidationError(
57 | _("The password must contain at least 1 symbol: " + "()[]{}|\\`~!@#$%^&*_-+=;:'\",<>./?"), code='password_no_symbol',)
58 |
59 | def get_help_text(self):
60 | return _(
61 | "Your password must contain at least 1 symbol: " + "()[]{}|\\`~!@#$%^&*_-+=;:'\",<>./?")
62 |
--------------------------------------------------------------------------------
/label_buddy/templates/label_buddy/delete_task.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% load static %}
4 |
5 | {% block head_files %}
6 | {{ block.super }}
7 |
8 | {% endblock %}
9 |
10 | {% block title %} ◦ Delete task {% endblock %}
11 |
12 | {% block breadcrumbs %}
13 |
14 |
32 | Optimally you can upload a .zip file containing of accepted format files. Any other formats will be ignored.
33 | {% if not project.users_can_see_other_queues %}
34 |
35 | Tasks uploaded for this project will be assigned to a random annotator and only him/her will be able to annotate them.
36 | {% endif %}
37 |
{% trans 'The following e-mail addresses are associated with your account:' %}
28 |
29 |
65 |
66 | {% else %}
67 |
68 |
{% trans 'Warning:'%} {% trans "You currently do not have any e-mail address set up. You should really add an e-mail address so you can receive notifications, reset your password, etc." %}
69 |
70 | {% endif %}
71 |
72 |
73 |
{% trans "Add E-mail Address" %}
74 |
75 |
80 |
81 | {% endblock %}
82 |
83 |
84 |
85 | {% block extra_body %}
86 |
99 | {% endblock %}
100 | {% endcomment %}
101 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Google Summer of Code with GFOSS :sun_with_face:
2 |
3 | **Project:** Creation of a multi user audio first annotation tool
4 |
5 | **Mentors:** Pantelis Vikatos, Markos Gogoulos
6 |
7 | **Student:** Ioannis Sina
8 |
9 | # Introduction
10 |
11 | An annotation tool helps people (without the need for specific knowledge) to mark a segment of an audio file (waveform), an image or text etc. in order to specify the segment’s properties. Annotation tools are used in machine learning applications such as Natural Language Processing (NLP) and Object Detection in order to train machines to identify objects or text. While there is a variety of annotation tools, most of them lack the multi-user feature (multiple users annotating a single project simultaneously) whose implementation is planned in this project. The audio annotation process is usually tedious and time consuming therefore, these tools (annotation tools which provide the multi-user feature) are necessary in order to reduce the effort needed as well as to enhance the quality of annotations. Since in most tasks related to audio classification, speech recognition, music detection etc., machine and deep learning models are trained and evaluated with the use audio that has previously been annotated by humans, the implementation of such a tool will lead to higher accuracy of annotated files, as they will have been annotated by more than one human, providing a more reliable dataset. In effect, multi-user annotation will reduce the possibility of human error e.g. an occasional mistaken labelling of a segment might be pointed out by another annotator.
12 |
13 | **Already existing annotation tools:**
14 |
15 | Label Studio: https://github.com/heartexlabs/label-studio
16 |
17 | BAT annotation tool: https://github.com/BlaiMelendezCatalan/BAT
18 |
19 | Computer Vision Annotation Tool (CVAT): https://github.com/openvinotoolkit/cvat
20 |
21 | # Project goals :dart:
22 |
23 | We will try to develop a web application (audio annotation tool) which will provide the multi-user feature and a pleasant UI for users. There will be three distinct types of users in the application: Managers, Annotators and Reviewers.
24 |
25 | **Managers will:**
26 |
27 | * Create projects and edit their configurations (title, annotators for each project etc.)
28 | * Upload audio files (links, csv of links or local files) for each project created
29 | * Add/edit labels (labels are used by annotators in order to mark segments of an audio file)
30 | * Assign roles to users (specify who will be annotator or reviewer)
31 | * Export annotations in JSON or CSV format
32 |
33 | **Reviewers will:**
34 |
35 | * See all annotations done by annotators
36 | * Set annotations as approved or rejected
37 | * Add comments to annotations done
38 |
39 | **Annotators will:**
40 |
41 | * Annotate audio files (tasks) assigned to them (by managers)
42 | * Update annotations
43 | * Submit tasks as annotated
44 |
45 | # Steps to run
46 |
47 | Clone repository and cd to the folder
48 | ~~~
49 | git clone https://github.com/eellak/gsoc2021-audio-annotation-tool/
50 | cd gsoc2021-audio-annotation-tool
51 | ~~~
52 |
53 | Create virtual enviroment
54 | ~~~
55 | python3 -m venv env
56 | ~~~
57 |
58 | Activate it for **Linux**
59 | ~~~
60 | source env/bin/activate
61 | ~~~
62 |
63 | Activate it for **Windows**
64 | ~~~
65 | env\Scripts\activate
66 | ~~~
67 |
68 | Install requirements and cd to label_buddy/
69 | ~~~
70 | pip install -r requirements.txt
71 | cd label_buddy
72 | ~~~
73 |
74 | Make migrations for the Database and all dependencies
75 | ~~~
76 | python manage.py makemigrations users projects tasks
77 | python manage.py migrate
78 | ~~~
79 |
80 | After the above process create a super user and run server
81 | ~~~
82 | python manage.py createsuperuser
83 | python manage.py runserver
84 | ~~~
85 |
86 | Visit http://localhost:8000/admin, navigate to users/[your user] and set can_create_projects to true so you can start creating projects.
87 |
88 | Visit https://labelbuddy.io/ and sign with the following credentials:
89 |
90 | - **Username**: demo
91 | - **Password**: labelbuddy123
92 |
93 | in order to create projects, upload files and annotate them.
94 |
--------------------------------------------------------------------------------
/label_buddy/users/views.py:
--------------------------------------------------------------------------------
1 | from django.shortcuts import render
2 | from django.contrib.auth.decorators import login_required
3 | from django.http import HttpResponseRedirect
4 | from django.contrib import messages
5 |
6 | from rest_framework.response import Response
7 | from rest_framework.views import APIView
8 | from rest_framework.exceptions import PermissionDenied
9 | from rest_framework import (
10 | permissions,
11 | status,
12 | )
13 |
14 |
15 | from .models import User
16 | from .serializers import UserSerializer
17 | from .forms import UserForm
18 | # Create your views here
19 |
20 |
21 | def get_user(username):
22 |
23 | """
24 | Get user by username.
25 | """
26 |
27 | try:
28 | user = User.objects.get(username=username)
29 | return user
30 | except User.DoesNotExist:
31 | return None
32 |
33 |
34 | @login_required
35 | def edit_profile(request, username):
36 |
37 | """
38 | View for user edit profile. The user can update his/her information.
39 | """
40 |
41 | context = {}
42 | user = get_user(username)
43 | if not user or (user != request.user):
44 | return HttpResponseRedirect("/")
45 |
46 | if request.method == "POST":
47 | form = UserForm(request.POST, request.FILES, instance=user)
48 | if form.is_valid():
49 | new_user = form.save(commit=False)
50 | # Cannot change email
51 | new_user.email = user.email
52 | new_user.save()
53 | messages.add_message(request, messages.SUCCESS, "Successfully edited profile.")
54 | return HttpResponseRedirect("/")
55 | else:
56 | form = UserForm(instance=user)
57 | form.fields['email'].widget.attrs['readonly'] = True
58 |
59 | context["form"] = form
60 | return render(request, "label_buddy/user_edit_profile.html", context)
61 |
62 |
63 | # API VIEWS
64 | class UserList(APIView):
65 |
66 | """
67 | List all users or create a new one.
68 | """
69 |
70 | # User will be able to Post only if authenticated
71 | permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
72 | serializer_class = UserSerializer
73 |
74 | # Get request
75 | def get(self, request, format=None):
76 |
77 | users = User.objects.all()
78 | serializer = UserSerializer(users, many=True)
79 | return Response(serializer.data)
80 |
81 | # Post request
82 | def post(self, request, format=None):
83 | serializer = UserSerializer(data=request.data)
84 | if serializer.is_valid():
85 | serializer.save()
86 | return Response(serializer.data, status=status.HTTP_201_CREATED)
87 | return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
88 |
89 |
90 | class UserDetail(APIView):
91 |
92 | """
93 | Retrieve, update or delete a user instance.
94 | """
95 |
96 | # User will be able to Post only if authenticated
97 | permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
98 | serializer_class = UserSerializer
99 |
100 | def get_object(self, pk):
101 |
102 | try:
103 | return User.objects.get(pk=pk)
104 | except PermissionDenied:
105 | return Response({"detail": "No permissions"}, status=status.HTTP_401_UNAUTHORIZED)
106 | except User.DoesNotExist:
107 | return Response({"detail": "User does not exist"}, status=status.HTTP_400_BAD_REQUEST)
108 |
109 | def get(self, request, pk, format=None):
110 | user = self.get_object(pk)
111 | serializer = UserSerializer(user)
112 | if isinstance(user, Response):
113 | return user
114 |
115 | return Response(serializer.data)
116 |
117 | def put(self, request, pk, format=None):
118 | user = self.get_object(pk)
119 | serializer = UserSerializer(user, data=request.data)
120 | if serializer.is_valid():
121 | serializer.save()
122 | return Response(serializer.data)
123 | return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
124 |
125 | def delete(self, request, pk, format=None):
126 | user = self.get_object(pk)
127 | user.delete()
128 | return Response(status=status.HTTP_204_NO_CONTENT)
129 |
--------------------------------------------------------------------------------
/docs/user_manual.md:
--------------------------------------------------------------------------------
1 | # User manual
2 |
3 | User manual contains screenshots from Label Buddy. A brief explanation is given for every screenshot.
4 |
5 | ## 1. Login/Register
6 | Users can create an account for Label Buddy and Log in
7 |
8 | #### Login page
9 | 
10 |
11 | #### Register page
12 | 
13 |
14 | ## 2. Index page
15 | Users will be able to see all projects that they are involved in. A user is involved in a project if he/she is a manager an annotator or a reviewer
16 |
17 | #### Index page
18 | 
19 |
20 | ## 3. User creates project
21 | Users can (if they have the permission) create projects. User can specify all project's attributes like title, labels, annotators etc
22 |
23 | #### Project create page
24 | 
25 |
26 | ## 4. User edits project
27 | Users **who are managers** for the project can edit it
28 |
29 | #### Project edit page
30 | 
31 |
32 | ## 5. Add tasks to project
33 | Users who are managers for the project can import single audio files (.wav, .mp3 and .mp4) or .zip files containing accepted format files. Every audio file represent a task for the
34 | project which needs to be annotated
35 |
36 | #### Import data page
37 | 
38 |
39 | ## 6. List tasks for project
40 | Users can see tasks for annotation/review. Tasks displayed depend on the user's role in the project. Managers can see all task uploaded.
41 | Annotators can see only tasks assigned to them and reviewers can see all tasks in order to review them
42 |
43 | #### Project page **before** importing data
44 | 
45 |
46 | #### Project page **after** importing 10 audio files
47 | 
48 |
49 | ## 7. Annotate tasks for project
50 | Users who are annotators for the project will be able to annotate a task. They are able to drug and create regions on the waveform and label them with the project's labels
51 |
52 | #### Annotation page **before** creating an annotation
53 | 
54 |
55 | #### Annotation page **after** creating an annotation
56 | 
57 |
58 | ## 8. Review tasks for project
59 | Users who are reviewers for the project can comment an annotation and either Approve it or Reject it
60 |
61 | #### Review page **before** creating a review
62 | 
63 |
64 | #### Review page **after** creating a review
65 | 
66 |
67 | ## 9. Export annotations for project
68 | Managers are able to export all annotations completed for a project in JSON or CSV format. They can export either Approved annotations or all of them
69 |
70 | #### Export data page
71 | 
72 |
73 | ## Some other pages
74 |
75 | #### List annotations for reviewers to choose
76 | 
77 |
78 | #### Annotation page after annotation reviewed
79 | 
80 |
81 | #### User edit profile page
82 | 
83 |
84 |
--------------------------------------------------------------------------------
/label_buddy/users/forms.py:
--------------------------------------------------------------------------------
1 | from allauth.account.forms import SignupForm, LoginForm, ResetPasswordForm
2 | from django import forms
3 | from .models import User
4 |
5 |
6 | class ExtendedLogInForm(LoginForm):
7 |
8 | """
9 | An extended Log In form from Djano-allauth for adding custom styling.
10 | """
11 |
12 | def __init__(self, *args, **kwargs):
13 | super().__init__(*args, **kwargs)
14 | self.fields["login"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "Email or Username", 'autocomplete': "email"}
15 | self.fields["password"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "Password", 'autocomplete': "current-password"}
16 |
17 |
18 | class ExtendedSignUpForm(SignupForm):
19 |
20 | """
21 | An extended Sign up form from Djano-allauth for adding custom styling.
22 | """
23 |
24 | name = forms.CharField(max_length=256)
25 | ordered_field_names = ['name', 'email', 'username', 'password1']
26 |
27 | def __init__(self, *args, **kwargs):
28 | # Call the init of the parent class
29 | super().__init__(*args, **kwargs)
30 |
31 | self.fields["name"].widget.attrs = {'class': 'myInput form-control', 'placeholder': 'E.g. "John Anderson"', 'autocomplete': "name"}
32 | self.fields["name"].label = "First & Last Name"
33 |
34 | self.fields["email"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "E.g. JohnAnderson@mars.co", 'autocomplete': "email"}
35 | self.fields["email"].label = "Email Address*"
36 |
37 | self.fields["username"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "E.g. johnanderson", 'autocomplete': "username"}
38 | self.fields["username"].label = "Username*"
39 |
40 | self.fields["password1"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "Enter new password", 'autocomplete': "new-password"}
41 | self.fields["password1"].label = "Password*"
42 | self.rearrange_field_order()
43 |
44 | # Push error class if an error has occured
45 | for field in self:
46 | if field.errors:
47 | self.fields[field.name].widget.attrs["class"] += " error"
48 |
49 | def save(self, request):
50 |
51 | """
52 | Modify save method to save the name given by the user.
53 | """
54 |
55 | user = super(ExtendedSignUpForm, self).save(request)
56 | user.name = self.cleaned_data["name"]
57 | user.save()
58 | return user
59 |
60 | def rearrange_field_order(self):
61 |
62 | """
63 | Change the order that the fields are displayed in the Sign up page.
64 | """
65 |
66 | original_fields = self.fields
67 | new_fields = {}
68 |
69 | for field_name in self.ordered_field_names:
70 | field = original_fields.get(field_name)
71 | if field:
72 | new_fields[field_name] = field
73 |
74 | self.fields = new_fields
75 |
76 |
77 | class ExtendedResetPasswordForm(ResetPasswordForm):
78 |
79 | """
80 | An extended Reset password form from Djano-allauth for adding custom styling.
81 | """
82 |
83 | def __init__(self, *args, **kwargs):
84 | super().__init__(*args, **kwargs)
85 | self.fields["email"].widget.attrs = {'class': 'myInput form-control', 'placeholder': "JohnAnderson@mars.co", 'autocomplete': "email"}
86 | self.fields["email"].label = "Email*"
87 |
88 |
89 | class UserForm(forms.ModelForm):
90 |
91 | """
92 | User form for edit profile page.
93 | """
94 |
95 | class Meta:
96 | model = User
97 | fields = [
98 | "name",
99 | "email",
100 | "phone_number",
101 | "avatar",
102 | ]
103 | labels = {
104 | 'name': 'Name:',
105 | 'email': 'Email:',
106 | 'phone_number': 'Phone number:',
107 | 'avatar': 'Avatar:',
108 | }
109 |
110 | def clean_avatar(self):
111 |
112 | """
113 | Ensure that uploaded avatar is less than 2mb.
114 | """
115 |
116 | image = self.cleaned_data.get("avatar", False)
117 | if image:
118 | if image.size > 2 * 1024 * 1024:
119 | raise forms.ValidationError("Image file too large ( > 2mb )")
120 | return image
121 | else:
122 | raise forms.ValidationError("Please provide a logo")
123 |
124 | def clean_email(self):
125 |
126 | """
127 | User is not able to modify the email field in the edit profile page.
128 | """
129 |
130 | # When a field is cleaned, we always return the existing model field
131 | return self.instance.email
132 |
--------------------------------------------------------------------------------
/label_buddy/projects/models.py:
--------------------------------------------------------------------------------
1 | import os
2 |
3 | from django.conf import settings
4 | from django.core.files import File
5 | from django.db import models
6 | from django.db.models.signals import pre_save, pre_delete, post_save
7 | from django.dispatch import receiver
8 | from colorfield.fields import ColorField
9 | from enumchoicefield import ChoiceEnum, EnumChoiceField
10 |
11 | from users.models import User
12 | # Create your models here
13 |
14 |
15 | class Project_type(ChoiceEnum):
16 |
17 | """
18 | Enum class for project type (annotation of audio image or video files).
19 | """
20 |
21 | audio = "Audio annotation"
22 | image = "Image annoation"
23 | video = "Video annotation"
24 |
25 |
26 | class Label(models.Model):
27 |
28 | """
29 | Label class for labels created to annotate audio files.
30 | """
31 |
32 | name = models.CharField(max_length=256, blank=False, primary_key=True, help_text='Name of the label')
33 | parent = models.ForeignKey('self', on_delete=models.CASCADE, blank=True, null=True, related_name='children', help_text='Parent label of the label (optional)')
34 | color = ColorField(blank=True, unique=True, default='#74deed', help_text='Color given to the label (optional)')
35 |
36 | # How to display labels in admin
37 | def __str__(self):
38 | return '%s' % (self.name)
39 |
40 |
41 | class Project(models.Model):
42 |
43 | """
44 | Project class for projects created by managers (can_create_projects=True).
45 | Contains basic information about a specific project.
46 | """
47 |
48 | title = models.CharField(max_length=256, blank=True, null=True, default='', help_text='Project title')
49 |
50 | description = models.TextField(blank=True, null=True, default='', help_text='Project description')
51 | instructions = models.TextField(blank=True, null=True, default='', help_text='Project instructions')
52 | logo = models.ImageField(upload_to='images', blank=True, help_text='Project logo')
53 | created_at = models.DateTimeField(auto_now=True, help_text='Date and time of project creation')
54 |
55 | users_can_see_other_queues = models.BooleanField(default=False, help_text='If false, annotators will see only tasks assigned to them')
56 |
57 | labels = models.ManyToManyField(Label, blank=False, help_text='Labels used by annotators to annotate')
58 | reviewers = models.ManyToManyField(User, blank=True, related_name='project_reviewer', help_text='Reviewers who will review annotations')
59 | annotators = models.ManyToManyField(User, blank=True, related_name='project_annotator', help_text='Annotators for the project')
60 | managers = models.ManyToManyField(User, blank=True, related_name='project_manager', help_text='Managers for the project')
61 |
62 | project_type = EnumChoiceField(Project_type, default=Project_type.audio, help_text='Specify the type of the annotation (Audio, image or Video)')
63 |
64 | class Meta:
65 | ordering = ['id']
66 |
67 | # How to display projects in admin
68 | def __str__(self):
69 | return '%s' % (self.title)
70 |
71 |
72 | @receiver(pre_save, sender=Project)
73 | def auto_delete_logo_on_change(sender, instance, **kwargs):
74 |
75 | """
76 | Deletes old logo from filesystem when corresponding project object is updated with a new file.
77 | """
78 |
79 | pk = instance.pk
80 | if not pk:
81 | return False
82 |
83 | try:
84 | old_logo = Project.objects.get(pk=pk).logo
85 | except Project.DoesNotExist:
86 | return False
87 |
88 | if old_logo:
89 | new_logo = instance.logo
90 | if not old_logo == new_logo:
91 | if os.path.isfile(old_logo.path):
92 | os.remove(old_logo.path)
93 |
94 |
95 | @receiver(post_save, sender=Project)
96 | def set_project_title(sender, instance, created, **kwargs):
97 |
98 | """
99 | When a project's title is no set, set a default one
100 | """
101 |
102 | if created:
103 | title = instance.title
104 | if title:
105 | if title.strip() == "":
106 | instance.title = "Project #" + str(instance.id)
107 | else:
108 | instance.title = "Project #" + str(instance.id)
109 | instance.save()
110 |
111 |
112 | @receiver(pre_delete, sender=Project)
113 | def auto_delete_logo_on_delete(sender, instance, **kwargs):
114 |
115 | """
116 | Delete project's logo from system after delete.
117 | """
118 |
119 | try:
120 | project_logo = instance.logo
121 | except Project.DoesNotExist:
122 | return False
123 |
124 | if project_logo:
125 | if os.path.isfile(project_logo.path):
126 | os.remove(project_logo.path)
127 |
128 |
129 | @receiver(pre_save, sender=Project)
130 | def set_users_avatar(sender, instance, **kwargs):
131 |
132 | """
133 | If project's logo is not specified set it to the unknown icon project.
134 | """
135 |
136 | if not instance.logo:
137 | project_logo = open(os.path.join(settings.BASE_DIR, 'static/images/project_logo.png'), "rb")
138 | instance.logo.save('project_logo.png', File(project_logo))
139 |
--------------------------------------------------------------------------------
/label_buddy/tasks/helpers.py:
--------------------------------------------------------------------------------
1 | from users.models import User
2 | from .models import (
3 | Annotation,
4 | Task,
5 | Status,
6 | Comment,
7 | Annotation_status,
8 | )
9 |
10 |
11 | def get_user(username):
12 |
13 | """
14 | Get user by username.
15 | """
16 |
17 | try:
18 | user = User.objects.get(username=username)
19 | return user
20 | except User.DoesNotExist:
21 | return None
22 |
23 |
24 | def get_annotation(task, project, user):
25 |
26 | """
27 | Get annotation by task, project and user.
28 | """
29 |
30 | try:
31 | annotation = Annotation.objects.get(task=task, project=project, user=user)
32 | return annotation
33 | except Annotation.DoesNotExist:
34 | return None
35 |
36 |
37 | def get_review(annotation):
38 |
39 | """
40 | Get annotation's review (if exists).
41 | """
42 |
43 | try:
44 | review = Comment.objects.get(annotation=annotation)
45 | return review
46 | except Comment.DoesNotExist:
47 | return None
48 |
49 |
50 | def export_data(project, export_only_approved):
51 |
52 | """
53 | For all tasks of project which have been annotated result will be an array of dicts. Each dict will represent a task
54 | which will contain all annotation completed for this task.
55 | """
56 |
57 | exported_result = []
58 | skipped_annotations = 0
59 | # Get all annotated tasks of project
60 | annotated_tasks = Task.objects.filter(project=project, status=Status.labeled)
61 |
62 | for task in annotated_tasks:
63 | task_dict = {
64 | "id": task.id,
65 | "annotations": [],
66 | "file_upload": task.original_file_name,
67 | "data": {
68 | "audio": task.file.url,
69 | },
70 | "project_created_at": project.created_at.strftime("%Y-%m-%d %H:%M:%S"),
71 | "project": project.id,
72 | }
73 |
74 | task_annotations = Annotation.objects.filter(task=task, project=project)
75 |
76 | # For every annotation, push it
77 | for annotation in task_annotations:
78 | if export_only_approved:
79 | if annotation.review_status == Annotation_status.approved:
80 | annotation_user = annotation.user
81 | review = get_review(annotation)
82 | assert review is not None, "Annotation approved but not reviewed"
83 | annotation_dict = {
84 | "id": annotation.id,
85 | "completed_by": {
86 | "id": annotation_user.id,
87 | "username": annotation_user.username,
88 | "email": annotation_user.email,
89 | "name": annotation_user.name,
90 | },
91 | "reviewed_by": {} if not review else {
92 | "id": review.reviewed_by.id,
93 | "username": review.reviewed_by.username,
94 | "email": review.reviewed_by.email,
95 | "name": review.reviewed_by.name,
96 | "review_status": annotation.review_status.name,
97 | "review_created_at": review.created_at.strftime("%Y-%m-%d %H:%M:%S"),
98 | "review_updated_at": review.updated_at.strftime("%Y-%m-%d %H:%M:%S") if review.updated_at else "",
99 | },
100 | "result": annotation.result,
101 | "created_at": annotation.created_at.strftime("%Y-%m-%d %H:%M:%S"),
102 | "updated_at": annotation.updated_at.strftime("%Y-%m-%d %H:%M:%S") if annotation.updated_at else "",
103 | "task": task.id,
104 | }
105 | task_dict["annotations"].append(annotation_dict)
106 | else:
107 | skipped_annotations += 1
108 | else:
109 | annotation_user = annotation.user
110 | review = get_review(annotation)
111 | annotation_dict = {
112 | "id": annotation.id,
113 | "completed_by": {
114 | "id": annotation_user.id,
115 | "username": annotation_user.username,
116 | "email": annotation_user.email,
117 | "name": annotation_user.name,
118 | },
119 | "reviewed_by": {} if not review else {
120 | "id": review.reviewed_by.id,
121 | "username": review.reviewed_by.username,
122 | "email": review.reviewed_by.email,
123 | "name": review.reviewed_by.name,
124 | "review_status": annotation.review_status.name,
125 | "review_created_at": review.created_at.strftime("%Y-%m-%d %H:%M:%S"),
126 | "review_updated_at": review.updated_at.strftime("%Y-%m-%d %H:%M:%S") if review.updated_at else "",
127 | },
128 | "result": annotation.result,
129 | "created_at": annotation.created_at.strftime("%Y-%m-%d %H:%M:%S"),
130 | "updated_at": annotation.updated_at.strftime("%Y-%m-%d %H:%M:%S") if annotation.updated_at else "",
131 | "task": task.id,
132 | }
133 | task_dict["annotations"].append(annotation_dict)
134 |
135 | exported_result.append(task_dict)
136 | return exported_result, skipped_annotations
137 |
--------------------------------------------------------------------------------
/label_buddy/static/css/common.css:
--------------------------------------------------------------------------------
1 | @charset "UTF-8";
2 |
3 | :root {
4 | --basic_color: #007bff;
5 | }
6 |
7 | body {
8 | padding-bottom: 4%;
9 | }
10 |
11 | table
12 | {
13 | table-layout: fixed;
14 | width: 100px;
15 | }
16 |
17 | .footer-div {
18 | border-top: 1px solid white;
19 | color: #9595A6;
20 | }
21 |
22 | .myAction {
23 | /* border: 2px solid green; */
24 | text-align: right;
25 | }
26 |
27 | .myAction:after {
28 | content:'';
29 | display:block; /* or whatever else than inline */
30 | clear:both;
31 | }
32 |
33 | .user-form-wrap {
34 | background-color: rgb(245,245,245);
35 | padding: 3%;
36 | border-radius: 10px;
37 | margin: 2%;
38 | }
39 |
40 | #allauth-image {
41 | display:block;
42 | margin:auto;
43 | }
44 |
45 | .user-round-icon {
46 | background-color:rgb(245,245,245);
47 | }
48 |
49 | .my-button {
50 | width: 100px;
51 | background-color: var(--basic_color);
52 | }
53 |
54 | .accountHeaders {
55 | /* border: 2px solid red; */
56 | /* position: static; */
57 | width: 100%;
58 |
59 | font-family: Roboto;
60 | font-style: normal;
61 | font-weight: bold;
62 | font-size: 20px;
63 | align-items: center;
64 | text-align: center;
65 |
66 | /* Revised Colors/Dark Grey/650 */
67 |
68 | color: #232337;
69 | }
70 |
71 | .forms-labels {
72 | position: static;
73 | height: 17px;
74 |
75 | font-family: Roboto;
76 | font-style: normal;
77 | font-weight: 500;
78 | font-size: 13px;
79 | line-height: 140%;
80 | /* identical to box height, or 17px */
81 |
82 |
83 | color: #5C666B;
84 |
85 |
86 | /* Inside Auto Layout */
87 |
88 | flex: none;
89 | order: 0;
90 | flex-grow: 0;
91 | margin: 8px 0px;
92 | }
93 |
94 | .myInput {
95 | width: 100%;
96 | display: flex;
97 | flex-direction: row;
98 | align-items: flex-start;
99 | padding: 10px;
100 |
101 | position: static;
102 | height: 42px;
103 |
104 | background: #FFFFFF;
105 | border: 1px solid #CFD8DC;
106 | box-sizing: border-box;
107 | border-radius: 4px;
108 |
109 | /* Inside Auto Layout */
110 |
111 | flex: none;
112 | order: 0;
113 | flex-grow: 0;
114 | margin: 4px 0px;
115 | }
116 |
117 | .account-buttons {
118 | /* Auto Layout */
119 |
120 | display: flex;
121 | flex-direction: row;
122 | justify-content: center;
123 | align-items: center;
124 | padding: 0px;
125 |
126 | position: static;
127 | width: 100%;
128 | height: 46px;
129 | border-radius: 4px;
130 |
131 | /* Inside Auto Layout */
132 |
133 | flex: none;
134 | order: 2;
135 | flex-grow: 0;
136 | margin: 32px 0px;
137 | }
138 |
139 | .my-form-group {
140 | text-align: left;
141 | }
142 |
143 | .account-links {
144 | display: inline;
145 | font-family: Roboto;
146 | font-style: normal;
147 | font-weight: 500;
148 | font-size: 13px;
149 | text-decoration-line: underline;
150 |
151 | color: #FF85A5;
152 | }
153 |
154 | .error-text {
155 | font-family: Roboto;
156 | padding-top: 2px;
157 | font-size: 12px;
158 | font-weight: 500;
159 | color: #FF1744;
160 | }
161 |
162 | .headers-page {
163 | text-align: center;
164 | font-family: 'Roboto';
165 | /* text-shadow: 2px 2px 2px #aaa; */
166 |
167 | /* border: 2px solid blue; */
168 | margin-left: 1%;
169 | margin-right: 1%;
170 | margin-top: .5%;
171 |
172 |
173 | white-space:nowrap;
174 | overflow:hidden;
175 | text-overflow:ellipsis;
176 | }
177 |
178 | .my-table-button {
179 | background-color: var(--basic_color);
180 | height: 30px;
181 | }
182 |
183 | .my-link {
184 | color: var(--basic_color);
185 | }
186 |
187 |
188 | .center-screen {
189 | display: flex;
190 | flex-direction: column;
191 | justify-content: center;
192 | align-items: center;
193 | text-align: center;
194 | min-height: 100vh;
195 | }
196 |
197 | .table-div {
198 | /* border: 2px solid lightgreen; */
199 | margin-left: 1%;
200 | margin-right: 1%;
201 | margin-top: .5%;
202 | }
203 |
204 | .drop-down {
205 | margin-right: 8%;
206 | }
207 |
208 | .my-table-header {
209 |
210 | position: static;
211 |
212 | font-family: Roboto;
213 | font-style: normal;
214 | font-weight: normal;
215 | font-size: 15px;
216 | line-height: 16px;
217 |
218 | color: #5C666B;
219 |
220 |
221 | /* Inside Auto Layout */
222 |
223 | flex: none;
224 | order: 0;
225 | flex-grow: 0;
226 | margin: 0px 0px;
227 | }
228 |
229 | .my-table-text {
230 |
231 | font-family: Roboto;
232 | font-style: normal;
233 | font-weight: normal;
234 | font-size: 14px;
235 |
236 | color: #1F282D;
237 | }
238 |
239 | .my-small-btn {
240 | display:block;
241 | height: 300px;
242 | width: 300px;
243 | border-radius: 50%;
244 | border: 1px solid red;
245 |
246 | }
247 |
248 | .table-hover tbody tr:hover td, .table-hover tbody tr:hover th {
249 | background-color: #E2EBF0 !important;
250 | cursor: pointer;
251 |
252 | }
253 |
254 | .page-item.active .page-link {
255 | border: none;
256 | color: black !important;
257 | background: var(--basic_color) !important;
258 | }
259 |
260 | .top-div {
261 | /* border: 2px solid lightgreen; */
262 | margin-top: .5%;
263 | margin-left: 1%;
264 | margin-right: 1%;
265 | }
266 |
267 | .top-div:after {
268 | content:'';
269 | display:block;
270 | clear:both;
271 | }
272 |
273 | .top-icons {
274 | float: left;
275 | margin-left: 1%;
276 | margin-top: .2%;
277 | }
278 |
279 | .form-headers {
280 | font-family: 'Roboto';
281 | /* text-shadow: 2px 2px 2px #aaa; */
282 |
283 | white-space:nowrap;
284 | overflow:hidden;
285 | text-overflow:ellipsis;
286 | }
287 |
288 | a {
289 | text-decoration: none !important;
290 | }
291 |
292 |
293 | #nprogress .bar {
294 | background: #007bff !important;
295 | }
296 |
297 | .tooltip-icons {
298 | cursor: default;
299 | }
300 |
301 | .alert {
302 | margin: 0;
303 | }
304 |
305 | .table-striped > tbody > tr:nth-child(2n+1) > td, .table-striped > tbody > tr:nth-child(2n+1) > th {
306 | background-color: #F3F6F8;
307 | }
308 |
309 | .tooltip-body {
310 | height: 10px;
311 | overflow-y: auto;
312 | }
--------------------------------------------------------------------------------
/label_buddy/label_buddy/settings.py:
--------------------------------------------------------------------------------
1 | """
2 | Django settings for label_buddy project.
3 |
4 | Generated by 'django-admin startproject' using Django 3.2.3.
5 |
6 | For more information on this file, see
7 | https://docs.djangoproject.com/en/3.2/topics/settings/
8 |
9 | For the full list of settings and their values, see
10 | https://docs.djangoproject.com/en/3.2/ref/settings/
11 | """
12 |
13 | from pathlib import Path
14 | import os
15 |
16 | # Build paths inside the project like this: BASE_DIR / 'subdir'
17 | BASE_DIR = Path(__file__).resolve().parent.parent
18 |
19 |
20 | # Quick-start development settings - unsuitable for production
21 | # See https://docs.djangoproject.com/en/3.2/howto/deployment/checklist/
22 |
23 | # SECURITY WARNING: keep the secret key used in production secret!
24 | SECRET_KEY = "django_key_long_random_key_here_12763523765&^!@$#%%^@#$%@#$"
25 |
26 | # SECURITY WARNING: don't run with debug turned on in production!
27 | DEBUG = True
28 |
29 | ALLOWED_HOSTS = ['67.205.153.230', '127.0.0.1']
30 |
31 | INTERNAL_IPS = [
32 | '127.0.0.1',
33 | ]
34 |
35 | # Django-allauth settings
36 | ACCOUNT_EMAIL_CONFIRMATION_EXPIRE_DAYS = 2
37 | ACCOUNT_EMAIL_REQUIRED = True # Email adress must be verified in ordet to register
38 | ACCOUNT_EMAIL_VERIFICATION = "optional" # Email should be verified in roder to log in
39 | ACCOUNT_LOGIN_ATTEMPTS_LIMIT = 10 # Login attempts in order to prevent brute force attacks
40 | ACCOUNT_LOGIN_ATTEMPTS_TIMEOUT = 5
41 | ACCOUNT_USERNAME_MIN_LENGTH = "4"
42 | ACCOUNT_AUTHENTICATION_METHOD = 'username_email'
43 | ACCOUNT_SIGNUP_PASSWORD_VERIFICATION = False # Confirmation password isnt needed
44 | EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend' # On signup send messages to this email (print in terminal)
45 | ACCOUNT_FORMS = {
46 | 'login': 'users.forms.ExtendedLogInForm',
47 | 'signup': 'users.forms.ExtendedSignUpForm',
48 | 'reset_password': 'users.forms.ExtendedResetPasswordForm',
49 | }
50 |
51 | # Password validation
52 | # https://docs.djangoproject.com/en/3.2/ref/settings/#auth-password-validators
53 | AUTH_PASSWORD_VALIDATORS = [
54 | {
55 | 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
56 | },
57 | {
58 | 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
59 | 'OPTIONS': {
60 | 'min_length': 8,
61 | },
62 | },
63 | {
64 | 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
65 | },
66 | {
67 | 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
68 | },
69 | {
70 | 'NAME': 'users.password_validators.UppercaseValidator',
71 | },
72 | {
73 | 'NAME': 'users.password_validators.NumberValidator',
74 | },
75 | {
76 | 'NAME': 'users.password_validators.SymbolValidator',
77 | },
78 | ]
79 |
80 |
81 | LOGIN_REDIRECT_URL = "/"
82 | ACCOUNT_LOGOUT_REDIRECT_URL = "/accounts/login/"
83 | MESSAGE_STORAGE = 'django.contrib.messages.storage.session.SessionStorage'
84 |
85 | AUTHENTICATION_BACKENDS = (
86 | 'django.contrib.auth.backends.ModelBackend',
87 | 'allauth.account.auth_backends.AuthenticationBackend',
88 | )
89 |
90 | # Application definition
91 |
92 |
93 | INSTALLED_APPS = [
94 | 'django.contrib.admin',
95 | 'allauth',
96 | 'allauth.account',
97 | 'allauth.socialaccount',
98 | 'django.contrib.auth',
99 | 'django.contrib.sites',
100 | 'django.contrib.contenttypes',
101 | 'django_extensions',
102 | 'django.contrib.sessions',
103 | 'django.contrib.messages',
104 | 'django.contrib.staticfiles',
105 | 'debug_toolbar',
106 | 'rest_framework',
107 | # Third party
108 | 'colorfield',
109 | 'url_or_relative_url_field',
110 | 'crispy_forms',
111 |
112 | # Own
113 | 'users',
114 | 'projects',
115 | 'tasks',
116 | ]
117 |
118 | MIDDLEWARE = [
119 | 'django.middleware.security.SecurityMiddleware',
120 | 'debug_toolbar.middleware.DebugToolbarMiddleware',
121 | 'django.contrib.sessions.middleware.SessionMiddleware',
122 | 'django.middleware.common.CommonMiddleware',
123 | 'django.middleware.csrf.CsrfViewMiddleware',
124 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
125 | 'django.contrib.messages.middleware.MessageMiddleware',
126 | 'django.middleware.clickjacking.XFrameOptionsMiddleware',
127 | ]
128 |
129 | DEBUG_TOOLBAR_PANELS = [
130 | 'debug_toolbar.panels.history.HistoryPanel',
131 | 'debug_toolbar.panels.versions.VersionsPanel',
132 | 'debug_toolbar.panels.timer.TimerPanel',
133 | 'debug_toolbar.panels.settings.SettingsPanel',
134 | 'debug_toolbar.panels.headers.HeadersPanel',
135 | 'debug_toolbar.panels.request.RequestPanel',
136 | 'debug_toolbar.panels.sql.SQLPanel',
137 | 'debug_toolbar.panels.staticfiles.StaticFilesPanel',
138 | 'debug_toolbar.panels.templates.TemplatesPanel',
139 | 'debug_toolbar.panels.cache.CachePanel',
140 | 'debug_toolbar.panels.signals.SignalsPanel',
141 | 'debug_toolbar.panels.logging.LoggingPanel',
142 | 'debug_toolbar.panels.redirects.RedirectsPanel',
143 | 'debug_toolbar.panels.profiling.ProfilingPanel',
144 | ]
145 |
146 | ROOT_URLCONF = 'label_buddy.urls'
147 |
148 | TEMPLATES = [
149 | {
150 | 'BACKEND': 'django.template.backends.django.DjangoTemplates',
151 | 'DIRS': [os.path.join(BASE_DIR, "templates"), ],
152 | 'APP_DIRS': True,
153 | 'OPTIONS': {
154 | 'context_processors': [
155 | 'django.template.context_processors.debug',
156 | 'django.template.context_processors.request',
157 | 'django.contrib.auth.context_processors.auth',
158 | 'django.contrib.messages.context_processors.messages',
159 | ],
160 | },
161 | },
162 | ]
163 |
164 | WSGI_APPLICATION = 'label_buddy.wsgi.application'
165 |
166 | AUTH_USER_MODEL = "users.User"
167 |
168 | # Database
169 | # https://docs.djangoproject.com/en/3.2/ref/settings/#databases
170 |
171 | # To Fix
172 | if True:
173 | DATABASES = {
174 | 'default': {
175 | 'ENGINE': 'django.db.backends.sqlite3',
176 | 'NAME': BASE_DIR / 'db.sqlite3',
177 | }
178 | }
179 | else:
180 | DATABASES = {
181 | 'default': {
182 | 'ENGINE': 'django.db.backends.postgresql_psycopg2',
183 | 'NAME': 'label_buddy',
184 | 'USER': 'labelbuddy',
185 | 'PASSWORD': 'labelbuddy123',
186 | 'HOST': 'localhost',
187 | 'PORT': '',
188 | }
189 | }
190 |
191 | # Internationalization
192 | # https://docs.djangoproject.com/en/3.2/topics/i18n/
193 | LANGUAGE_CODE = 'en-us'
194 | TIME_ZONE = 'Europe/Athens'
195 |
196 | USE_I18N = True
197 | USE_L10N = True
198 | USE_TZ = True
199 | SITE_ID = 1
200 |
201 | # Static files (CSS, JavaScript, Images)
202 | # https://docs.djangoproject.com/en/3.2/howto/static-files/
203 |
204 | STATIC_URL = "/static/" # where js/css files are stored on the filesystem
205 |
206 | # Base url to serve media files
207 | MEDIA_URL = '/media/'
208 |
209 | # Path where media is stored
210 | MEDIA_ROOT = os.path.join(BASE_DIR, 'media/')
211 | MEDIA_ROOT = os.path.join(BASE_DIR, 'media/')
212 |
213 | STATICFILES_DIRS = [
214 | os.path.join(BASE_DIR, 'static')
215 | ]
216 |
217 | # Default primary key field type
218 | # https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
219 |
220 | DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
221 | CRISPY_TEMPLATE_PACK = 'bootstrap4'
222 |
--------------------------------------------------------------------------------
/label_buddy/templates/label_buddy/list_annotations.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% load static %}
4 |
5 | {% block head_files%}
6 | {{ block.super }}
7 |
8 |
9 | {% endblock %}
10 |
11 | {% block title %} ◦ Task {{task.id}} annotations {% endblock %}
12 |
13 | {% block breadcrumbs %}
14 |
15 |
113 | {% if annotations_reviewed_by_user|get_item:annotation.id %}
114 |
115 | Reviewed by you
116 | {% else %}
117 |
118 | Not reviewed by you
119 | {% endif %}
120 |
121 |
122 | {% endfor %}
123 |
124 |
125 |
126 | {% include "review_info_modal.html" %}
127 | {% if annotations_count > annotations_per_page %}
128 | {% include "pagination.html" %}
129 | {% endif %}
130 | {% endblock %}
--------------------------------------------------------------------------------
/label_buddy/tasks/views.py:
--------------------------------------------------------------------------------
1 | from django.http import HttpResponse
2 | from django.utils import timezone
3 | from django.contrib import messages
4 |
5 | from rest_framework.response import Response
6 | from rest_framework.views import APIView
7 | from rest_framework.exceptions import PermissionDenied
8 | from rest_framework import (
9 | permissions,
10 | status,
11 | )
12 |
13 | from projects.models import Project
14 | from .models import Task, Annotation
15 | from .serializers import TaskSerializer
16 | from .helpers import (
17 | get_user,
18 | get_annotation,
19 | export_data,
20 | )
21 | # Create your views here
22 |
23 |
24 | # API VIEWS
25 | class TaskList(APIView):
26 |
27 | permission_classes = (permissions.IsAuthenticatedOrReadOnly,)
28 | serializer_class = TaskSerializer
29 |
30 | """
31 | List all tasks or create a new one.
32 | """
33 |
34 | # Get request
35 | def get(self, request, format=None):
36 |
37 | tasks = Task.objects.all()
38 | serializer = TaskSerializer(tasks, many=True)
39 |
40 | return Response(serializer.data)
41 |
42 | # Post request
43 | def post(self, request, format=None):
44 |
45 | serializer = TaskSerializer(data=request.data)
46 |
47 | if serializer.is_valid():
48 | serializer.save()
49 | return Response(serializer.data, status=status.HTTP_201_CREATED)
50 | return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
51 |
52 |
53 | class AnnotationSave(APIView):
54 |
55 | """
56 | Only post is implemented here.
57 | """
58 |
59 | def get_project(self, pk):
60 | try:
61 | return Project.objects.get(pk=pk)
62 | except PermissionDenied:
63 | return Response({"message": "No permissions"}, status=status.HTTP_401_UNAUTHORIZED)
64 | except Project.DoesNotExist:
65 | return Response({"message": "Project does not exist"}, status=status.HTTP_400_BAD_REQUEST)
66 |
67 | def get_task(self, task_pk):
68 | try:
69 | return Task.objects.get(pk=task_pk)
70 | except PermissionDenied:
71 | return Response({"message": "No permissions"}, status=status.HTTP_401_UNAUTHORIZED)
72 | except Task.DoesNotExist:
73 | return Response({"message": "Task does not exist"}, status=status.HTTP_400_BAD_REQUEST)
74 |
75 | def post(self, request, pk, task_pk, format=None):
76 |
77 | # Checks for user
78 | user = get_user(request.user.username)
79 | if not user or (user != request.user):
80 | return Response({"message": "Something is wrong with the user!"}, status=status.HTTP_400_BAD_REQUEST)
81 |
82 | # Check if project exists
83 | project = self.get_project(pk)
84 | if isinstance(project, HttpResponse):
85 | return Response(project.data, status=project.status_code)
86 |
87 | # Check if task exists
88 | task = self.get_task(task_pk)
89 | if isinstance(task, HttpResponse):
90 | return Response(task.data, status=task.status_code)
91 |
92 | # Check if user is annotator for this project
93 | if user not in project.annotators.all():
94 | return Response({"message": "You are not an annotator for this project!"}, status=status.HTTP_400_BAD_REQUEST)
95 |
96 | # Check if task belongs to project
97 | if task.project != project:
98 | message = "Task " + str(task.id) + " does not belong to project " + project.title + "!"
99 | return Response({"message": message}, status=status.HTTP_400_BAD_REQUEST)
100 |
101 | # If all validations pass, save annotations
102 | # Check if an annotation already exists. If not create one, else change result and update date
103 | annotation = get_annotation(task, project, user)
104 | result = request.data
105 |
106 | # If annotation is not empty
107 | if annotation:
108 | if result != []:
109 | # Update existing annotation
110 | annotation.result = result
111 | annotation.updated_at = timezone.now()
112 | annotation.save()
113 | else:
114 | annotation.delete()
115 | messages.add_message(request, messages.SUCCESS, "Annotation deleted.")
116 | return Response({}, status=status.HTTP_200_OK)
117 | else:
118 | if result != []:
119 | # Create new annotation
120 | Annotation.objects.create(
121 | task=task,
122 | project=project,
123 | user=user,
124 | result=result,
125 | )
126 | else:
127 | messages.add_message(request, messages.ERROR, "You submitted an empty annotation.")
128 | return Response({}, status=status.HTTP_400_BAD_REQUEST)
129 | messages.add_message(request, messages.SUCCESS, "Annotation saved successfully.")
130 | return Response({}, status=status.HTTP_200_OK)
131 |
132 |
133 | class ExportData(APIView):
134 |
135 | """
136 | API endpoint for exporting data for a project.
137 | Only post is implemented here.
138 | """
139 |
140 | def get_project(self, pk):
141 | try:
142 | return Project.objects.get(pk=pk)
143 | except PermissionDenied:
144 | return Response({"message": "No permissions"}, status=status.HTTP_401_UNAUTHORIZED)
145 | except Project.DoesNotExist:
146 | return Response({"message": "Project does not exist"}, status=status.HTTP_400_BAD_REQUEST)
147 |
148 | def post(self, request, pk, format=None):
149 |
150 | # Checks for user
151 | user = get_user(request.user.username)
152 | if not user or (user != request.user):
153 | return Response({"message": "Something is wrong with the user!"}, status=status.HTTP_400_BAD_REQUEST)
154 |
155 | # Check if project exists
156 | project = self.get_project(pk)
157 | if isinstance(project, HttpResponse):
158 | return Response(project.data, status=project.status_code)
159 |
160 | # Check if user is part of this project
161 | if (user not in project.reviewers.all()) and (user not in project.annotators.all()) and (user not in project.managers.all()):
162 | return Response({"message": "You are not involved to this project!"}, status=status.HTTP_400_BAD_REQUEST)
163 |
164 | # If all validations pass, return exported json
165 | exported_json, skipped_annotations = export_data(project, request.data['exportApproved'])
166 |
167 | # Create filename
168 | if request.data['exportApproved']:
169 | exported_name = "project-" + str(project.id) + "-ONLY_APPROVED-export_at-" + project.created_at.strftime("%Y-%m-%d-%H:%M:%S")
170 | else:
171 | exported_name = "project-" + str(project.id) + "-export_at-" + project.created_at.strftime("%Y-%m-%d-%H:%M:%S")
172 |
173 | if request.data['exportApproved']:
174 | message = str(skipped_annotations) + " unapproved annotations were skipped. Succesfully exported " + exported_name + "."
175 | else:
176 | message = "Succesfully exported " + exported_name + "."
177 | exported_name += ".json" if request.data['format'] == "JSON" else ".csv"
178 | data = {
179 | "format": request.data['format'],
180 | "exported_json": exported_json,
181 | "exported_name": exported_name,
182 | "message": message
183 | }
184 | return Response(data, status=status.HTTP_200_OK)
185 |
--------------------------------------------------------------------------------
/docs/GSOC_FINAL_REPORT.md:
--------------------------------------------------------------------------------
1 | # :information_source: Project info
2 |
3 | 
4 |
5 | ### Brief explanation
6 | **Label Buddy** is powered by [GFOSS](https://gfoss.eu/) and [GSoC](https://summerofcode.withgoogle.com/). It is an audio labeling tool which features 3 types of users: Managers, annotators and reviewers. The distinction between the user roles is what makes Label Buddy unique. A Detailed explanation of Label Buddy and steps for installation can be found [here](https://github.com/eellak/gsoc2021-audio-annotation-tool/blob/main/README.md).
7 |
8 | ### Important links
9 | * GitHub repository: https://github.com/eellak/gsoc2021-audio-annotation-tool
10 | * GitHub README link: https://github.com/eellak/gsoc2021-audio-annotation-tool/blob/main/README.md
11 | * Label Buddy video demo: https://www.youtube.com/watch?v=ikPrWbs9MWw
12 | * Label Buddy demo link: Go to https://labelbuddy.io/ and sign in with the following credentials in order to check out Label Buddy:
13 | * **Username**: demo
14 | * **Password**: labelbuddy123
15 |
16 | [**Here**](https://github.com/eellak/gsoc2021-audio-annotation-tool/blob/main/docs/user_manual.md) you will find a user manual with screenshots and explanations for Label Buddy
17 |
18 | ### Important pull requests
19 | * Merge dev_branch with main: [#25](https://github.com/eellak/gsoc2021-audio-annotation-tool/pull/25)
20 | * Merge review_page with main: [#31](https://github.com/eellak/gsoc2021-audio-annotation-tool/pull/31)
21 |
22 | ### Tech Stack
23 | * Django, Django templates, Python
24 | * HTML, css, js
25 |
26 |
27 | # :heavy_check_mark: Tasks completed during GSoC (7 JUNE - 16 AUGUST)
28 | [Here](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues?q=is%3Aissue+is%3Aclosed) you can see all issues closed during the coding period. Each issue has a brief explanation of what should be done. In every issue you can see every commit done for it. Now let's list the **most important** tasks (issues) for Label Buddy.
29 |
30 | ## 1. Create django models
31 | * Related issues: [#1](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/1), [#2](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/2), [#3](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/3)
32 | * Working branch: [main](https://github.com/eellak/gsoc2021-audio-annotation-tool)
33 | * **Task**: Created Django models: User, Project, Task, Annotation, Comment, Label. Users will be managers, annotators and reviewers. If can_create_projects variable is set to true user can create projects, add labels and import tasks (audio files). Annotators can create annotations for tasks and reviewers can create reviews for completed annotations
34 |
35 | ## 2. Login/Register
36 | * Related issue: [#12](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/12)
37 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
38 | * **Task**: Created basic Login/Register system. For the backend of this task I used [django-allauth](https://django-allauth.readthedocs.io/en/latest/installation.html)
39 |
40 | ## 3. Index page
41 | * Related issue: [#13](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/13)
42 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
43 | * **Task**: Create index page in which the user will be able to see all projects that he/she is involved in. A user is involved in a project if he/she is a manager an annotator or a reviewer
44 |
45 | ## 4. User creates project
46 | * Related issue: [#14](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/14)
47 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
48 | * **Task**: Create a page for creating projects (if user has the permission) . User can specify all project's attributes like title, labels, annotators etc
49 |
50 | ## 5. User edits project
51 | * Related issue: [#15](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/15)
52 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
53 | * **Task**: Create a page for editing projects. **Only** managers of a project can edit it
54 |
55 | ## 6. Add tasks to project
56 | * Related issue: [#16](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/16)
57 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
58 | * **Task**: Managers can import single audio files (.wav, .mp3 and .mp4) or .zip files containing accepted format files. Every audio file represent a task for the project which needs to be annotated
59 |
60 | ## 7. List tasks for project
61 | * Related issue: [#17](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/17)
62 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
63 | * **Task**: Create a page for listing tasks for annotation/review. Tasks displayed depend on the user's role in the project. Managers can see all task uploaded. Annotators can see only tasks assigned to them and reviewers can see all tasks in order to review them
64 |
65 | ## 8. Annotate tasks for project
66 | * Related issue: [#18](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/18)
67 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
68 | * **Task**: Create annotation page where annotators will be able to annotate a task. They are able to drug and create regions on the waveform and label them with the project's labels
69 |
70 | ## 9. Review tasks for project
71 | * Related issue: [#19](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/19)
72 | * Working branch: [review_page](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/review_page)
73 | * **Task**: Create review page where a reviewer can comment an annotation and either Approve it or Reject it
74 |
75 | ## 10. Export annotations for project
76 | * Related issue: [#20](https://github.com/eellak/gsoc2021-audio-annotation-tool/issues/20)
77 | * Working branch: [dev_branch](https://github.com/eellak/gsoc2021-audio-annotation-tool/tree/dev_branch)
78 | * **Task**: Managers are able to export all annotations completed for a project in JSON or CSV format. They can export either Approved annotations or all of them
79 | * Examples of exported files can be found [here](https://drive.google.com/drive/folders/1aQqYuO4czitTEFcDNjBsqc99zewMeW2r?usp=sharing)
80 |
81 | # :white_check_mark: Task Left to Do
82 | * UX imporvements: https://www.figma.com/file/gUelQicOdfJkrqs2XJvHl5/Label-Buddy?node-id=214%3A2605
83 | * Rar file upload. Zip is already accepted
84 | * Swagger documentation
85 | * Use exported data for machine learning models
86 |
87 | # :blush: Acknowledgements
88 |
89 | First and foremost, I want to thank my mentors [**Pantelis Vikatos**](https://www.linkedin.com/in/pantelis-vikatos-1383437a/) and [**Markos Gogoulos**](https://github.com/mgogoulos), for guiding, giving me useful advice for the project and helping me whenever I faced an issue. It was a pleasure working with them and I hope I get the opportunity to do it again soon. We had a meeting twice a week and our means of communication was **[Mattermost](https://mattermost.com/)**. Moreover I would like to thank **Jen Anastasopoulou** and **Lina Aggelopoulou** for the UX improvements which can be found [here](https://www.figma.com/file/gUelQicOdfJkrqs2XJvHl5/Label-Buddy?node-id=214%3A2605). These improvements will have been applied by the end of the month and will make Label Buddy more user friendly. Finally, I would like to express my appreciation to **[Orfium](https://www.orfium.com/)** for supporting the whole project from the start to the end of it.
90 |
--------------------------------------------------------------------------------
/label_buddy/templates/base.html:
--------------------------------------------------------------------------------
1 | {% load static %}
2 |
3 |
4 |
5 |
6 | {% block head_files %}
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 | {% endblock %}
32 |
33 |
34 | {% block title %}{% endblock %}
35 |
36 |
37 |
38 |
39 | {% block navbar %}
40 |
16 | YOU ARE LOST!
17 | 
77 | {% else %}
78 |