Serimantic

Title: Serimantic
Keywords: NLP, recommendation, TV series
Version: 2.0.3
Date: September 2018
Authors: Johann Benerradi, Rachel Confiant-Duté, Justinien Ghorra, Laurine Jeannot, Quentin Pouvreau
Web site: UFR Mathématiques et Informatique
Platform: Python 3, Django
License: GNU GPL 3.0

Relies on tmdbsimple v1.7.0 modified to get keywords of TV series (stored in src/lib)

Description:
TV series recommendation based on keyword extraction through semantic analysis of overviews

Requires:

API key configuration

Run src/config.py with Python 3 and type in the key

Web interface

Installation

1) Install Django and Django Rest Framework with pip

sudo apt install python3-pip
sudo apt install python3-django
sudo -H pip install django
sudo -H pip install djangorestframework
sudo -H pip install markdown   # Markdown support for the browsable API
sudo -H pip install django-filter

2) Install MySQL Server and the connector for Python

sudo apt install mysql-server
sudo mysql_secure_installation
sudo apt install libmysqlclient-dev python-dev python-mysqldb
sudo apt install python3-mysql.connector
sudo -H pip install mysqlclient
sudo -H pip install pymysql

3) Create a user to access a new database serimantic in MySQL

sudo mysql -u root -p

Template:

CREATE DATABASE serimantic;
GRANT ALL PRIVILEGES on serimantic.* to 'user'@'localhost' IDENTIFIED BY 'password';
exit

4) Add your own settings.py file in ./Serimantic/

(See template below)

5) Migrate the database

python3 manage.py migrate
python3 manage.py loaddata nlpdata

6) Create a superuser to access the database as admin in Django

python3 manage.py createsuperuser

7) Run the server

python3 manage.py runserver

You’re good to go !

Command-line interface

Keyword Extraction on the basic corpus

Run src/default.py with Python 3 (keywords are stored in data/nlpdata.txt)
Modify data/defaultseries.txt to extract keywords on a different series basis
This process might have already been done

Add a series to the corpus

Run src/add.py with Python 3 and follow the instructions (new keywords are stored in data/nlpdata.txt)

Series recommendation

Run src/recommendation.py with Python 3 and folow the instructions
A series close to that indicated will be recommended and the common keywords will be displayed

settings.py

"""
Django settings for Serimantic project.
Generated by 'django-admin startproject' using Django 2.0.3.
For more information on this file, see
https://docs.djangoproject.com/en/2.0/topics/settings/
For the full list of settings and their values, see
https://docs.djangoproject.com/en/2.0/ref/settings/
"""
import os
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
TEMPLATE_DIR = os.path.join(BASE_DIR, "spa/templates")
STATIC_DIR = os.path.join(BASE_DIR, "spa/static")
FIXTURE_DIR = os.path.join(BASE_DIR, "data/fixtures")
# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.0/howto/deployment/checklist/
# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = # TODO
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True
ALLOWED_HOSTS = []
# Application definition
INSTALLED_APPS = [
    'data',
    'rest_framework',
    'api.apps.ApiConfig',
    'spa.apps.SpaConfig',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]
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 = 'Serimantic.urls'
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [TEMPLATE_DIR],
        '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 = 'Serimantic.wsgi.application'
# Database
# https://docs.djangoproject.com/en/2.0/ref/settings/#databases
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': # TODO,
        'USER': # TODO,
        'PASSWORD': # TODO,
        'HOST': # TODO,
        'PORT': # TODO,
    }
}
# Password validation
# https://docs.djangoproject.com/en/2.0/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/2.0/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/2.0/howto/static-files/
STATIC_URL = '/static/'
STATICFILES_DIRS = [
    STATIC_DIR,
]