Metadata-Version: 2.1
Name: backgroundchanger
Version: 1.2.0
Summary: background changer using unsplash API.
Home-page: https://github.com/rugglcon/python-backgroundchanger
Author: Connor Ruggles
Author-email: conruggles@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# Background Changer
A small program in Python 3 that grabs a random photo from [Unsplash](https://unsplash.com) according to your screen resolution and sets it as your background.

## Further testing

This hasn't yet been tested on Windows or Mac ([being worked on](https://github.com/rugglcon/python-backgroundchanger/issues/1)), but it works for Ubuntu Linux. Any commands I might have gotten wrong to set it as your background, please feel free to fix those or add more!

## Dependencies
This is pretty light on dependencies, but you will need to make sure you have a couple things:

* `tkinter` - a python GUI toolkit, but is only used to get the screen resolution. This is usually installed via a system package.
* `requests` - python module for HTTP requests.
* `pywal` - generates color schemes and used for changing the wallpaper.

## How to contribute?

For issue and PR guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).

### Environment setup

**NOTE:** For Mac, first test if you have `tkinter` directly installed with your Python version first:
```sh
python3
>>> import tkinter
```
If that doesn't cause an error, you're good. If it does, follow [this](https://stackoverflow.com/a/60469203/9565946) Stack Overflow
to get that correctly set up. Then you can continue with the rest of the steps.

1. Create a virtual environment and install the dependencies
```sh
### using venv
python -m venv ./venv

source ./venv/bin/activate
###


### using pyenv virtualenv
pyenv virtualenv 3.8.2 backgroundchanger

pyenv local backgroundchanger
###

# install dev requirements
pip install -r requirements-dev.txt -r requirements.txt
```

2. Build the project and install locally
```sh
python setup.py bdist_wheel

pip install -e
```

3. Run the project
```sh
backgroundchanger
```

### Running tests
```sh
pytest tests
```

