| Name | wcd JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | https://github.com/brunofauth/wcd |
| Summary | 'Wallpaper changing daemon' is exactly what its name suggests. It tries to be the 'mpd' of wallpapers. |
| upload_time | 2023-06-22 20:54:45 |
| maintainer | |
| docs_url | None |
| author | Bruno Fauth |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
wallpaper
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
## Why shouldn't I just use a shell script instead
Lots of people use shell scripts like this, to manage their wallpapers:
while true; do
for file in "$(find /usr/share/backgrounds/ -type f | shuf)"; do
xwallpaper --zoom "$file"
done
done
And that's fine, but I don't like that approach because it's too limiting. What if, actually, you don't like a wallpaper that has been presented to you? Well, then, you'd have to manually change it. With wcd and wcc, you can interact with the daemon as it presents wallpapers to you, going back and forward in a history buffer, choosing to start or to stop randomizing wallpapers, or just getting the next one presented to you if you don't like the current one anymore, all with a single keypress (see "sxhkd keybindings for wcc" below).
## Installation
1. Install the package with [pipx](https://github.com/pypa/pipx): `pipx install wcd` or clone this repo and run `setup.py`
* If you use Arch based distros, you can install pipx as such: `sudo pacman -S python-pipx`
2. Run the package once, to generate config files. If you want to, 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`
* `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. edit `wcd.service` to include whatever you get when you run `which wcd`
4. Copy the unit file to your systemd config folder: `cp wcd.service ~/.config/systemd/user/wcd.service`
5. To enable starting wcd on login, run: `systemctl enable --user wcd.service`
6. To immediatly start wcd, run: `systemctl start --user wcd.service`
## Communicating with the wcd
* Run: `wcc --help`, it stands for Wallpaper Changing Client and comes bundled with `wcd`
## sxhkd keybindings for wcc (append to your sxhkdrc)
shift + XF86Audio{Play,Next,Prev}
wcc {toggle_cycle,next,prev}
## TODO
* update pkgbuild to aur, along with the systemd service
* use less memory (tracemalloc says it's fine, but htop disagrees)
Raw data
{
"_id": null,
"home_page": "https://github.com/brunofauth/wcd",
"name": "wcd",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "wallpaper",
"author": "Bruno Fauth",
"author_email": "149593@upf.br",
"download_url": "https://files.pythonhosted.org/packages/15/0b/9d4f5d65a3facdd2a86e1a458c3f86a7c7a9d8b17bd9936c911e7e60f8b5/wcd-0.1.0.tar.gz",
"platform": null,
"description": "# Wallpaper Changing Daemon (wcd)\nWallpaper Changing Daemon reminds me of mpd, but it manages wallpapers instead of music.\n\n## Overview\n* It comes with wcc too, which is a CLI client app, used to interact with the Daemon.\n* It works on python 3.9 (and, probably, on 3.7 and 3.8 too, not sure about lower versions though).\n* It only depends on `PyYAML` and `coloredlogs`, but you don't have to worry about installing them manually, pip's got you covered.\n* It copies it's default config file into `~/.config/wcd/`, or to wherever you point it to, via `$WCD_CFG`.\n* 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...\n* You need to have a program which will do the wallpaper switching (such as `xwallpaper`, `feh` or `nitrogen`) installed on your machine.\n\n## Why shouldn't I just use a shell script instead\nLots of people use shell scripts like this, to manage their wallpapers:\n\n while true; do\n for file in \"$(find /usr/share/backgrounds/ -type f | shuf)\"; do\n xwallpaper --zoom \"$file\"\n done\n done\n\nAnd that's fine, but I don't like that approach because it's too limiting. What if, actually, you don't like a wallpaper that has been presented to you? Well, then, you'd have to manually change it. With wcd and wcc, you can interact with the daemon as it presents wallpapers to you, going back and forward in a history buffer, choosing to start or to stop randomizing wallpapers, or just getting the next one presented to you if you don't like the current one anymore, all with a single keypress (see \"sxhkd keybindings for wcc\" below).\n\n## Installation\n1. Install the package with [pipx](https://github.com/pypa/pipx): `pipx install wcd` or clone this repo and run `setup.py`\n * If you use Arch based distros, you can install pipx as such: `sudo pacman -S python-pipx`\n2. Run the package once, to generate config files. If you want to, you can point to where you want your config to be stored in by exporting an evironment variable named `WCD_CFG`, like this:\n * `export WCD_CFG=\"path/to/config\" # be sure to add this line to your ~/.profile or ~/.bashrc or whatever shell you use`\n * `wcd`\n3. 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.\n4. Kill the previous running instance if you haven't already and, then, restart the program.\n5. You're all set, enjoy.\n\n### Installing and Running as systemd Service\n1. Clone this repo: `git clone https://github.com/brunofauth/wcd.git`\n2. cd into it: `cd wcd`\n3. edit `wcd.service` to include whatever you get when you run `which wcd`\n4. Copy the unit file to your systemd config folder: `cp wcd.service ~/.config/systemd/user/wcd.service`\n5. To enable starting wcd on login, run: `systemctl enable --user wcd.service`\n6. To immediatly start wcd, run: `systemctl start --user wcd.service`\n\n## Communicating with the wcd\n* Run: `wcc --help`, it stands for Wallpaper Changing Client and comes bundled with `wcd`\n\n## sxhkd keybindings for wcc (append to your sxhkdrc)\n shift + XF86Audio{Play,Next,Prev}\n wcc {toggle_cycle,next,prev}\n\n## TODO\n* update pkgbuild to aur, along with the systemd service\n* use less memory (tracemalloc says it's fine, but htop disagrees)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "'Wallpaper changing daemon' is exactly what its name suggests. It tries to be the 'mpd' of wallpapers.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/brunofauth/wcd/issues",
"Homepage": "https://github.com/brunofauth/wcd",
"Repository": "https://github.com/brunofauth/wcd"
},
"split_keywords": [
"wallpaper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "53a6bcbec4fd97b11c91bf79cc2e717e0e17ab720971bd67a01c7769a6200b49",
"md5": "c4580f7cef20e3b68a4de7495a862ffe",
"sha256": "16c930de2ba7a154d2b00944633d037a606b7252a8764211f2d5d640146528c7"
},
"downloads": -1,
"filename": "wcd-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c4580f7cef20e3b68a4de7495a862ffe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 11258,
"upload_time": "2023-06-22T20:54:42",
"upload_time_iso_8601": "2023-06-22T20:54:42.555141Z",
"url": "https://files.pythonhosted.org/packages/53/a6/bcbec4fd97b11c91bf79cc2e717e0e17ab720971bd67a01c7769a6200b49/wcd-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "150b9d4f5d65a3facdd2a86e1a458c3f86a7c7a9d8b17bd9936c911e7e60f8b5",
"md5": "cec782686cb473af55c6b6e4603ad27a",
"sha256": "d1bd15385ce2edec89bce71f378a8adbaf1f462ad5ba08fb0f74b1c3e525a4de"
},
"downloads": -1,
"filename": "wcd-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "cec782686cb473af55c6b6e4603ad27a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 10301,
"upload_time": "2023-06-22T20:54:45",
"upload_time_iso_8601": "2023-06-22T20:54:45.913256Z",
"url": "https://files.pythonhosted.org/packages/15/0b/9d4f5d65a3facdd2a86e1a458c3f86a7c7a9d8b17bd9936c911e7e60f8b5/wcd-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-22 20:54:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brunofauth",
"github_project": "wcd",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wcd"
}
