Redwall - The front wallpaper to your monitor(s)

Redwall is a command-line tool that helps you build a collection of curated images obtained from Reddit submissions.

 ______________________________________________________________________________________________
/ Title        Mudurnu, Turkey: 587 castle homes after the developer went bankrupt. [1903x775] \
| Author       u/nlx78                                                                         |
| Date         2019-01-18 17:55:14                                                             |
| Post URL     https://reddit.com/r/AbandonedPorn/comments/ahcfxq/                             |
| Image URL    https://i.imgur.com/Um4hcXr.jpg                                                 |
| Image size   2500 x 1667                                                                     |
\ Filename     /home/dystopia/redwall/data/AbandonedPorn/ahcfxq-Um4hcXr.jpg                    /
 ----------------------------------------------------------------------------------------------
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||

Configuration

Redwall relies on PRAW to get content from Reddit, so you should obtain the proper credentials, see:

• Reddit application preferences
• Authenticating via OAuth

Once you have registered an application, create a configuration file that should be located at ~/.config/redwall.ini:

[reddit]
user_agent    = Comment Extraction (by /u/dystopiaGnostalgic)
client_id     = s0m3cli  # Reddit OAuth client ID
client_secret = s3rk3t   # Reddit OAuth client secret

[redwall]
data_dir         = /home/dystopia/redwall/data
submission_limit = 20
time_filter      = month
subreddits =
    Castles
    CozyPlaces
    gardening
    ImaginaryLibraries
    oldmaps

This file defines authentication information, as well as which subreddits should be browsed when gathering submitted images.

Take a look at the following threads to find more interesting content ;-)

• List of Art subreddits
• What are the best photo-based subreddits?
• A list of all photography related subreddits?

Installation

To install the latest version of Redwall in a virtualenv:

$ virtualenv ~/.virtualenvs/redwall
$ source ~/.virtualenvs/redwall/bin/activate
$ pip install git+https://github.com/virtualtam/redwall.git

Usage

The command-line interface is still pretty much a work in progress and is bound to change a bit, so the recommended way is to rely on the built-in help:

$ redwall -h

usage: redwall [-h] [-c CONFIG]
               {current,gather,history,info,list-candidates,random,search,stats,version}
               ...

Redwall helps you manage a collection of curated wallpapers, courtesy of the
Reddit community.

positional arguments:
  {current,gather,history,info,list-candidates,random,search,stats,version}
                        Command to run
    current             Display information about the currently selected entry
    gather              Gather submission media from Reddit
    history             Display the history of selected entries
    info                Display information about a given submission
    list-candidates     List submissions suitable for the current monitor
                        setup
    random              Select a random submission suitable for the current
                        monitor setup and print its path
    search              Search for entries by title
    stats               Display statistics about gathered submissions
    version             Display the program version

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG, --config CONFIG
                        Configuration file

~ The front wallpaper of your computer ~

Libraries

• Pillow, the Python Imaging Library
• PRAW, the Python Reddit API Wrapper
• Screeninfo
• SQLAlchemy, the Python SQL Toolkit and Object Relational Mapper

License

Redwall is licenced under the MIT License.