Giter Club home page Giter Club logo

news-bulletin's Introduction

news-bulletin

news-bulletin is a Python script that allows you to quickly access short news headlines and summaries directly from your command line interface (CLI). It fetches the latest news from various sources and presents them in a concise format, making it convenient for users to stay updated with the latest news without leaving the terminal.

Features

  • Fetches short news headlines and summaries from multiple sources.
  • Supports customization of news sources and categories.
  • Provides direct links to read full articles for each news item.

Prerequisites

  • Python 3.6 or above installed on your system.
  • An internet connection to fetch the latest news data.

Getting Started

  1. Clone the repository to your local machine:

    git clone https://github.com/Saif-Shines/news-bulletin.git
  2. Install the required dependencies using pip:

    pip install -r requirements.txt
  3. Run the script to start fetching news:

    python app.py

Usage

  • Run the script with the command shown above to fetch and display the latest news.
  • Use the arrow keys to navigate through the news items.
  • Press Enter to open the full article in your default browser.
  • Use the options and commands provided in the CLI menu to customize news sources and categories.

.env

NEWS_API_KEY="api-key"
# from https://newsapi.org/docs/endpoints/everything
python3 app.py "Your Query"

Configuration

The script uses a configuration file (config.json) to manage news sources and categories. By default, it includes popular news sources and general news categories. You can modify this file to customize the sources and categories according to your preferences.

Contributing

Contributions to news-bulletin are welcome! If you find any issues, have suggestions for improvements, or want to add new features, feel free to open an issue or submit a pull request. Please make sure to follow the code of conduct in all interactions.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license.

Acknowledgements

The script uses the NewsAPI service to fetch news data. Special thanks to the developers and contributors of the NewsAPI project.

news-bulletin's People

Contributors

saif-shines avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.