betinacosta / moviemancer Goto Github PK

View Code? Open in Web Editor NEW

6.0 2.0 2.0 21.32 MB

Web application for movie recommendation

Python 31.29% CSS 7.12% JavaScript 27.12% HTML 33.69% CoffeeScript 0.53% Makefile 0.26%

moviemancer's Introduction

Moviemancer

Moviemancer is a website for movie recommendation.

Production: http://moviemancer-api.herokuapp.com/

Getting Started

Requirements

Instalation

$ make setup

Running Locally

Setting the Database

Inside the project directory run: $ make recreate_db

This will drop the moviemancer database and user in case you already have one and recreate those with the proper configuration.

If you wish just setup a moviemancer db that you already created, just run $ make setup_db

Configuring settings.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql_psycopg2',
        'NAME': 'moviemancer',
        'USER': 'moviemancer',
        'PASSWORD': moviemancer,
        'HOST': 'localhost',
        'PORT': 5432,
    }
}

Runing

Inside the project directory run:

$ make run
open http://127.0.0.1:8000

Deploying to Heroku

$ heroku create
$ git push heroku master

$ heroku run python manage.py migrate
$ heroku open

moviemancer's People

Contributors

Stargazers

Watchers

Forkers

dafinoer mondaini

moviemancer's Issues

Description:

In order to facilitate the set up of the application, a README is necessary.

Acceptance Criteria:

The README must contain:

What is the project.
Link to the website.
Installation guide.
Deploy to Heroku guide.
How to run the application
How to run the tests

update requirements.txt and move outside 'backend' folder

Add https://landscape.io/ for linting analysis

Remove folders .vscode & venv from git versioning.

Report of activities

The user should be able to visualize a report of your activities at the site:

Number of movies seen in time period(week, month, year)
Most watched genres;
Preferred duration;
Preferred years;

Fix at least 3 movies for registration

It is necessary to choose at least three movies at the registration, but the frontend gives no information about it and it allows to continue even if selected less than 3 movies

How to reproduce:

Create a account and rate just 1 movie
Press Enviar button
You will be logged out and no able to login with your just created user.

Review recommendation algorithm

Study other type of recommendation system, to see if is possible have only the active user as input in a trained system;

Possibilities

Content Based
Matrix Fatorization
Item-based collaborative filtering

Separate backend from frontend

Currently, the backend and frontend of Moviemancer are very coupled. The idea is to transform moviemancer's backend in an API

Remover repetição em ratemovie e rate_first_movies_request

Repetição em views.py

Introduce Pandas to the project

In order to deal with the large amount of data we have, start using panas can make things a lot easier

Add waffle svg on README

Take a look at the this code clicking in the edit button:

Update project with heroku version

The project we have today in the repository is not up to date with the production version... Don't ask me why.

Investigate 429 Too Many Requests Error

Sometimes when logging as a new user, this error is thrown and is not possible to login in the first attempt

Maybe, just maybe that was the purpose of the mysterious time.sleep that I so naively removed

Change deploy from heroku git to github

Now, the deploy in heroku is made by its deploy system. Could be interesting use github to do it.

See Deploying with Git for more information

Transforme scripts into classes

... in order to make imports less ugly and... it kinda feels better

Implement User Profile functionality

Problem

Now there is no user info update and display functionalities;

AC's

Be able to visualize user profile
Be able to edit user profile

Create interface Tests

The project has no frontend tests, the idea is create some UI tests to assure that basic functionalities of the site are working properly.

Happy Path

Create profile;
Rate at leat 3 movies;
Finish registering;
Log In;
Se movies in recommendation;
Expand recommendation;
Rate a recommendation (The recommendation should be removed from the list);
Add a movie to watchlist;
See movie at watchlist;
Rate a movie in watchlist (The movie should be removed from list)
Select a movie (A detail page should be displayed)
Exit (should go back to login screen)

Fix database encode

Now the database is storing titles with encode problems:

Max Year is Hardcoded

The max year selected on filter option is hardcoded to 2017.

Fix unit-tests configuration

All sort of errors occur when trying to run tests:

Reproduce

run make unit-test
see the errors

./manage.py test
Creating test database for alias 'default'...
System check identified some issues:

WARNINGS:
?: (1_7.W001) MIDDLEWARE_CLASSES is not set.
	HINT: Django 1.7 changed the global defaults for the MIDDLEWARE_CLASSES. django.contrib.sessions.middleware.SessionMiddleware, django.contrib.auth.middleware.AuthenticationMiddleware, and django.contrib.messages.middleware.MessageMiddleware were removed from the defaults. If your project needs these middleware then you should configure this setting.
System check identified some issues:

WARNINGS:
?: (1_7.W001) MIDDLEWARE_CLASSES is not set.
	HINT: Django 1.7 changed the global defaults for the MIDDLEWARE_CLASSES. django.contrib.sessions.middleware.SessionMiddleware, django.contrib.auth.middleware.AuthenticationMiddleware, and django.contrib.messages.middleware.MessageMiddleware were removed from the defaults. If your project needs these middleware then you should configure this setting.
System check identified some issues:

WARNINGS:
?: (1_7.W001) MIDDLEWARE_CLASSES is not set.
	HINT: Django 1.7 changed the global defaults for the MIDDLEWARE_CLASSES. django.contrib.sessions.middleware.SessionMiddleware, django.contrib.auth.middleware.AuthenticationMiddleware, and django.contrib.messages.middleware.MessageMiddleware were removed from the defaults. If your project needs these middleware then you should configure this setting.
Traceback (most recent call last):
  File "./manage.py", line 22, in <module>
    execute_from_command_line(sys.argv)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/__init__.py", line 385, in execute_from_command_line
    utility.execute()
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/__init__.py", line 377, in execute
    self.fetch_command(subcommand).run_from_argv(self.argv)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/commands/test.py", line 50, in run_from_argv
    super(Command, self).run_from_argv(argv)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/base.py", line 288, in run_from_argv
    self.execute(*args, **options.__dict__)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/commands/test.py", line 71, in execute
    super(Command, self).execute(*args, **options)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/base.py", line 338, in execute
    output = self.handle(*args, **options)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/management/commands/test.py", line 88, in handle
    failures = test_runner.run_tests(test_labels)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/test/runner.py", line 147, in run_tests
    old_config = self.setup_databases()
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/test/runner.py", line 109, in setup_databases
    return setup_databases(self.verbosity, self.interactive, **kwargs)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/test/runner.py", line 299, in setup_databases
    serialize=connection.settings_dict.get("TEST_SERIALIZE", True),
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/backends/creation.py", line 382, in create_test_db
    self.connection._test_serialized_contents = self.serialize_db_to_string()
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/backends/creation.py", line 418, in serialize_db_to_string
    serializers.serialize("json", get_objects(), indent=None, stream=out)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/serializers/__init__.py", line 128, in serialize
    s.serialize(queryset, **options)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/core/serializers/base.py", line 52, in serialize
    for obj in queryset:
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/backends/creation.py", line 414, in get_objects
    for obj in queryset.iterator():
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/models/query.py", line 265, in iterator
    for row in compiler.results_iter():
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/models/sql/compiler.py", line 700, in results_iter
    for rows in self.execute_sql(MULTI):
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/models/sql/compiler.py", line 786, in execute_sql
    cursor.execute(sql, params)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/backends/utils.py", line 65, in execute
    return self.cursor.execute(sql, params)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/utils.py", line 94, in __exit__
    six.reraise(dj_exc_type, dj_exc_value, traceback)
  File "/Users/becosta/.local/share/virtualenvs/moviemancer-vZib5vRM/lib/python2.7/site-packages/django/db/backends/utils.py", line 65, in execute
    return self.cursor.execute(sql, params)
django.db.utils.ProgrammingError: relation "comments" does not exist
LINE 1: ... "comments"."movie_id", "comments"."comment" FROM "comments"...
                                                             ^

make: *** [unit-test] Error 1

Theories

Something wrong with database migrations

Train recommendation algorithm

Use movilens datasets to train the system;

Set database passwords in a safe way

The seetings.py use to have the database password, its removed, but now we have to manually set it to deploy and/or run locally.

Ideas

Set it at an Environment variable

Add movie area in movie page is too big

Description

By clicking at any place near the pin button the movie is added to watchlist

ACs

Have the add behaviour only in the pin

Upgrade tmdbsimple

The TMDb wrapper is currently in version 2.2.0, the version used in moviemancer is 1.6.1

Upgrade Requests

The Requests version used in moviemancer has a moderate security vulnerability. To Fix this issue, is necessary to upgrade to version 2.20.0 or later.

Obs:
I'm not quite sure for what this dependency is for e.e

Upgrade Djago Rest Framework

The current Django Rest version at moviemancer is 3.0, however, the framework is already at the 3.9.0.

Acceptance Criteria

Have Django 3.9.0 in Moviemancer

Improve scripts error handling

Error handling is no existent in this project.

Description

The views only throw error for empty request body, no considering empty responses on the methods that get information. The messages are also pretty vague.

AC's

Improve errors
Improve messages

Move TMDb related methods to a separeted file

There are several TMDb related methods lost in the queries file. They should have it's own file/class to live

ACCs:

Have all TMDb related methods in a different script
Have all TMDb related test in a different script

Add TMDb key to envioroment key

Currently the TMDb key is deployed, the key should be replaced and set as environment variable

Create Unit Tests D:

The project has no unit tests... dark times.

Upgrade Python

The Python version used in Moviemancer is 2.7.

Upgrade to Python 3

Upgrade from Django

The Django version used in moviemancer is 1.10, which is a very very old version.

Upgrade Django 1.10 to 2.1

Create board to track the project

Migrate Frontend to React

The current frontend is using Angular, the idea is migrate this to React.

Increase coverage to 90%

Verify on Coveralls what is lacking coverage

Refactor all Filter Functionality

Now, this is implemented in total 'Orientada a Gambiarra'.

Set a contract for the frontend
- Not selected = false
- genres: A String with genre separated by comas e.g. ("13,58")
- language: A String containing one language e.g. pt
- maxRuntime: An Integer e.g. 300
- maxYear: An *Integer *e.g. 2017
- minRuntime: An Integer e.g. 50
- minYear: An Integer e.g. 1919
- user_id: An Integer e.g. 32

Fix repeated movies being add to recommendation

Sometimes a recommended movie is add two times to the database;

Ideas

No longer save recommendations to Database, generate them in the beginning of the the session and store it in memory;

Review Database

Review checklist:

Check if all tables are still necessary;
Check if the connection among all tables are correct;
Check if serializers and database mapping are correct;
Update migration Files

Upgrade to Django to 2.1.5

Upgrade django to version 2.1.5 or later due to a security breach.

See more at: https://github.com/betinacosta/moviemancer/network/alert/Pipfile.lock/django/open

Rename parameters in tests

start using named parameters at tests:

self.assertFalse(is_movie_on_list(user_id=2, movie_id=1, type_id=2))

instead of

self.assertFalse(is_movie_on_list(2, 1, 2))

Create a method to add new movie

There are some code duplications in the following methods from the classe queries that could be fixed by adding a add_new_movie method:

rate_external_movie
add_to_list_external

Mobile version

Today, moviemancer is not mobile friendly, being almost impossible to use it any other device other than desktop.

Create a design for mobile version

Whenever a new user starts registering in moviemancer, a movie list is displayed so she can pre-rate some movies. Right Now those movies never seem to change. It would be nice either shuffle them or create a strategy to choose which movies will be displayed.

betinacosta / moviemancer Goto Github PK

moviemancer's Introduction

Moviemancer

Getting Started

Requirements

Instalation

Running Locally

Setting the Database

Configuring settings.py

Runing

Deploying to Heroku

moviemancer's People

Contributors

Stargazers

Watchers

Forkers

moviemancer's Issues

Description:

Acceptance Criteria:

Problem

AC's

Description

ACs

Description

AC's

Recommend Projects

Recommend Topics

Recommend Org