Merge pull request #59 from adipai/readme_branch2

Readme branch2

CODE_OF_CONDUCT.md

@@ -51,7 +51,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at [email protected]. All
+reported by contacting the project team at [email protected]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 ## Contributing:
 
-* If you would like to contribute and collaborate for this repository, then please intimate us through email at [email protected]
+* If you would like to contribute and collaborate for this repository, then please intimate us through email at [email protected].
 
 ## Purpose of Contributing:
 
@@ -14,33 +14,27 @@
 
 ## Style checkers standards:
 * Use the `pylance` package for python (VS code), and use `black` for auto-styling and auto-formatting the code.
+* Use 'pylint' for proper coding standards
 
 
 ## Code of Conduct:
 
-* Please go through the [Code of Conduct](https://github.com/git-ankit/MovieRecommender/blob/master/CODE_OF_CONDUCT.md) before you begin contributing.
+* Please go through the [Code of Conduct](https://github.com/adipai/PopcornPicks/blob/master/CODE_OF_CONDUCT.md) before you begin contributing.
 
 ## Pull Request Submission Guidelines
 
 * Installing Git makes contributing to the repository easier
 * To start contributing to the repository make sure you fork the repository first
 * Create a new branch to develop the project 
 * Write code to contribute and commit to create a pull request and merge it with the repository after it passes the CI build check
-* One of the repository administrators will review the Pull request anmd merge the changes
+* One of the repository administrators will review the Pull request and merge the changes
 
 ## Code Style Guide 
 
-* Python language(Version 3.7) has been used to build this project repository
+* Python language(Version 3.x) has been used to build this project repository
 * Make sure to add the functionalities in the form of modules
 * Any code which is not tested should be committed to the test codes in the code folder. After they are successfully tested, the  main code can be updated.
 * Variable Names should be self-explanatory
 * Comment the code so that a new contributor can understand the functionality of the modules easily
 * `black` is used as linter
-
-
-
-
-
-
-
-
+* 'Pylint' used for proper coding standards

README.md

@@ -22,9 +22,9 @@
 ## Why use PopcornPicks?
 
 <img
-  src="https://github.com/adipai/PopcornPicks/blob/master/asset/landing_page.png"
+  src="https://media.giphy.com/media/l1J9GIXk9w7OYsd5S/giphy.gif"
   alt="Starship with iTerm2 and the Snazzy theme"
-  width="50%"
+  width="40%"
   align="right"
 />
 
@@ -47,15 +47,15 @@ You can see the project presentation at - .
 PopcornPicks is a user-friendly movie recommender that curates a tailored list of 10 movie predictions based on user-provided movie preferences. Users can input their favorite movies, and our algorithm refines recommendations based on feedback—Liked, Disliked, or Yet To Watch. Additionally, PopcornPicks offers the convenience of emailing the recommended movies, enhancing the movie-watching experience. For the system architecture and other details, please refer to our [wiki-page](https://github.com/adipai/PopcornPicks/wiki)
 
 ## Project 2 Delta
-Checkout the significant changes that we made for Project 2 [here](https://github.com/adipai/PopcornPicks/wiki/Installation-and-setup)
+Checkout the significant changes that we made for Project 2 [here](https://github.com/adipai/PopcornPicks/wiki/The-Delta-(Project-2))
 
 ## Tech stack Used👨‍💻:
 
 <code><a href="https://developer.mozilla.org/en-US/docs/Glossary/HTML5" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_html5/w3_html5-ar21.svg"></a></code>
 <code><a href="https://developer.mozilla.org/en-US/docs/Web/CSS" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/w3_css/w3_css-ar21.svg"></a></code>
 <code><a href="https://www.python.org/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/python/python-horizontal.svg"></a></code>
 <code><a href="https://www.javascript.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/javascript/javascript-ar21.svg"></a></code>
-<code><a href="https://www.jquery.com//" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/jquery/jquery-horizontal.svg"></a></code>
+<code><a href="https://www.jquery.com//" target="_blank"><img height="40" src="https://www.vectorlogo.zone/logos/jquery/jquery-horizontal.svg"></a></code>
 <code><a href="https://flask.palletsprojects.com/en/1.1.x/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/pocoo_flask/pocoo_flask-ar21.svg"></a></code>
 <code><a href="https://github.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/github/github-ar21.svg"></a></code>
 <!-- <code><a href="https://git-scm.com/" target="_blank"><img height="50" src="https://www.vectorlogo.zone/logos/git-scm/git-scm-ar21.svg"></a></code>
@@ -110,4 +110,4 @@ PopcornPicks is more than just code; it's a passion for cinema, and we invite yo
 Let's make movie nights extraordinary together!
 
 ## License
-This project is under the MIT License.
+This project is under the MIT License.

setup.py

@@ -10,8 +10,8 @@
 It contains information about the project, including its name, version, authors,
 description, and other relevant details, to facilitate distribution and installation.
 
-For more information about the Movie Recommender project, visit:
-https://github.com/git-ankit/MovieRecommender
+For more information about the PopcornPicks project, visit:
+https://github.com/adipai/PopcornPicks
 """
 
 import setuptools
@@ -22,12 +22,12 @@
 setuptools.setup(
     name="git-ankit",  # Replace with your own username
     version="1.0.0",
-    author="Suraj,Amit,Jay,Ankit",
-    author_email="tiwariankit1006@gmail.com",
-    description="A recommendation engine",
+    author="Aditya, Ananya, Rishi, Samarth",
+    author_email="popcornpicks504@gmail.com",
+    description="A movie recommendation engine",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/git-ankit/MovieRecommender",
+    url="https://github.com/adipai/PopcornPicks",
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",