- Become more comfortable with Python.
- Gain experience with Flask.
- Learn to use SQL to interact with databases.
In this project, you'll build a book review website. Users will be able to register for your website and then log in using their username and password. Once they log in, they will be able to search for books, leave reviews for individual books, and see the reviews made by other people. You'll also use the a third-party API by Goodreads, another book review website, to pull in ratings from a broader audience.
- First, make sure you install a copy of Python. For this course, you should be using Python version 3.6 or higher.
- You'll also need to install
pip
. If you downloaded Python from Python's website, you likely already havepip
installed (you can check by runningpip
in a terminal window). If you don't have it installed, be sure to install it before moving on!
To try running your first Flask application:
- Download the
project1
distribution directory from ... - In a terminal window, navigate into your
project1
directory. - Run
pip3 install -r requirements.txt
in your terminal window to make sure that all of the necessary Python packages (Flask and SQLAlchemy, for instance) are installed. - Set the environment variable
FLASK_APP
to beapplication.py
. On a Mac or on Linux, the command to do this isexport FLASK_APP=application.py
. On Windows, the command is insteadset FLASK_APP=application.py
. You may optionally want to set the environment variableFLASK_DEBUG
to1
, which will activate Flask's debugger and will automatically reload your web application whenever you save a change to a file. - Run
flask run
to start up your Flask application. - If you navigate to the URL provided by
flask
, you should see the text"Project 1: TODO"
!
Goodreads is a popular book review website, and we'll be using their API in this project to get access to their review data for individual books.
- Go to https://www.goodreads.com/api and sign up for a Goodreads account if you don't already have one.
- Navigate to https://www.goodreads.com/api/keys and apply for an API key. For "Application name" and "Company name" feel free to just write "project1," and no need to include an application URL, callback URL, or support URL.
- You should then see your API key. (For this project, we'll care only about the "key", not the "secret".)
- You can now use that API key to make requests to the Goodreads API, documented here. In particular, Python code like the below
import requests
res = requests.get("https://www.goodreads.com/book/review_counts.json", params={"key": "KEY", "isbns": "9781632168146"})
print(res.json())
where KEY
is your API key, will give you the review and rating data for the
book with the provided ISBN number. In particular, you might see something like
this dictionary:
{'books': [{
'id': 29207858,
'isbn': '1632168146',
'isbn13': '9781632168146',
'ratings_count': 0,
'reviews_count': 1,
'text_reviews_count': 0,
'work_ratings_count': 26,
'work_reviews_count': 113,
'work_text_reviews_count': 10,
'average_rating': '4.04'
}]
}
Note that work_ratings_count
here is the number of ratings that this
particular book has received, and average_rating
is the book's average score
out of 5.
Alright, it's time to actually build your web application! Here are the requirements:
- Registration: Users should be able to register for your website, providing (at minimum) a username and password.
- Login: Users, once registered, should be able to log in to your website with their username and password. (Deze krijg je cadeau vanuit Finance)
- Logout: Logged in users should be able to log out of the site. (Deze krijg je cadeau vanuit Finance)
- Import: Provided for you in this project is a file called
books.csv
, which is a spreadsheet in CSV format of 5000 different books. Each one has an ISBN number, a title, an author, and a publication year. In a Python file calledimport.py
separate from your web application, write a program that will take the books and import them into your PostgreSQL database. You will first need to decide what table(s) to create, what columns those tables should have, and how they should relate to one another. Run this program by runningpython3 import.py
to import the books into your database, and submit this program with the rest of your project code. - Search: Once a user has logged in, they should be taken to a page where they can search for a book. Users should be able to type in the ISBN number of a book, the title of a book, or the author of a book. After performing the search, your website should display a list of possible matching results, or some sort of message if there were no matches. If the user typed in only part of a title, ISBN, or author name, your search page should find matches for those as well!
- Book Page: When users click on a book from the results of the search page, they should be taken to a book page, with details about the book: its title, author, publication year, ISBN number, and any reviews that users have left for the book on your website.
- Review Submission: On the book page, users should be able to submit a review: consisting of a rating on a scale of 1 to 5, as well as a text component to the review where the user can write their opinion about a book. Users should not be able to submit multiple reviews for the same book.
- Goodreads Review Data: On your book page, you should also display (if available) the average rating and number of ratings the work has received from Goodreads.
- You should be using raw SQL commands (as via SQLAlchemy's
execute
method) in order to make database queries. You should not use the SQLAlchemy ORM (if familiar with it) for this project. - If you've added any Python packages that need to be installed in order to run
your web application, be sure to add them to
requirements.txt
!
Beyond these requirements, the design, look, and feel of the website are up to you! You're also welcome to add additional features to your website, so long as you meet the requirements laid out in the above specification!
- At minimum, you'll probably want at least one table to keep track of users, one table to keep track of books, and one table to keep track of reviews. But you're not limited to just these tables, if you think others would be helpful!
- In terms of how to "log a user in," recall that you can store information
inside of the
session
, which can store different values for different users. In particular, if each user has anid
, then you could store thatid
in the session (e.g., insession["user_id"]
) to keep track of which user is currently logged in.