qasim-11 / gdsc-iau

Table of Contents

• Overview
• Learning Objectives
• Resources
  • Online Resources
    • Github
    • Python
• Setup and Tutorial
• Project Overview
  • Requirements
  • Submission Guidelines

Overview

In this project, you will be creating a Sentiment Analyzer program using reviews from the given data in this repository. You will be using Python to analyze the data and Jupyter Notebooks to present your findings.

Learning Objectives

• Learn how to use Git and Github.
• Learn how to use Python to analyze data.
• Learn how to use Jupyter Notebooks.

Resources

Online Resources

Github

• Git and Github
• Git Tutorial (w3schools.com)
• How to Use Git and GitHub – Introduction for Beginners (freecodecamp.org)
• Learn Git Branching (Interactive tutorial)
• Git - Basic Branching and Merging (git-scm.com)
• Pull Requests in VS Code - YouTube

Python

• Python Tutorial (w3schools.com)
• Python Video
• Python for Beginners (freecodecamp.org)
• Provided Tutorial

Setup and Tutorial

1. Setup

1.1. Install Git (Windows Users Only)

• Download Git

1.2. Install Python

1.2.1. Windows (Using Chocolaty)

• Open powershell as an administrator.

  

• Run the following command to install Chocolaty:

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

• Run the following command to install Python:

choco install python

• Check if Python is installed properly by running the following command:

python --version

1.2.2. MacOS (Using Homebrew)

By default, python is already installed in macOS systems. However, if you want to use the latest version of python, you can install it using Homebrew.

• Open the terminal.
• Run the following command to install Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

• Run the following command to install Flutter:

brew install python

• Check if Python is installed properly by running the following command:

python3.X --version

where X is the version of python you installed.

1.3. Install VS Code

• Download VS Code

1.4 Fork the repository

• Fork the repository by clicking the fork button on the top right corner of the repository page.

  • Click the fork Button

  

  • Name the repo and click "Create fork"

  • You should now have a copy of the repository on your own account.

Tutorial

2.1. Git

2.1.1. Clone the repository

• Open the terminal and navigate to the directory (also known as folder) where you want to clone the repository.
  • Make sure the path you choose has NO ARABIC LETTERS. This will cause errors.
    • On Mac:
    • On Windows:
• Go to the repository page on your own account and click on the green code button.
• Copy the link under the clone section.
• Run the following command inside of the opened terminal to clone the repository:

git clone <The Link from your Repository>

Example:

git clone https://github.com/YOUR_NAME/Selection-Project.git

2.1.2. Add changes

• Open the repository directory in VS Code.

  • The path must be INSIDE the cloned repository.
  • Click on File -> Open folder
  • Select the repository folder.
  • The repository should be opened in VS Code.
  • To make sure, run the following command in the terminal INSIDE Vscode:

  git status

  • The output should be similar to the following:

---

You are now ready to code! Make the required changes which are given in section Project Overview and then follow the steps below to push your changes to Github. Make sure to regularly commit your changes

---

• Run the following command to add the changes:

git add .

2.1.3. Commit changes

• Run the following command to commit the changes:

git commit -m "<commit-message>"

2.1.4. Push changes

• Run the following command to push the changes:

git push

2.1.5. Create a pull request

• Go to the repository page and click on the pull request button.
• Click on the new pull request button.
• Select the branch you want to merge into the main branch.
• Click on the create pull request button.
• Add a title and description for the pull request. Title should be in the following format: <your-name> - <project-name>.
• Click on the create pull request button.

Project Overview

Your task is to create a Sentiment Analyzer program using reviews from the given data in this repository

An example of a sentiment analyzer can be found here.

Requirements

The notebook should contain the following:

• A description of the project.
• A description of the dataset used.
• A description of the methods used to analyze the data.
• A description of the results.

Some libraries that you might find useful:

• Pandas
• TextBlob

Submission Guidelines

• The app should be pushed to Github and a pull request should be created. You can check how to push your code to Github in section 2.1.2 Add Changes
• The pull request title should be in the following format: <your-name> - <project-name>. You can check how to make a pull request in section 2.1.5. Create a pull request.
• The pull request description should contain the following:
  • A description of the changes made.
  • A screenshot of the app running in the terminal.