Merge pull request #393 from rebmizrahi/develop

Update dependencies, debug field errors, docs update

Author: rebmizrahi

README.md

@@ -7,10 +7,10 @@ Since this repository has submodule, when you clone it, please use `git clone --
 * Make sure you have ``homebrew`` and python 3.6 or above installed
 * Install PostgreSQL with ``brew install postgresql``
 * Start the PostgreSQL server with ``brew services start postgresql``
-* Set up environment variables with: ``cat env.txt >> ~/.bash_profile`` and ``source ~/.bash_profile`` (NOTE: If you use PyCharm or other IDE, please restart the IDE for the environmental settings to work!)
 * Start a virtual environment with ``python3 -m venv venv``
 * Start virtual environment ``source venv/bin/activate``
-* Install python packages ``pip install -r requirements.txt``
+* Set up environment variables with: ``cat env.txt >> ~/.bash_profile`` and ``source ~/.bash_profile`` (NOTE: If you use PyCharm or other IDE, please restart the IDE for the environmental settings to work!)
+* Install python packages ``pip3 install -r requirements.txt``
 * Setup database:
 
   ```bash
@@ -20,10 +20,18 @@ Since this repository has submodule, when you clone it, please use `git clone --
   > psql -d ${POSTGRES_DB} -c "ALTER DATABASE $POSTGRES_DB OWNER TO $POSTGRES_USER;"
   > psql ${POSTGRES_DB} -c "ALTER USER $POSTGRES_USER WITH PASSWORD '$POSTGRES_PASSWORD';"
   ```
-
 * Make migrations: ``python manage.py makemigrations``
 * Migrate: ``python manage.py migrate``
 * Start a server to see if it worked: ``python manage.py runserver``
 * Go to ``http://127.0.0.1:8000`` on your web browser
 
-[Developer documentation](https://elvis-project.github.io/simssadb/html/index.html)
+### To set up for development after having completed the above steps:
+* Start virtual environment ``source venv/bin/activate``
+* Link environment variables ``source ~/.bash_profile``
+* Start the server ``python manage.py runserver``
+* Go to ``http://127.0.0.1:8000`` on your web browser
+
+**See the Wiki for more information, including**
+- [User manual](https://github.com/rebmizrahi/simssadb/wiki/User-Manual)
+- [Setting up the database](https://github.com/rebmizrahi/simssadb/wiki/How-to-Populate-the-Database)
+- And developer documentation

database/models/contribution_musical_work.py

@@ -77,7 +77,7 @@ class ContributionMusicalWork(CustomBaseModel):
         "Arranger, Author of Text, Transcriber, "
         "Improviser, Performer",
     )
-    certainty_of_attribution = models.NullBooleanField(
+    certainty_of_attribution = models.BooleanField(
         help_text="Whether it is certain if this Person made this contribution",
         null=True,
         blank=True,

database/models/feature_type.py

@@ -51,7 +51,7 @@ class FeatureType(CustomBaseModel):
     description = models.TextField(
         blank=True, help_text="A description of the FeatureType"
     )
-    is_sequential = models.NullBooleanField(
+    is_sequential = models.BooleanField(
         blank=True,
         null=True,
         help_text="whether a feature can "

database/models/file.py

@@ -1,9 +1,8 @@
 """Defines a File model"""
 from typing import List
 import os
-from django.contrib.postgres.fields import JSONField
 from django.db import models
-from django.db.models import QuerySet
+from django.db.models import QuerySet, JSONField
 from database.models.custom_base_model import CustomBaseModel
 
 

database/models/musical_work.py

@@ -94,7 +94,7 @@ class MusicalWork(FileAndSourceMixin, CustomBaseModel):
         related_name="musical_works",
         help_text="e.g., sonata, motet, 12-bar blues",
     )
-    sacred_or_secular = models.NullBooleanField(
+    sacred_or_secular = models.BooleanField(
         null=True, blank=True, default=None, help_text="Leave blank if not applicable."
     )
     contributors = models.ManyToManyField(

database/signals.py

@@ -70,7 +70,7 @@ def run_jsymbolic(instance, **kwargs):
         feature_path.replace(".xml.", ".csv.") + ".csv",
         feature_path.replace(".xml.", ".arff.") + ".arff",
     ]  # jsymbolic rename the xml.midi file
-    # in a weired way
+    # in a weird way
     print(path)
     print(os.path.exists(path))
     # instance_json = serializers.serialize('json', [instance, ])
@@ -116,7 +116,7 @@ def async_task(
             for item in feature_path_file:  # save all the feature files in the DB
                 filename, ext = os.path.splitext(item)
                 FeatureFile.objects.get_or_create(
-                    file_type=ext,
+                    file_format=ext,
                     file=item,
                     features_from_file=instance,
                     config_file=feature_config_file,
@@ -125,6 +125,7 @@ def async_task(
                 )
 
 
+# Potential problem: instance_pk? index_components not defined? looks like it was taken from # https://simonwillison.net/2017/Oct/5/django-postgresql-faceted-search/
 @receiver(post_save, sender=MusicalWork)
 def on_save(instance, **kwargs):
     index_components = instance.index_components()

database/urls.py

@@ -1,4 +1,3 @@
-from django.conf.urls import include, url
 from django.urls import path
 from django.contrib.auth import views as auth_views
 from database.views import *

database/views/encoding_workflow.py

@@ -7,10 +7,9 @@ class EncodingWorkflowDetailView(DetailView):
     model = EncodingWorkFlow
     template_name = "detail.html"
 
-
 class EncodingWorkflowListView(SearchableListMixin, ListView):
     model = EncodingWorkFlow
-    search_fields = ["name"]
-    queryset = EncodingWorkFlow.objects.order_by("name")
+    search_fields = ["encoder_names"]
+    queryset = EncodingWorkFlow.objects.order_by("encoder_names")
     paginate_by = 100
     template_name = "list.html"

database/views/front_end_views.py

@@ -2,7 +2,7 @@
 from django.http import HttpResponse
 from django.shortcuts import render, redirect
 from django.contrib.sites.shortcuts import get_current_site
-from django.utils.encoding import force_bytes, force_text
+from django.utils.encoding import force_bytes, force_str
 from django.utils.http import urlsafe_base64_encode, urlsafe_base64_decode
 from django.template.loader import render_to_string
 # from database.tokens import account_activation_token

database/views/validation_worflow.py

@@ -10,7 +10,7 @@ class ValidationWorkFlowDetailView(DetailView):
 
 class ValidationWorkFlowListView(SearchableListMixin, ListView):
     model = ValidationWorkFlow
-    search_fields = ["name"]
-    queryset = ValidationWorkFlow.objects.order_by("name")
+    search_fields = ["validator_names"]
+    queryset = ValidationWorkFlow.objects.order_by("validator_names")
     paginate_by = 100
     template_name = "list.html"