Skip to content

A scrapper which displays random images from a subreddit of your choice inside your linux terminal.

License

Notifications You must be signed in to change notification settings

OBITORASU/terMEME

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

89 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

terMEME

A web scrapper which displays random images from a subreddit and category of your choice inside your Linux terminal.

terMEME is a terminal based web scraper written in Python 3 which allows Linux users to view random images from subreddits inside the comfort of their terminals.

NOTE: Best use suggestion is to browse memes (hence the name) but it works for any/all images. Also keep in mind not all terminals are support w3m-img (it is a hack) and might resort to displaying the image externally using imagemagick, some of the supported terminals are konsole, xterm, Gnome-terminal and terminals which are GPU accelerated like Alacritty.

Dependencies

  • w3m-img or imlib2
    • For image rendering inside the terminal.
  • imagemagick
    • If your terminal has trouble rendering the images, it will have the option to display the images externally.

Python Dependencies

All the python dependencies for this project are listed in the requirements.txt.

Installation

git clone https://github.com/OBITORASU/terMEME.git
cd terMEME
pip3 install -r requirements.txt

(Debian)
sudo apt-get install w3m-img
sudo apt-get install imagemagick

(Arch)
sudo pacman -S w3m imlib2 imagemagick

With the above done, you are ready to go. Fire up the script by running:

python3 termeme.py

Enjoy all the memes inside your terminal now!

Navigation

Use your q key to quit the w3m preview inside your terminal. On the user prompt pressing e will terminate the program, and any other button will be make the script continue to run. If your terminal is incapable of displaying the images inside it, it will switch you to an external view on imagemagick. In this case pressing, q for the first time will quit the imagemagick preview and then pressing it a second time will get you back to the user prompt by terminating the w3m prompt.

For Contributors

All the core functionalities of the script are present in the core directory in their respective files. termeme.py calls all the necessary functions from these files under core for its operation.

  • banner.py contains the banner of the script.
  • display.py contains the function responsible for displaying the image from their url inside your terminal.
  • fetch.py is responsible for fetching image url from targeted subreddits.
  • validate.py validates the authenticity of the subreddit requested by the user, that is if its a valid subreddit or otherwise.

NOTE:

In rare cases, validating the subreddit might result in false positives, if you are certain the entered subreddit exists just try again once or twice and it should work.


About

A scrapper which displays random images from a subreddit of your choice inside your linux terminal.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages