A simple tool to get quick summaries of online articles. It uses typer to make commands easy and newspaper3k to grab and shorten articles, so you can understand the main points fast.
- Swift Summaries: Get to the heart of articles in mere seconds.
- NLP-Powered: Leverages advanced Natural Language Processing algorithms.
- Simple CLI Interface: Easy-to-use, perfect for both beginners and advanced users.
- Clone the repository and
cdto project directory
$ git clone https://github.com/coderustle/peakread && cd peakread- Create and activate a virtual environment
$ python3 -m venv .venv && source .venv/bin/activate- Install the required packages
$ pip install -r requirements.txt- Install locally
$ pip install -e .The following libraries are needed to be installed.
- PIL: libjpeg-dev zlib1g-dev libpng12-dev
- lxml: libxml2-dev libxslt-dev
- Python Development version: python-dev
Debian/Ubuntu
# Needed by lxml
$ sudo apt-get install libxml2-dev libxslt-dev
# needed by PIL
$ sudo apt-get install libjpeg-dev zlib1g-dev libpng12-devOSX
$ brew install libxml2 libxslt
$ brew install libtiff libjpeg webp little-cms2# download the NLTK models and corpora
$ peak init
# read and summarize an article
$ peak read url