README.md

News Crunch

An app to scrape data from news websites and display the articles in web GUI.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites & Installation
3. Usage
4. To Do
5. Contributing
6. Contact
7. Acknowledgments

About The Project

This is an app that scrapes news article details such as title, date, auther etc. from different news websites, processes the data and shows on a single page.

This app is inspired by inshorts

(back to top)

Built With

(back to top)

Getting Started

Prerequisites & Installation

Before starting, please make sure that following dependencies are installed on your machine

• Python
• pip

After the above dependecies are installed, follow below instructions:

• Clone the repo Clone the repo

  git clone https://github.com/NiravJoshi33/news_crunch.git

• Navigate to the project folder using CLI
• Install other dependecies with following command

  pip install -r requirements.txt
  

  Wait for the packages to be installed.

How to Use

Follow the below instructions to run the project

• Run following script

  main.py
  

• After the script has run, browser should open and display a GUI. In case, it doesn't open, open it manually and open following url

  http://localhost:8501
  

• By default, a side bar will load with the page. From there, you can deselect any website you don't want to see news from and use the slider to select the number of articles to show.

To Do

• Resolve Major Bugs with the current Basic Version
  • Run the app with the single script
  • OpenSSL Error occuring sometimes
  • Clean Data before showing in GUI
    • Dates from all websites in same format
  • Inconsistent card size due to different size of thumbs and excerpts
• Test app on macOS
• Data storage and access from an online database

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Nirav Joshi
Email - [email protected]
Project Link: https://github.com/NiravJoshi33/news_crunch

(back to top)

Acknowledgments

• Scrapy Course - Python Web Scraping for Beginners by freecodecamp.org
• Python Streamlit Full Course
• Best-README-Template by Othneil Drew
• Awesome community on stackoverflow
• ChatGPT by OpenAI for some Debugging

(back to top)