A simple books API created using Django Python framework. All commands below assume that you are currently in the project root folder.
After cloning the repository, configure your DB connection parameters: DB_HOST, DB_USER, DB_PASS, DB_NAME in books_api/settings.py file.
books_api/settings.py
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'DB_NAME',
'HOST': 'DB_HOST',
'USER': 'DB_USER',
'PASSWORD': 'DB_PASSWORD',
}
}Create a secret_settings.py file inside books_api directory and paste the secret key there.
books_api/secret_settings.py
SECRET_KEY = 'MY_SECRET_KEY'Run the following command to install Python dependencies for the app.
pip3 install -r requirements.txtRun the following command to create DB tables for your app.
python3 manage.py migrateLoad the books or reviews file using one of the appropriate commands below.
python3 manage.py load-books --path PATH_TO_BOOKS_FILE
python3 manage.py load-reviews --path PATH_TO_REVIEWS_FILEStart the app server using the following command
python3 manage.py runserverGo to http://localhost:8000 (or different address/port as per your configuration) and review the list of books added in the database and their reviews. Use "Filters" button to search for books (enter book title to find a book) or go to http://localhost:8000/books/?search= and enter the book title in the search parameter value.