Metadata-Version: 2.1
Name: wcd
Version: 0.0.0a4
Summary: A daemon which manages your desktop wallpapers. Sort of the 'mpd' of wallpapers.
Home-page: http://github.com/brunofauth/wcd
Author: Bruno Fauth
Author-email: bvfauth@hotmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/brunofauth/wcd/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE

# Wallpaper Changing Daemon (wcd)
Wallpaper Changing Daemon reminds me of mpd, but it manages wallpapers instead of music.

# Overview
* It comes with wcc too, which is a CLI client app, used to interact with the Daemon.
* It works on python 3.9 (and, probably, on 3.7 and 3.8 too, not sure about lower versions though).
* It only depends on `PyYAML` and `coloredlogs`, but you don't have to worry about installing them manually, pip's got you covered.
* It copies it's default config file into `~/.config/wcd/`, or to wherever you point it to, via `$WCD_CFG`.
* I only code as a hobby, but I'd say I made a good job to make this very readable and, thus, feel very welcomed to check how things are implemented, to get a better understanding of what this program does, its capabilities, etc...
* You need to have a program which will do the wallpaper switching (such as `xwallpaper`, `feh` or `nitrogen`) installed on your machine.

# Installation
1. Install the package: either `pip install wcd` or clone this repo and run `setup.py`
2. Run the package once, to generate config files. If you wan't, you can point to where you want your config to be stored in by exporting an evironment variable named `WCD_CFG`, like this:
    * `export WCD_CFG="path/to/config" # be sure to add this line to your ~/.profile or ~/.bashrc or whatever shell you use`
    * `python -m wcd`
3. Load the config file (defaults to `~/.config/wcd/cfg.yml`) on your text editor and change the `wallpaper_cmd` entry to whatever suits you best.
4. Kill the previous running instance if you haven't already and, then, restart the program.
5. You're all set, enjoy.

## Installing and Running as systemd Service
1. Clone this repo: `git clone https://github.com/brunofauth/wcd.git`
2. cd into it: `cd wcd`
3. Copy the unit file to your systemd config folder: `cp wcd.service ~/.config/systemd/user/wcd.service`
4. To enable starting wcd on login, run: `systemctl enable --user wcd.service`
5. To immediatly start wcd, run: `systemctl start --user wcd.service`

# Communicating with the wcd
`python -m wcd.wcc --help`

# sxhkd keybindings for wcc (append to your sxhkdrc)
    shift + XF86Audio{Play,Next,Prev}
        python -m wcd.wcc {toggle_cycle,next,prev}



