🖼️ Py Bg Changer

Simple cross-platform wallpaper changer made with Python. Change your desktop wallpaper from the terminal, Win+R or any launcher. Works on Windows, macOS and Linux, with no dependencies.

The command is py-bg-changer, and pbc is the short alias for it.

📥 Installation

you can install the latest version from PyPI with uv (recommended):

uv tool install py-bg-changer

or try it without installing:

uvx --from py-bg-changer pbc --help

prefer pip? pipx install py-bg-changer or pip install py-bg-changer work too. Needs Python 3.10+.

📖 Usage

pbc add night ~/Pictures/night.jpg   # save an image under a name
pbc add night img.jpg -a n -a dark   # ...and give it extra names (aliases)
pbc add night img.jpg --default      # ...or make it the default right away
pbc alias night moon                 # add more aliases later
pbc rename night midnight            # rename a wallpaper or an alias
pbc night                            # set it by name (or any alias: pbc n)
pbc ~/Pictures/any.png               # or set any image directly
pbc list                             # see what you saved (* marks the default); `pbc ls` works too
pbc default night                    # choose what a plain "pbc" sets
pbc remove night                     # forget a name (or just an alias)
pbc                                  # set the default wallpaper

If a saved name clashes with a command (say, one called list, ls or default), use pbc set list.

🛠 Getting Started

follow the instruction to install Py Bg Changer from source (to try the latest code or to work on it):

1. Clone Code

   use Git on your system

   git clone https://github.com/Mr-MRF-Dev/Py-Bg-Changer.git
   

   or use GitHub CLI

   gh repo clone Mr-MRF-Dev/Py-Bg-Changer
   

2. Change your directory.

   cd Py-Bg-Changer
   

3. Install it with uv

   uv tool install --editable .
   

   --editable means any change you make to the code is used right away. Leave it out for a normal install, or use pip install . if you prefer pip.

4. Check that it works

   pbc --version
   

Done :)

to remove it later: uv tool uninstall py-bg-changer (your saved wallpapers and config stay where they are).

💡 Tips

• Running pbc from Win+R opens a terminal that closes right away. Use pbcw (or py-bg-changer-w) instead: it takes the same arguments, opens no window, and shows a small message box only if something goes wrong.

  pbcw night
  

  it prints nothing on success, so use pbc in a terminal for list, default and the like.

• A wallpaper can have as many aliases as you like, and every alias works anywhere a name does (pbc n, pbc default n, pbc alias n moon). Removing an alias leaves the wallpaper alone; removing a wallpaper also removes its aliases. Renaming a wallpaper keeps its aliases, its image and its place as the default.

• When you save an image, py-bg-changer keeps its own copy next to the config file and gives that copy to the system. If you later move or delete the original, the wallpaper still works. The copy is removed when you remove the name (or replace its image), and your original file is never touched.

• Saved names live in a small JSON file, and the copied images in a wallpapers folder next to it. Run pbc path to see where, or set PBC_CONFIG to use a different file.

  {
    "wallpapers": {
      "night": "/home/me/.config/py-bg-changer/wallpapers/3e23e8160039594a.png"
    },
    "aliases": { "n": "night", "dark": "night" },
    "default": "night"
  }
  

🖥️ Supported Desktops

👨‍💻 Development

the project is managed with uv:

uv sync              # create the virtualenv and install everything
uv run pytest        # run the tests
uv run pbc --help    # run the CLI from source

🤝 Contributing

we welcome any contributions you may have. If you're interested in helping out, fork the repository and create an Issue and PR.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.