newsreader-cli

📖 Description

A simple CLI app to read articles from Vnexpress - ranking the most popular Vietnamese online newspaper.

🎯 Why this app?

• First thing first, a great chance to brush up my programming skills in general and my Python in specific.
• I really want to read news in a cooler way. Who needs a smart phone/web browser? Now I can legitly read news during class on Terminal and people will think that I am hacking 🧑‍💻.

⚙️ Tech Stack

• Programming Language: Python 🐍
• 📜 Libs:
  • Web Scraper: BeautifulSoup 4
  • Testing: PyTest
• 📦: Continuous Integration: Travis

❓ How to run the application ?

Before starting, ensure that Python >= 3 has been installed on your system.

1. Clone the repository

$ git clone https://github.com/meobilivang/newsreader-cli

2. Navigate to application's directory

$ cd <path>/newsreader-cli

3. Install packages via pip

Use virtual environment if you prefer

$ pip install -r requirements.txt

4. Run application!

$ python -m newsreadercli main

📁 What to do next ?

• Add specific/advanced test cases
• Code refactor + reformatting (Pardon me for my hideous code 🥺)
• Add comments