pxgamer / splas-runner
A cross-platform binary to change the desktop background from Unsplash.
                                    Fund package maintenance!
                                                                            
                                                                                                                                        owenvoke
                                                                                    
                                                                            
                                                                                                                                        ecologi.com/owenvoke?gift-trees
                                                                                    
                                                                
Installs: 28
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 1
Open Issues: 1
pkg:composer/pxgamer/splas-runner
Requires
- php: ^7.1
- ext-curl: *
- guzzlehttp/guzzle: ^6.3
- pxgamer/splas-php: ^4.0
- symfony/console: ^4.0
- webmozart/path-util: ^2.3
Requires (Dev)
- humbug/box: 3.2
- phpunit/phpunit: ^7.0
- squizlabs/php_codesniffer: ^3.0
README
A cross-platform binary to change the desktop background from Unsplash.
This package uses the splas-php composer package.
Install
Via Composer
$ composer global require pxgamer/splas-runner
Via Phive
$ phive install pxgamer/splas-runner
Usage
- Get an API key from Unsplash
- Either set the UNSPLASH_API_KEYenvironment variable, or provide a--key {key}option in the command
- Run the binary using splasr [options]
Options
| Name | Description | 
|---|---|
| --keep / -k | Specify whether to keep or remove images. Defaults to remove any images before downloading. | 
| --key | Specify your API key. Defaults to use the environment variable. | 
| --interval / -i | Specify an integer (minutes) when running in looped mode. By default will exit after the first run. | 
Supported operating systems
| OS | Supported? | 
|---|---|
| Windows | ✓ | 
| Mac OSX | ✗ | 
| Ubuntu | ✓ | 
| Linux | ✗ | 
Note: Running in an unsupported OS will result in an ErrorException.
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
$ composer test
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email owzie123@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.