Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/deepjyoti30/QuickWall

Set latest wallpapers from Unsplash from the commandline
https://github.com/deepjyoti30/QuickWall

cli nitrogen terminal unsplash wallpaper wallpaper-setter

Last synced: 2 months ago
JSON representation

Set latest wallpapers from Unsplash from the commandline

Awesome Lists containing this project

README

        

QuickWall





How It Works   |   Installation   |   Requirements   |   Usage   |   TODO   |   Acknowledgements   


[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)


![Travis (.org)](https://img.shields.io/travis/deepjyoti30/QuickWall?style=for-the-badge) [![License](https://img.shields.io/badge/License-MIT-pink.svg?style=for-the-badge)](LICENSE) ![PyPI](https://img.shields.io/pypi/v/QuickWall?style=for-the-badge) ![PyPI - Downloads](https://img.shields.io/pypi/dm/QuickWall?style=for-the-badge) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-purple.svg?style=for-the-badge)](http://makeapullrequest.com)

## How It Works

It detects your DE or WM, gets wallpapers from **Unsplash** and sets them using either your choice of wallpaper setter or by **nitrogen**. Not enough? It can also change your theme based on the wallpapers that it gets, thanks to [pywal](https://github.com/dylanaraps/pywal).

## Installation

- It is available in Pypi

```sh
pip3 install QuickWall
```

- Available in AUR [here](https://aur.archlinux.org/packages/quickwall/)

```sh
yay -S quickwall
```

> **NOTE**: The directory is changed from `~/.QuickWall` to `~/.cache/QuickWall`. Early users can use `--migrate` option to move their data.

### OR

- Run the following command in the root directory to install QuickWall.

```sh
python setup.py install
```

> **NOTE**: If you get **permission denied** error, run the above command with sudo.

## Requirements

1. Python 3.6+
2. Currently supported wallpaper setters

- [nitrogen](https://github.com/l3ib/nitrogen)
- [feh](https://github.com/derf/feh)
- [kde](https://github.com/KDE/plasma-desktop)
- [xfce](https://www.xfce.org/)
- [gnome/unity](https://www.gnome.org/)

> **NOTE**: These dependencies in linux can be installed in other variants.
> For _arch linux_, you can use **pacman** package manager accordingly.

## Usage

```console
usage: quickwall [-h] [--version] [--clear-cache] [--setter SETTER] [-d] [-t]
[--remove-id ID] [--dir DIR] [--id ID] [--random]
[--search TERM] [--migrate] [--set-lockscreen]
[--level LEVEL] [--list-level]

QuickWall - Quickly set latest wallpapers from Unsplash directly from the
commandline.

options:
-h, --help show this help message and exit
--version show the program version number and exit
--clear-cache Clear the cache from the cache folder
(~/.cache/QuickWall)
--setter SETTER Wallpaper setter to be used. Currently supported ones:
nitrogen, feh, xfce, kde, gnome, unity (default: auto)
-d, --disable-blacklist
Disable adding the image to blacklisted ones.
-t, --disable-theme Disable setting a colorscheme extracted from the
wallpaper
--remove-id ID Remove the passed ID from the blacklist.
--dir DIR Directory to download the wallpapers
--id ID Get a photo by its ID.
--random Get random wallpapers.
--search TERM Show wallpapers based on the passed term
--migrate ONLY FOR EARLY USERS. Move the files from ~/.QuickWall
to ~/.cache/QuickWall.
--set-lockscreen Set lockscreen wallpaper (currently for KDE)

Logger:
--level LEVEL The level of the logger that will be used while
verbosing. Use `--list-level` to check available
options.
--list-level List all the available logger levels.

```

## TODO

- Add tests
- Add support for different wallpaper setters (raise an issue if you want me to support some particular one)
- Handle errors better
- ~~Add support for GNOME/Unity~~
- ~~Add support for XFCE~~
- ~~Add automatic detection of wallpaper setter depending on the OS. Fallback would be nitrogen.~~
- ~~Add support to restore wallpapers for KDE.~~
- ~~Add a logger~~
- ~~Add support to search~~

## Acknowledgements

- [Unsplash](https://unsplash.com) for their awesome API.
- [Pavel Borisov](https://github.com/pashazz) for [ksetpaper](https://github.com/pashazz/ksetwallpaper) code.