Results Scraper Flask App

This is a Flask web application designed to scrape student results from a specified results portal. The app allows users to input the result link, college code, field code, and year to fetch results and display them in a tabular format. Additionally, users can download the results as an Excel sheet.

Features

• Scrape and display student results in a tabular format
• Download the results table as an Excel sheet.

Prerequisites

Make sure you have the following installed:

• Python 3.x
• Flask
• Flask-WTF (for form handling)
• BeautifulSoup (for web scraping)
• Requests (for HTTP requests)
• pandas (for data manipulation)
• openpyxl (for Excel export)
• SheetJS (for Excel download in the frontend)

Installation

1. Clone the repository:

   git clone that-ar-guy/ou-scrapper
   cd ou-scrapper

2. Install the required dependencies:

   pip install -r requirements.txt

3. Run the Flask application:

   python app.py

4. Open your browser and go to:

   http://127.0.0.1:5000/
   

Usage

1. Enter the following details into the form:

   • Result Link: URL of the result page.
   • College Code: The college code for your institution.
   • Field Code: The field code corresponding to the results.
   • Year: The academic year of the results.

2. Click the Get Results button.

3. Once the results are displayed, you can download the results as an Excel file by clicking the Download as Excel Sheet button.

Contributing

We welcome contributions! If you'd like to contribute to this project, follow these steps:

1. Fork the Repository
   Click the "Fork" button on this repository to create your own copy.

2. Clone Your Fork
   Clone the repository to your local machine:
   git clone https://github.com/your-username/ou-scrapper.git cd ou-scrapper

3. Create a New Branch Create a branch for your feature or bug fix: git checkout -b feature-name

4. Make Changes & Commit

• Make your modifications or add new features.
• Ensure the code follows best practices and is properly formatted.
• Commit your changes with a descriptive message:

  git commit -m "Add feature: description of the feature"
  

5. Push Your Branch Push your branch to GitHub:

   git push origin feature-name
   

6. Submit a Pull Request

• Go to the original repository on GitHub.
• Click "New Pull Request" and select your branch.
• Provide a clear description of the changes you made.

Example

An example result link might look like: https://ou-scrapper.onrender.com/