Skip to content

Commit b8ddc01

Browse files
utkarshbajajutkarshbajaj
committed
Updating readme
1 parent eb62fdc commit b8ddc01

4 files changed

Lines changed: 24 additions & 4 deletions

File tree

‎projects/Find_imdb_rating/README.md‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,22 @@
11
# Find IMDB Ratings
22
<!--Remove the below lines and add yours -->
3-
A short description about the script must be mentioned here.
3+
This script is used to fetch the Ratings and Genre of the films in your films folder, the data is scraped from IMDB's official website and store in a csv file. The csv file can be used for analysis then, sorting acc to rating etc.
4+
5+
Input: -> Path of the directory which contains the films.
6+
7+
Output: -> A new csv file is made - 'film_ratings.csv' which contains the ratings for the films in your directory.
48

59
### Prerequisites
610
<!--Remove the below lines and add yours -->
7-
Modules required to be able to use the script successfully and how to install them. (Including a requirements.txt file will work.)
11+
This program uses and external dependency of 'BeautifulSoup' (for web scraping), 'requests' (for fetching content of the webpage), 'pandas' (to make csv), 'os' (to get data from directory).
12+
These libraries can be installed easily by using the following command: pip install -r requirements.txt
813

914
### How to run the script
1015
<!--Remove the below lines and add yours -->
11-
Steps on how to run the script along with suitable examples.
16+
-> Install the requirements.
17+
-> Inside the find_IMDb_rating.py, update the directory path.
18+
-> Type the following command: python find_IMDb_rating.py
19+
-> A csv file with rating will be created in the same directory as the python file.
1220

1321
### Screenshot/GIF showing the sample use of the script
1422
<!--Remove the below lines and add yours -->

projects/Find_imdb_rating/products.csv renamed to projects/Find_imdb_rating/film_ratings.csv

File renamed without changes.

‎projects/Find_imdb_rating/find_IMDb_rating.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@
7676
df = pd.DataFrame({'Film Name':names,'Rating':ratings,'Genre':genres})
7777

7878
#making csv using pandas
79-
df.to_csv('products.csv', index=False, encoding='utf-8')
79+
df.to_csv('film_ratings.csv', index=False, encoding='utf-8')

‎projects/Find_imdb_rating/requirements.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
beautifulsoup4==4.9.1
2+
bs4==0.0.1
3+
certifi==2020.6.20
4+
chardet==3.0.4
5+
idna==2.10
6+
pandas==1.1.2
7+
python-dateutil==2.8.1
8+
pytz==2020.1
9+
requests==2.24.0
10+
six==1.15.0
11+
soupsieve==2.0.1
12+
urllib3==1.25.10

0 commit comments

Comments
 (0)