Movie Listing API

This project is a Movie Listing API built with FastAPI. The API allows users to list movies, view listed movies, rate them, and add comments. The application is secured using JWT (JSON Web Tokens), ensuring that only the user who listed a movie can edit or delete it. The application is also deployed on a cloud platform(Render), making it accessible publicly.

Features

User Authentication:

User Registration:

• Users can register by providing a username and password.

User Login:

• Registered users can log in to receive a JWT token.
• JWT Token Generation: After logging in, users receive a JWT token for authentication.

Movie Listing:

• View a Movie: Anyone can view details of a listed movie.

Add a Movie:

• Authenticated users can add new movies.

View All Movies:

• Anyone can view the list of all movies.

Edit a Movie:

• Only the user who listed the movie can edit its details.

Delete a Movie:

• Only the user who listed the movie can delete it.

Movie Rating:

Rate a Movie:

• Authenticated users can rate movies.

Get Ratings for a Movie:

• Anyone can view ratings for a movie.

Comments:

Add a Comment:

• Authenticated users can add comments to movies.

View Comments:

• Anyone can view comments for a movie.

Add Nested Comments:

• Authenticated users can reply to existing comments, creating nested comments.

Technologies Used

Language & Framework:

• Python with FastAPI

Authentication:

• JWT for securing endpoints

Database:

• SQLAlchemy ORM with support for SQL databases

Testing:

• Unit tests for API endpoints using pytest

Documentation:

• OpenAPI/Swagger for API documentation

Logging:

• Integrated logging for important application details using PaperTrail logging

Deployment:

• Deployed on Render

Setup and Installation

Prerequisites

• Python 3.7+
• An SQL database (PostgreSQL, MySQL, SQLite, etc.)
• Git (for version control)

Installation

1. Clone the Repository:

git clone https://github.com/yourusername/movie_listing_api.git

cd movie_listing_api

2. Create and Activate a Virtual Environment:

python -m venv environment_name
source environment_name/bin/activate 

3. Install Dependencies:

pip install -r requirements.txt

4. Set Up Database:

alembic upgrade head

5. Run the Application:

uvicorn app.main:app --reload

6. Access the API Documentation:

• Visit http://127.0.0.1:8000/docs to explore the API with Swagger UI.

Running Tests

To run unit tests, use the following command:

pytest

Security

• JWT tokens are used to secure endpoints.
• Only authenticated users can perform operations like adding, editing, or deleting movies and comments.
• Ensure you change the SECRET_KEY in production to a strong, unique value.