Giter Club home page Giter Club logo

news-at-command-line's Introduction

News at the Command line

Want to be kept updated without visiting the news portals every now and then

Now you don't need to visit each news portal website separately to read their articles. Just use the tool and read the articles without even clicking a single mouse button.

Modules Requirements

  • Python 3.6+
  • Requests
  • Beautiful Soup
  • PyYAML

Installation

  1. git clone the repository, preferably into a virtual environment.
  2. Copy config.yml into your home directory.
  3. Run with newsctl

At present config.yml is only read from pwd when the script is run, I'll fix this soon.

Working

  • All sample input images are placed under the Images folder.
  • You can change the maximum number of posts in config.yml. Look for Limit attribute.

How To Use

Make sure you have installed required libraries, instructions above. Just run the main.py, do this by typing py main.py. The rest is quite straight forward.

Contributing

We welcome your contributions. Please feel free to fork the code, play with it, make some patches and send us pull requests.

Support

Please open an issue on GitHub if you'd like to report a bug or request a feature.

License

The code is released under MIT license and free to use.

news-at-command-line's People

Contributors

aarohgala avatar ctrlsam avatar dmkronenberg avatar griffintaur avatar gtseres avatar prateekkalra avatar tomfaulkner avatar violiza avatar wflores96 avatar yblank1 avatar

Watchers

avatar avatar

news-at-command-line's Issues

Config and Plugins

Move readers to a plugin system
Move config to appropriate directories

TODO

  • Move all files to proper locations (./news)
  • Move to plugins for news sources #6
  • Read config.yml from a default location #6, or ENV variable location
  • Get rid of "websites_supported" in favor of using the classes #6
  • Finish PEP8ing
  • Test all the things
  • Update README (further updates)
  • Read from environment variables + config + command line args
  • Edit configuration in program
  • Move all prompts to string constants file for easy changes and translations
  • Dependency inject BeautifulSoup in extractor

Someday maybe:

  • Consider REST client / server architecture

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.